Clients overview

W6W ships four official clients. Every one of them talks to the same w6w API with the same token, so you can call your connected apps, Functions, Endpoints and Workflows from whichever stack your product already runs on. Use a client rather than raw HTTP: they handle authentication, path encoding and error mapping for you, and they all expose an escape hatch for any route they don’t wrap yet.

Which client to pick

The React package is built on the Node SDK: it adds a provider and hooks, and hands you the same SDK client for everything else. The CLI is built on the Node SDK too.

Install

npm install @w6w/sdk           # Node.js / TypeScript
deno add jsr:@w6w/sdk          # Deno, from JSR
npm install @w6w/react react   # React (pulls in @w6w/sdk)
npm install -g @w6w/cli        # the w6w command
pip install w6w                # Python

The Node SDK, React package and CLI need Node.js 18 or later. The Python package needs Python 3.9 or later and has no third-party dependencies.

Configure

Every client reads the same two environment variables:

export W6W_BASE_URL=https://<your-host>   # your API origin, no trailing path
export W6W_TOKEN=…                         # Studio → Settings → API tokens

An empty value counts as unset. If W6W_BASE_URL is missing, the client refuses to start. If W6W_TOKEN is missing, it refuses on the first call. Either way you get a configuration error that names the variable.

Every client also accepts the base URL and token as explicit arguments, which win over the environment. The React provider is the exception: a browser has no environment, so you always pass both as props.

Make your first call

Ask w6w who you are. This is the quickest way to prove the base URL and token are right.

w6w me

import { W6WClient } from "@w6w/sdk";

const client = new W6WClient(); // reads W6W_BASE_URL and W6W_TOKEN
const me = await client.me();
console.log(me.account, me.role);

from w6w import Client

client = Client()  # reads W6W_BASE_URL and W6W_TOKEN
me = client.me()
print(me.account, me.role)

import { useMe } from "@w6w/react";

function WhoAmI() {
  const { data, loading, error } = useMe();
  if (loading) return <p>Loading…</p>;
  if (error) return <p>Failed: {String(error)}</p>;
  return <p>{data?.account}</p>;
}

You should see your tenant, user, account and role. A 401 means the token is wrong or revoked. A network_error means the base URL doesn’t reach a w6w server.

What every client can do

The four clients cover the same operations, named in each language’s own style:

Each client also has a request method for routes that don’t have a wrapper yet. It uses the client’s own base URL and token, so you never hand-roll a second HTTP client.

Versions

All four clients release together at one shared version number. A given version means the same set of operations in every language, so @w6w/sdk, @w6w/react, @w6w/cli and w6w at the same version always agree. Below 1.0, a minor release may include breaking changes, so pin the version you test against.

These pages describe the 0.9 line. Check what you have installed:

npm ls @w6w/sdk                                # Node SDK (also shows @w6w/react's copy)
w6w --version                                  # CLI
python -c "import w6w; print(w6w.__version__)" # Python

Good to know: if a method on these pages is missing from your installed client, your version predates it. These arrived after 0.6.0: the workflow and Function definition operations (get, create, update, archive, delete, functions.list), workflows.cancel, the team operations, token suppliers with refreshOnUnauthorized and onUnauthorized, default headers, the backend token exchange, request cancellation with signal, and the React definition hooks.

Troubleshooting

Where to next

• Node SDK: install, authenticate, and run your first action from TypeScript.
• React: wrap your app in the provider and read data with hooks.
• CLI: the w6w command, for scripts and CI.
• Python: the same operations from Python.