> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wednesdayai.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI reference

> Every wednesdayai CLI command, subcommand, key flags, and environment variables.

# CLI reference

The `wednesdayai` CLI is the primary interface for managing the gateway, channels, agents, models, and configuration. Install it globally via npm or pnpm - see [Getting started](https://docs.wednesdayai.dev/next/admin/getting-started.md).

The primary binary is `wednesdayai`; `openclaw` remains a permanent backward-compatible alias (both shims ship in the same package, so every command below works with either name).

```bash theme={"dark"}
wednesdayai --version            # show installed version (-V also works)
wednesdayai --help               # list all top-level commands
wednesdayai <command> --help     # help for a specific command
```

> [!NOTE]
>
> This page summarises the command surface. Flags evolve between releases - when a flag is not listed here, run `wednesdayai <command> --help` for the authoritative set on your install.

## Global flags

These apply to every command. Per-command flags such as `--json`, `--verbose`, and `--log-level` are documented under each command, not here.

| Flag | Effect |
| - | - |
| `--dev` | Isolate state under `~/.openclaw-dev` and shift default ports (gateway `19001`) |
| `--profile <name>` | Isolate state under `~/.openclaw-<name>` for a named instance |
| `--no-color` | Disable ANSI colours (`NO_COLOR=1` is also respected) |
| `--update` | Shorthand for `wednesdayai update` (source installs only) |
| `-V`, `--version`, `-v` | Print the version and exit |

## Output styling

* ANSI colours and progress indicators only render in TTY sessions.
* OSC-8 hyperlinks render as clickable links in supported terminals; otherwise we fall back to plain URLs.
* `--json` (and `--plain` where supported) disables styling for clean machine output.
* Long-running commands show an OSC 9;4 progress indicator where supported.

***

## Setup and onboarding

### `wednesdayai setup`

Initialise config and workspace. Auto-runs the onboarding wizard when any wizard flag is present.

```bash theme={"dark"}
wednesdayai setup --workspace ~/.openclaw/workspace
```

Key flags: `--workspace <dir>`, `--wizard`, `--non-interactive`, `--mode <local\|remote>`, `--remote-url <url>`, `--remote-token <token>`.

### `wednesdayai onboard`

Interactive wizard to set up gateway, workspace, model auth, channels, and skills.

```bash theme={"dark"}
wednesdayai onboard                         # full onboarding wizard
wednesdayai onboard --install-daemon        # also install the gateway service
wednesdayai onboard --flow quickstart       # quickstart | advanced | manual
```

Key flags: `--workspace <dir>`, `--reset`, `--reset-scope <config\|config+creds+sessions\|full>`, `--non-interactive`, `--mode <local\|remote>`, `--flow <quickstart\|advanced\|manual>`, `--auth-choice <id>`, `--gateway-port <port>`, `--gateway-bind <loopback\|lan\|tailnet\|auto\|custom>`, `--gateway-auth <token\|password>`, `--tailscale <off\|serve\|funnel>`, `--install-daemon` / `--no-install-daemon`, `--node-manager <npm\|pnpm\|bun>`, `--json`. Many provider-specific key flags exist (for example `--anthropic-api-key`, `--openai-api-key`) - see `wednesdayai onboard --help`.

### `wednesdayai configure`

Interactive configuration wizard (models, channels, skills, gateway). Re-runs onboarding-style prompts against an existing config. If the config file exists but fails validation, the wizard exits with an error - run `wednesdayai doctor` to repair it first.

With no flags, the wizard first asks where the gateway runs (local or remote), then loops a "Select sections to configure" menu until you exit. `configure` has no subcommands; sections are selected via a repeatable flag:

Key flags: `--section <section>` — run only the specified wizard section(s) — can be passed multiple times to run several sections in sequence (invalid values are rejected with the valid list). Sections run in a fixed order: workspace, model, web, gateway, channels, skills, then config is persisted, then daemon install and health checks run last.

| Section | Configures |
| - | - |
| `workspace` | Workspace directory + session settings |
| `model` | Provider selection + credentials |
| `web` | Web tools (Brave search + fetch) |
| `gateway` | Port, bind address, auth, Tailscale |
| `daemon` | Install/manage the background service |
| `channels` | Link WhatsApp/Telegram/etc and channel defaults |
| `skills` | Install/enable workspace skills |
| `health` | Run gateway + channel health checks |

### `wednesdayai completion`

Print a shell completion script for your shell.

```bash theme={"dark"}
wednesdayai completion
```

### `wednesdayai reset`

Reset local config/state while keeping the CLI installed.

```bash theme={"dark"}
wednesdayai reset --scope config+creds+sessions --yes
```

Key flags: `--scope <config\|config+creds+sessions\|full>`, `--yes`, `--non-interactive`, `--dry-run`. Non-interactive use requires both `--scope` and `--yes`.

### `wednesdayai uninstall`

Remove the gateway service and local data (the CLI itself remains).

```bash theme={"dark"}
wednesdayai uninstall --all --yes
```

Key flags: `--service`, `--state`, `--workspace`, `--app`, `--all`, `--yes`, `--non-interactive`, `--dry-run`.

### `wednesdayai update`

Update WednesdayAI to a newer version (source/npm installs).

```bash theme={"dark"}
wednesdayai update                  # update to latest on the current channel
wednesdayai update --dry-run        # preview without applying
wednesdayai update --channel beta   # stable | beta | dev
wednesdayai update --tag <version>  # install a specific version
wednesdayai update --no-restart     # skip gateway service restart after successful update (useful for automation)
wednesdayai update --yes            # non-interactive mode, accepts downgrade prompts
wednesdayai update --json           # output machine-readable UpdateRunResult JSON
wednesdayai update --timeout 600    # per-step timeout in seconds (default: 1200)
wednesdayai update status           # show current version, update channel, and whether an update is available
wednesdayai update wizard           # step-by-step wizard to configure update settings (channel, schedule, notifications)
```

***

## Gateway

### `wednesdayai gateway`

Run the WebSocket gateway in the foreground, or manage it as a system service. Subcommands cover the service lifecycle and RPC helpers.

```bash theme={"dark"}
wednesdayai gateway run                # run in foreground (Ctrl-C to stop)
wednesdayai gateway start              # start the installed service
wednesdayai gateway stop
wednesdayai gateway restart
wednesdayai gateway install            # install as systemd/launchd/schtasks service
wednesdayai gateway uninstall
wednesdayai gateway status             # probe the gateway RPC (default)
wednesdayai gateway status --deep --json
wednesdayai gateway usage-cost         # rolling usage/cost summary from session logs
wednesdayai gateway health             # health snapshot via RPC
wednesdayai gateway probe              # connectivity probe
wednesdayai gateway discover           # discover gateways on the network
wednesdayai gateway call <method> --params '<json>'   # invoke any RPC method
```

Foreground run flags: `--port <port>`, `--bind <loopback\|tailnet\|lan\|auto\|custom>`, `--token <token>`, `--auth <none\|token\|password\|trusted-proxy>`, `--password <password>`, `--tailscale <off\|serve\|funnel>`, `--tailscale-reset-on-exit` (reset Tailscale serve/funnel configuration on shutdown), `--allow-unconfigured`, `--force`, `--verbose`, `--ws-log <auto\|full\|compact>`, `--claude-cli-logs` (enable Claude CLI log output), `--raw-stream` (write raw stream to stdout), `--raw-stream-path <path>` (write raw stream to the specified file path).

RPC subcommands (`call`, `health`, `status`, `probe`, `discover`) accept `--url`, `--token`, `--password`, `--timeout`. `call`, `health`, and `usage-cost` also accept `--expect-final`.

`gateway status` additional flags: `--no-probe` (skip RPC probe, show service status only).

`gateway probe` additional flags: `--ssh <user@host[:port]>` (route probe through SSH tunnel), `--ssh-identity <path>` (SSH identity file path), `--ssh-auto` (auto-derive SSH target via Bonjour discovery).

`gateway usage-cost` — Fetch rolling usage/cost summary from session logs. Flags: `--days <days>` (number of days to include), `--url <url>`, `--token <token>`, `--json`, `--expect-final` (wait for a final response before returning).

> [!WARNING]
>
> When you pass `--url`, the CLI does **not** auto-apply config or environment credentials. Include `--token` or `--password` explicitly; missing credentials is an error.

The gateway runs on port `18789` by default. Common RPC methods for `gateway call`: `config.apply`, `config.patch`, `update.run`. See the [API reference](https://docs.wednesdayai.dev/next/reference/api.md) for the full method surface.

**Systemd (Linux):**

```bash theme={"dark"}
systemctl --user start|stop|restart|status openclaw-gateway
journalctl --user -u openclaw-gateway -f
```

### `wednesdayai daemon`

Legacy alias namespace for the gateway service commands (`status`, `install`, `uninstall`, `start`, `stop`, `restart`). Prefer `wednesdayai gateway <subcommand>`.

### `wednesdayai status`

Local and channel diagnostics summary.

```bash theme={"dark"}
wednesdayai status              # compact: gateway, channels, sessions
wednesdayai status --all        # full local diagnosis (safe to paste)
wednesdayai status --deep       # also probe the running gateway per-channel
wednesdayai status --usage      # include provider usage/quota
```

Key flags: `--json`, `--all`, `--deep`, `--usage`, `--timeout <ms>`, `--verbose`.

### `wednesdayai health`

Fetch a health snapshot from the running gateway via RPC. Exits non-zero if unreachable or any probe fails.

```bash theme={"dark"}
wednesdayai health --json --timeout 5000
```

Key flags: `--json`, `--timeout <ms>`, `--verbose`.

### `wednesdayai doctor`

Health checks and guided repairs (config, model auth, channel connectivity, service health, port collisions, permissions, legacy migrations).

```bash theme={"dark"}
wednesdayai doctor              # interactive: prompts before applying fixes
wednesdayai doctor --yes        # accept defaults without prompting
wednesdayai doctor --deep       # scan for extra/stale gateway installs
```

Key flags: `--yes`, `--non-interactive` (safe migrations only), `--deep`, `--no-workspace-suggestions`, `--fix` (auto-remediate detected issues where safe to do so), `--json` (output findings as JSON for scripting), `--check <name>` (run only the named check, e.g. `--check ollama`, `--check disk`).

### `wednesdayai logs`

Tail the gateway log file via RPC.

```bash theme={"dark"}
wednesdayai logs --follow       # live tail (pretty in a TTY)
wednesdayai logs --limit 200
wednesdayai logs --json         # line-delimited JSON
wednesdayai logs --plain
wednesdayai logs --no-color
wednesdayai logs --local-time   # display timestamps in local timezone (default: UTC)
```

### `wednesdayai dashboard`

Open the control panel in your browser (default `http://localhost:18789/`).

```bash theme={"dark"}
wednesdayai dashboard
```

### `wednesdayai tui`

Open the terminal UI connected to the gateway.

```bash theme={"dark"}
wednesdayai tui --session main --message "status?"
```

Key flags: `--url <url>`, `--token <token>`, `--password <password>`, `--session <key>`, `--deliver`, `--thinking <level>`, `--message <text>`, `--timeout-ms <ms>`, `--history-limit <n>`.

### `wednesdayai qr`

Display a QR code for mobile pairing.

```bash theme={"dark"}
wednesdayai qr
wednesdayai qr --channel whatsapp
```

***

## Authentication, models, and providers

### `wednesdayai models`

Manage AI model credentials and selection. `wednesdayai models` with no subcommand is an alias for `models status`.

```bash theme={"dark"}
wednesdayai models status                   # auth overview + OAuth expiry
wednesdayai models status --check           # exit 1=expired/missing, 2=expiring
wednesdayai models status --probe           # probe configured provider auth (validates credentials live — does not send a completion)
wednesdayai models status --probe --probe-timeout 15000   # timeout for probe request (default: 10000 ms)
wednesdayai models list --all
wednesdayai models set anthropic/claude-sonnet-4-5
wednesdayai models set-image openai/gpt-image-1
wednesdayai models auth setup-token --provider anthropic
wednesdayai models auth paste-token --provider anthropic
wednesdayai models auth order set --provider anthropic anthropic:work
```

Subcommands: `list`, `status`, `set <model>`, `set-image <model>`, `aliases list\|add\|rm`, `fallbacks list\|add\|rm\|clear`, `image-fallbacks list\|add\|rm\|clear`, `scan`, `auth add\|setup-token\|paste-token`, `auth order get\|set\|clear`.

`models status` key flags: `--check`, `--probe` (validates credentials live — does not send a completion), `--probe-timeout <ms>` (probe timeout, default `10000`), `--probe-provider <name>` (probe only the named provider), `--probe-profile <id>` (filter to specific profile(s); repeatable or comma-separated), `--probe-concurrency <n>` (number of concurrent probe requests), `--probe-max-tokens <n>` (max tokens for probe completion request), `--plain` (plain line output, no table formatting), `--agent <id>` (inspect a specific configured agent's model and auth state).

`models set` writes `agents.defaults.model.primary`; `models set-image` writes `agents.defaults.imageModel.primary`.

### `wednesdayai models auth`

Authenticate with model providers interactively.

```bash theme={"dark"}
wednesdayai models auth login --provider anthropic        # interactive OAuth flow for the named provider
wednesdayai models auth login-github-copilot              # GitHub Copilot device-flow OAuth; sets providers.copilot.token
```

`auth login` flags: `--provider <name>` (required — specifies the provider to authenticate with).

***

## Channels and pairing

### `wednesdayai channels`

Manage chat channel accounts.

```bash theme={"dark"}
wednesdayai channels list                   # configured channels and auth profiles
wednesdayai channels list --no-usage        # skip model provider usage/quota snapshots
wednesdayai channels status --probe         # connectivity + live probe
wednesdayai channels add --channel telegram --account alerts --name "Alerts Bot" --token $TELEGRAM_BOT_TOKEN
wednesdayai channels remove --channel discord --account work --delete
wednesdayai channels login --channel whatsapp --account work    # WhatsApp Web only
wednesdayai channels logout --channel whatsapp
wednesdayai channels logs --channel telegram --lines 200
wednesdayai channels capabilities --channel whatsapp             # list capabilities: reactions, threads, voice, files
wednesdayai channels resolve alice bob --channel telegram [--kind auto]   # resolve names/IDs to OpenClaw user records
```

Subcommands: `list`, `status`, `logs`, `add`, `remove`, `login`, `logout`, `capabilities --channel <name>`, `resolve <entries...> --channel <name> [--kind <auto|user|group>]`. Common flags: `--channel <name>`, `--account <id>`, `--name <label>`, `--json`. `--channel` accepts `whatsapp\|telegram\|discord\|googlechat\|slack\|mattermost\|signal\|imessage\|msteams\|irc` (plus installed channel extensions). `channels add` runs a wizard when no flags are passed; flags switch to non-interactive mode.

### `wednesdayai pairing`

Approve DM pairing requests across channels.

```bash theme={"dark"}
wednesdayai pairing list                            # all pending requests
wednesdayai pairing list whatsapp --json
wednesdayai pairing approve whatsapp <CODE> --notify
```

Subcommands: `list [channel]`, `approve <channel> <code>`. Flags: `--channel <channel>`, `--account <id>`, `--json`, `--notify` (on `approve`).

> [!WARNING]
>
> There is no `pairing deny` and no `pairing list --all`. To refuse a sender, leave the request unapproved or tighten `channels.<channel>.dmPolicy`/`allowFrom`.

### `wednesdayai devices`

Manage gateway device-pairing entries and per-role device tokens.

```bash theme={"dark"}
wednesdayai devices list --json
wednesdayai devices approve --latest
wednesdayai devices reject <requestId>
wednesdayai devices remove <deviceId>
wednesdayai devices clear --yes
wednesdayai devices rotate --device <id> --role <role>
wednesdayai devices revoke --device <id> --role <role>
```

Subcommands: `list`, `approve [requestId] [--latest]`, `reject <requestId>`, `remove <deviceId>`, `clear --yes [--pending]`, `rotate --device <id> --role <role> [--scope <scope...>]`, `revoke --device <id> --role <role>`.

***

## Configuration

### `wednesdayai config`

Read and write gateway configuration. Running `wednesdayai config` with no subcommand launches the wizard.

```bash theme={"dark"}
wednesdayai config get                                   # print full config
wednesdayai config get agents.defaults.model.primary
wednesdayai config set agents.defaults.model.primary '"anthropic/claude-sonnet-4-5"'
wednesdayai config unset channels.telegram.dmPolicy
wednesdayai config file                                  # print active config path
wednesdayai config validate --json                       # validate against schema
```

Subcommands: `get <path>`, `set <path> <value>` (value is JSON5 or a raw string), `unset <path>`, `file`, `validate`.

### `wednesdayai secrets`

Manage SecretRef resolution and provider mappings.

```bash theme={"dark"}
wednesdayai secrets reload                 # re-resolve refs, atomically swap runtime snapshot
wednesdayai secrets audit                  # scan for plaintext residues / unresolved refs
wednesdayai secrets configure              # interactive provider + SecretRef setup
wednesdayai secrets apply --from plan.json --dry-run
```

Subcommands: `reload`, `audit`, `configure`, `apply --from <plan.json>` (`migrate` also exists as an alias surface).

### `wednesdayai directory`

Look up contact and group IDs for supported chat channels.

```bash theme={"dark"}
wednesdayai directory self                          # show your own user ID across connected channels
wednesdayai directory peers list                    # list all known contacts
wednesdayai directory groups list                   # list all known groups
wednesdayai directory groups members <group-id>     # list members of a group
```

### `wednesdayai dns`

Wide-area discovery DNS helper (CoreDNS + Tailscale).

```bash theme={"dark"}
wednesdayai dns setup --apply        # install/update CoreDNS config (sudo; macOS only)
```

See [/gateway/discovery](https://docs.wednesdayai.dev/gateway/discovery.md).

***

## Agents, sessions, and ACP

### `wednesdayai agent`

Run one agent turn via the gateway (or `--local` embedded).

```bash theme={"dark"}
wednesdayai agent --message "Summarise today" --to whatsapp:+15555550123 --deliver
```

Required: `--message <text>`. Key flags: `--to <dest>`, `--session-id <id>`, `--thinking <off\|minimal\|low\|medium\|high>`, `--verbose <on\|off>`, `--channel <name>`, `--local`, `--deliver`, `--json`, `--timeout <seconds>`.

#### `wednesdayai agent nudge`

Interrupt an active agent session mid-turn with a nudge message.

```bash theme={"dark"}
wednesdayai agent nudge "stop and summarise what you have so far"
wednesdayai agent nudge "abort" --agent work
wednesdayai agent nudge "checkpoint" --all
```

Flags: `--agent <id>` (target a specific agent by id; defaults to the current active agent), `--all` (broadcast the nudge to all active agents).

### `wednesdayai agents`

Manage isolated agents (workspaces + auth + routing). There is no `agents status`.

```bash theme={"dark"}
wednesdayai agents list --bindings
wednesdayai agents add work --workspace ~/.openclaw/workspace-work --bind whatsapp:biz
wednesdayai agents bindings --agent work
wednesdayai agents bind --agent work --bind discord:guild
wednesdayai agents unbind --agent work --bind discord:guild
wednesdayai agents delete work --force
wednesdayai agents set-identity work "Wednesday"   # set display name/persona; persists in the agent's config file
```

Subcommands: `list`, `add [name]`, `bindings`, `bind`, `unbind`, `delete <id>`, `set-identity <agent-id> <name>`. Binding specs use `channel[:accountId]`. `--workspace` is required for non-interactive `add`.

### `wednesdayai sessions`

List stored conversation sessions.

```bash theme={"dark"}
wednesdayai sessions --active 60 --json
wednesdayai sessions cleanup --dry-run                   # preview what would be cleaned up without making changes
wednesdayai sessions cleanup --enforce                   # enforce storage caps and prune over-budget sessions
wednesdayai sessions backfill-user-ids                   # one-time migration: back-fill userId in legacy records
```

Key flags: `--json`, `--verbose`, `--store <path>`, `--active <minutes>`, `--agent <id>` (inspect a specific agent's store), `--all-agents` (aggregate across all agents).

`sessions cleanup` — Enforce session-store storage budgets and caps. Prunes sessions exceeding configured limits.

| Flag | Description |
| - | - |
| `--dry-run` | Preview what would be cleaned up without making changes |
| `--enforce` | Enforce storage caps and prune over-budget sessions |
| `--all-agents` | Run cleanup across all agents (not just current) |
| `--agent <id>` | Target a specific agent |
| `--fix-missing` | Remove store entries whose transcript files are missing (bypasses age/count retention) |
| `--active-key <key>` | Treat sessions with this key as active (skip pruning) |

`sessions backfill-user-ids` is safe on live data and idempotent — re-running it is a no-op for records already migrated. Flags: `--batch-size <n>` (rows per batch, default `500`), `--dry-run` (preview without writing).

### `wednesdayai session-storage`

Manage the session backing store.

```bash theme={"dark"}
wednesdayai session-storage init                  # initialize the session storage schema
wednesdayai session-storage validate              # validate schema integrity
wednesdayai session-storage cutover               # cut over to new storage schema
wednesdayai session-storage drop-legacy-archive   # remove legacy archive after successful cutover
```

Subcommands: `init`, `validate`, `cutover`, `drop-legacy-archive`. Common flags: `--json`.

### `wednesdayai acp`

Run the ACP bridge that connects IDEs (Agent Client Protocol) to the gateway. See [`acp`](https://docs.wednesdayai.dev/cli/acp) for options.

***

## Messaging

### `wednesdayai message`

Unified outbound messaging and channel actions.

```bash theme={"dark"}
wednesdayai message send --target +15555550123 --message "Hello"
wednesdayai message send --channel discord --target channel:123 --message "Test"
wednesdayai message poll --channel discord --target channel:123 \
  --poll-question "Snack?" --poll-option Pizza --poll-option Sushi
```

```bash theme={"dark"}
wednesdayai message broadcast "Gateway maintenance at 22:00 UTC"
wednesdayai message broadcast "Scheduled downtime" --channel telegram
wednesdayai message broadcast "Test run" --dry-run
```

Subcommands: `send`, `poll`, `react`, `reactions`, `read`, `edit`, `delete`, `pin`, `unpin`, `pins`, `permissions`, `search`, `timeout`, `kick`, `ban`, `thread <create\|list\|reply>`, `emoji <list\|upload>`, `sticker <send\|upload>`, `role <info\|add\|rm>`, `channel <info\|list>`, `member info`, `voice status`, `event <list\|create>`, `broadcast <message>`. See [/cli/message](https://docs.wednesdayai.dev/cli/message.md) for per-subcommand flags.

`message broadcast` flags: `--channel <name>` (restrict broadcast to one channel; omit to send across all active channels), `--dry-run` (print targets without sending).

***

## Skills and hooks

### `wednesdayai skills`

List and inspect available skills plus readiness info. Skills are **read-only** from the CLI.

```bash theme={"dark"}
wednesdayai skills list --eligible
wednesdayai skills info <name>
wednesdayai skills check
```

Subcommands: `list`, `info <name>`, `check`. Flags: `--eligible`, `--json`, `--verbose`.

> [!NOTE]
>
> There is no `skills enable`, `skills disable`, or `skills install`. Use `npx clawhub` to search, install, and sync skills; control which bundled skills load via `skills.allowBundled` and `skills.load.extraDirs` in config.

### `wednesdayai hooks`

Manage gateway hooks.

```bash theme={"dark"}
wednesdayai hooks list                      # all hooks with enabled/disabled status
wednesdayai hooks info <name>
wednesdayai hooks check                     # verify enabled hooks can load
wednesdayai hooks enable <name>
wednesdayai hooks disable <name>
wednesdayai hooks install ./path/to/hook
wednesdayai hooks update [id]               # update an installed hook
```

Subcommands: `list`, `info`, `check`, `enable`, `disable`, `install`, `update [id]`. `update` flags: `--all` (update all tracked hooks), `--dry-run`. See the [Hooks catalogue](https://docs.wednesdayai.dev/next/reference/hooks-catalogue.md).

***

## Plugins

### `wednesdayai plugins`

Manage extensions and their config. Most plugin changes require a gateway restart.

```bash theme={"dark"}
wednesdayai plugins list --json
wednesdayai plugins list --verbose          # show detailed entries including config and state
wednesdayai plugins info <id>
wednesdayai plugins install <path|.tgz|npm-spec>
wednesdayai plugins install <path> --link   # link local path instead of copying
wednesdayai plugins enable <id>
wednesdayai plugins disable <id>
wednesdayai plugins status                  # show plugin status (enabled/disabled/error) for all installed plugins
wednesdayai plugins uninstall <id>          # remove an installed plugin
wednesdayai plugins update [id]             # update a plugin (or all plugins if no id given)
wednesdayai plugins doctor                  # report plugin load errors
```

Subcommands: `list`, `info <id>`, `install`, `enable <id>`, `disable <id>`, `doctor`, `status`, `uninstall <id>`, `update [id]`.

`plugins install` flags: `-l, --link` (link local path instead of copying), `--pin` (pin to exact version), `--force` (overwrite existing install).

`plugins list` flags: `--json`, `--verbose` (show detailed entries including config and state).

`plugins uninstall` flags: `--keep-files` (preserve plugin files), `--force` (skip confirmation), `--dry-run` (preview without removing).

***

## Memory

### `wednesdayai memory`

Vector search over `MEMORY.md` and `memory/*.md`.

```bash theme={"dark"}
wednesdayai memory status                   # index stats
wednesdayai memory index                    # reindex memory files
wednesdayai memory search "deployment notes"
```

Subcommands: `status`, `index`, `search "<query>"` (`--query` also accepted).

***

## Nodes and node host

### `wednesdayai nodes`

Target paired nodes (mobile/desktop) via the gateway.

```bash theme={"dark"}
wednesdayai nodes list --connected
wednesdayai nodes status
wednesdayai nodes pending
wednesdayai nodes approve <requestId>
wednesdayai nodes reject <requestId>
wednesdayai nodes describe --node <id|name|ip>
wednesdayai nodes rename --node <id> --name "Studio Mac"
wednesdayai nodes run --node <id> -- ls -la
wednesdayai nodes camera snap --node <id> --facing front
wednesdayai nodes screen record --node <id> --duration 10s
wednesdayai nodes notify --node <id> --title "Hi" --body "Ping"   # mac only
```

Subcommands include: `status`, `list`, `pending`, `approve`, `reject`, `describe`, `rename`, `invoke`, `run`, `notify`, `camera <list\|snap\|clip>`, `canvas <snapshot\|present\|hide\|navigate\|eval\|a2ui>`, `screen record`, `location get`. Common flags: `--url`, `--token`, `--timeout`, `--json`. See [/nodes](https://docs.wednesdayai.dev/nodes.md).

### `wednesdayai node`

Run a headless node host, or manage it as a background service.

```bash theme={"dark"}
wednesdayai node run --host gateway-host --port 18789
wednesdayai node install --host gateway-host --tls --runtime node
wednesdayai node status
wednesdayai node start|stop|restart|uninstall
```

Subcommands: `run`, `status`, `install`, `uninstall`, `start`, `stop`, `restart`. See [`wednesdayai node`](https://docs.wednesdayai.dev/cli/node).

***

## Approvals and sandbox

### `wednesdayai approvals`

Manage exec-approval policy and allowlists.

```bash theme={"dark"}
wednesdayai approvals get
wednesdayai approvals set <policy>
wednesdayai approvals allowlist add <pattern>
wednesdayai approvals allowlist remove <pattern>
```

Subcommands: `get`, `set`, `allowlist add\|remove`.

### `wednesdayai sandbox`

Inspect and manage agent sandboxes.

```bash theme={"dark"}
wednesdayai sandbox list
wednesdayai sandbox explain               # explain effective sandbox policy
wednesdayai sandbox recreate
```

Subcommands: `list`, `recreate`, `explain`.

***

## Browser

### `wednesdayai browser`

Control a dedicated Chrome/Brave/Edge/Chromium instance. Common flags: `--url`, `--token`, `--timeout`, `--json`, `--browser-profile <name>`.

```bash theme={"dark"}
wednesdayai browser status
wednesdayai browser start
wednesdayai browser open https://example.com
wednesdayai browser navigate https://example.com --target-id <id>
wednesdayai browser screenshot --full-page
wednesdayai browser snapshot --format ai
wednesdayai browser click <ref>
wednesdayai browser type <ref> "hello" --submit
wednesdayai browser pdf
```

Manage: `status`, `start`, `stop`, `reset-profile`, `tabs`, `open <url>`, `focus <targetId>`, `close [targetId]`, `profiles`, `create-profile`, `delete-profile`.
Inspect: `screenshot`, `snapshot`.
Actions: `navigate`, `resize`, `click`, `type`, `press`, `hover`, `drag`, `select`, `upload`, `fill`, `dialog`, `wait`, `evaluate`, `console`, `pdf`. See [`wednesdayai browser`](https://docs.wednesdayai.dev/cli/browser) and the [Browser tool](https://docs.wednesdayai.dev/tools/browser.md).

***

## System

### `wednesdayai system`

Enqueue system events and manage heartbeat/presence (gateway RPC).

```bash theme={"dark"}
wednesdayai system event --text "Deploy finished" --mode next-heartbeat
wednesdayai system heartbeat last
wednesdayai system heartbeat enable
wednesdayai system presence
```

Subcommands: `event` (`--text` required; `--mode <now\|next-heartbeat>`), `heartbeat last\|enable\|disable`, `presence`. All accept `--json`, `--url`, `--token`, `--timeout`, `--expect-final`.

***

## Cron

### `wednesdayai cron`

Manage scheduled jobs (gateway RPC). See [/automation/cron-jobs](https://docs.wednesdayai.dev/automation/cron-jobs.md).

```bash theme={"dark"}
wednesdayai cron list --all
wednesdayai cron status
wednesdayai cron add --name "Morning briefing" --cron "0 9 * * *" --message "Daily summary"
wednesdayai cron edit <id>
wednesdayai cron rm <id>
wednesdayai cron enable <id>
wednesdayai cron disable <id>
wednesdayai cron run <id> --due
wednesdayai cron runs --id <id> --limit 20
```

Subcommands: `status`, `list`, `add` (alias `create`), `edit <id>`, `rm <id>` (aliases `remove`, `delete`), `enable <id>`, `disable <id>`, `runs --id <id>`, `run <id>`.

`cron add` delivery and lifecycle flags:

| Flag | Description |
| - | - |
| `--announce` | Deliver cron output to chat (default for isolated jobs) |
| `--no-deliver` | Keep output internal, do not deliver to chat |
| `--deliver` | Deprecated alias for `--announce` |
| `--keep-after-run` | Keep one-shot job after it runs successfully (default: delete after run) |

> [!WARNING]
>
> Use `--cron` for cron expressions (not `--schedule`). `cron add` requires `--name` and exactly one schedule of `--at` / `--every` / `--cron`, plus exactly one payload of `--message` / `--system-event`. Use `cron rm` (canonical) for deletion and `cron runs --id <id>` (not `logs`) for run history.

***

## Security

### `wednesdayai security`

Audit config and local state for common security foot-guns.

```bash theme={"dark"}
wednesdayai security audit                  # flag misconfigurations
wednesdayai security audit --deep           # best-effort live gateway probe
wednesdayai security audit --fix            # tighten safe defaults and chmod state
```

Subcommand: `audit`. Flags: `--deep`, `--fix`, `--json`.

***

## Webhooks and docs

### `wednesdayai webhooks`

Inbound webhook helpers.

```bash theme={"dark"}
wednesdayai webhooks gmail setup --account you@example.com
wednesdayai webhooks gmail run
```

Subcommands: `gmail setup`, `gmail run`. See [/automation/gmail-pubsub](https://docs.wednesdayai.dev/automation/gmail-pubsub.md).

### `wednesdayai docs`

Search the live docs index.

```bash theme={"dark"}
wednesdayai docs "remote access"
```

***

## Legacy and plugin commands

### `wednesdayai clawbot`

Legacy alias namespace (for example `wednesdayai clawbot qr`). Prefer the modern equivalents.

### `wednesdayai voicecall`

Provided by the voice-call plugin when installed. Plugins can register additional top-level commands.

***

## Environment variables

| Variable | Effect |
| - | - |
| `OPENCLAW_GATEWAY_TOKEN` | Gateway auth token |
| `OPENCLAW_GATEWAY_PASSWORD` | Gateway auth password |
| `OPENCLAW_GATEWAY_PORT` | Override gateway port |
| `OPENCLAW_CONFIG_PATH` | Absolute path to config file |
| `OPENCLAW_HOME` | Override home directory for internal paths |
| `OPENCLAW_STATE_DIR` | Override state directory |
| `OPENCLAW_LOG_LEVEL` | Log level override (`error`, `warn`, `info`, `debug`, `trace`) |
| `OPENCLAW_LOAD_SHELL_ENV=1` | Import missing vars from login shell |
| `NO_COLOR=1` | Disable ANSI colours |
| `ANTHROPIC_API_KEY` | Anthropic API key |
| `OPENAI_API_KEY` | OpenAI API key |
| `GOOGLE_API_KEY` | Google AI API key |
| `GEMINI_API_KEY` | Google Gemini API key (first-class provider key, not just an alias for `GOOGLE_API_KEY`) |
| `OPENCLAW_SHELL_ENV_TIMEOUT_MS` | Timeout in ms for shell environment import (default: `15000`) |
| `TELEGRAM_BOT_TOKEN` | Telegram bot token (default account) |
| `DISCORD_BOT_TOKEN` | Discord bot token (default account) |
| `SLACK_BOT_TOKEN` | Slack bot token (default account) |
| `SLACK_APP_TOKEN` | Slack app token for Socket Mode (default account) |

## Related

* [Gateway configuration reference](https://docs.wednesdayai.dev/next/reference/config.md)
* [Gateway API reference](https://docs.wednesdayai.dev/next/reference/api.md)
* [Hooks catalogue](https://docs.wednesdayai.dev/next/reference/hooks-catalogue.md)
* [Health checks](https://docs.wednesdayai.dev/next/admin/gateway/health-checks.md)
* [Troubleshooting](https://docs.wednesdayai.dev/next/admin/troubleshooting.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.