Full CLI reference
Every command available in the whet CLI bundled with Whet Desktop. Each link leads to the detailed page.
Stack + clients
| Command | Description |
|---|---|
whet install | Fresh-laptop bootstrap. Provisions ~/.whet/, generates secrets, brings stack up, probes /health. Flags: --dest, --source-compose-path, --source-env-path, --skip-up, --skip-probe, --force-reset. |
whet init | One-shot MCP client wiring against a running deployment. Flags: --bearer-token, --backend-url, --mcp-url, --claude-code-scope, -y/--yes. |
whet install-skill | Reinstall the Claude Code skill markdown only. Flags: --dest, -f/--force. |
whet status | Probe local backend + whet-app + list OAuth credentials. Flags: --backend-base-url, --web-app-url, --api-key. |
whet doctor | Diagnostic across docker, env, containers, backend, web-app, OAuth credentials, and per-platform rate-limit headroom. Flags: --backend-base-url, --web-app-url, --api-key, --skip-rate-probe. |
Authentication
| Command | Description |
|---|---|
whet auth login | Save the agent token + base URL to ~/.whet/config.json. Flags: -t/--token (required), -u/--base-url. |
whet auth status | Show current config (token masked). Local-only read. |
whet auth connect <platform> | OAuth-link a platform account (PKCE flow, local callback on :11789). Flags: --backend-base-url, --api-key, --no-open, --timeout. The supported <platform> values depend on which adapters are installed. |
Pipelines and artifacts
| Command | Description |
|---|---|
whet pipelines new | Create a pipeline from intent. Flags: -s/--source (required: e.g. social, webpage), --handle, --url, --kind, --scope, --tone, --auto-fanout, --auto-publish. |
whet inbox <pipeline_id> | List pending + ready artifacts. Flag: -l/--limit. |
whet publish <artifact_id> | Mark an artifact as published. Flags: --final-text, --reason. |
Adapters and credentials
| Command | Description |
|---|---|
whet adapter install <source> | Install adapter from git URL (#<ref>), tarball URL (--sha256), or local path. Flags: --sha256, -y/--yes, -f/--force, --allow-mutable-ref, --offline. |
whet adapter list | List installed adapters. |
whet adapter remove <name> | Remove installed adapter. Credentials in the backend vault stay. |
whet credentials add <adapter> <name> | Store an encrypted credential. Pass --field key=value (repeatable) or --from-file <path>. Flags: --label, --field, --from-file, -y/--yes. |
whet credentials list | List adapter credentials for the current organization. Flag: --adapter. |
whet credentials remove <adapter> <name> | Hard-delete a credential. Flags: --label, -y/--yes. |
Detailed entries
whet install-skill
Install the Whet skill markdown at ~/.claude/skills/whet.md. Useful if you want the skill without running full init.
| Flag | Description |
|---|---|
--dest <path> | Override the destination path. |
-f, --force | Overwrite an existing file with different content. |
whet status
Probe the running deployment and print resolved bearer token state, backend health, and the list of OAuth credentials connected to the active organization.
| Flag | Description |
|---|---|
--backend-base-url <url> | Override BACKEND_BASE_URL. |
--web-app-url <url> | Override the web-app URL. Default http://localhost:3000. |
--api-key <key> | Backend Bearer key. Falls back to WHET_API_KEY. |
whet doctor
Run a full diagnostic. Checks the local Whet Desktop instance health, OS keychain accessibility, OAuth credentials, and platform API rate-limit headroom for each connected adapter (unless --skip-rate-probe).
| Flag | Description |
|---|---|
--backend-base-url <url> | Override BACKEND_BASE_URL. |
--web-app-url <url> | Override the web-app URL. |
--api-key <key> | Backend Bearer key. |
--skip-rate-probe | Skip the per-platform rate-limit probe (use when you've deliberately removed adapter credentials). |
Help
whet --help # list top-level commands
whet <command> --help # command detail + examples
whet --version # installed version
ID shape
| Resource | Prefix (observed in MCP/Agent API) |
|---|---|
| Pipeline | pp_<uuid> |
| Run | run_<uuid> |
| Riff (prose artifact) | rf_<uuid> |
| Brief (multi-source artifact) | bf_<uuid> |
| Ingested social post | sp_<id> |
| Webpage snapshot | ws_<uuid> |
| Agent token | 64-char hex string, no prefix (e.g. 7a3f4b2c…e2d8) |
IDs are opaque: do not parse them or assume a length. If you need to filter by type, use endpoints that already filter. "Artifact" is an umbrella term — concrete artifacts are riffs (single source) or briefs (multi-source) and each has its own prefix.
What does NOT exist (commonly searched)
- There is no
--no-confirmflag onpublish— the command has no interactive confirmation, it executes directly. - There is no
--jsonflag oninboxor other commands. Output is text rendered with Ink. - There are no
WHET_TOKEN/WHET_BASE_URLenv vars. The CLI only reads~/.whet/config.json. - There is no
whet pipelines pause/archive/updatecommand. Those operations live in the UI. - There is no direct refinement command. Use the MCP
refine_postprompt or the UI.