--- summary: "Clawdbot CLI reference for `clawdbot` commands, subcommands, and options" read_when: - Adding or modifying CLI commands or options - Documenting new command surfaces --- # CLI reference This page describes the current CLI behavior. If commands change, update this doc. ## Command pages - [`setup`](/cli/setup) - [`onboard`](/cli/onboard) - [`configure`](/cli/configure) - [`config`](/cli/config) - [`doctor`](/cli/doctor) - [`dashboard`](/cli/dashboard) - [`reset`](/cli/reset) - [`uninstall`](/cli/uninstall) - [`update`](/cli/update) - [`message`](/cli/message) - [`agent`](/cli/agent) - [`agents`](/cli/agents) - [`acp`](/cli/acp) - [`status`](/cli/status) - [`health`](/cli/health) - [`sessions`](/cli/sessions) - [`gateway`](/cli/gateway) - [`daemon`](/cli/daemon) - [`service`](/cli/service) - [`logs`](/cli/logs) - [`models`](/cli/models) - [`memory`](/cli/memory) - [`nodes`](/cli/nodes) - [`devices`](/cli/devices) - [`node`](/cli/node) - [`approvals`](/cli/approvals) - [`sandbox`](/cli/sandbox) - [`tui`](/cli/tui) - [`browser`](/cli/browser) - [`wake`](/cli/wake) - [`cron`](/cli/cron) - [`dns`](/cli/dns) - [`docs`](/cli/docs) - [`hooks`](/cli/hooks) - [`webhooks`](/cli/webhooks) - [`pairing`](/cli/pairing) - [`plugins`](/cli/plugins) (plugin commands) - [`channels`](/cli/channels) - [`security`](/cli/security) - [`skills`](/cli/skills) - [`voicecall`](/cli/voicecall) (plugin; if installed) ## Global flags - `--dev`: isolate state under `~/.clawdbot-dev` and shift default ports. - `--profile `: isolate state under `~/.clawdbot-`. - `--no-color`: disable ANSI colors. - `--update`: shorthand for `clawdbot update` (source installs only). - `-V`, `--version`, `-v`: print version and exit. ## Output styling - ANSI colors 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 output. - `--no-color` disables ANSI styling; `NO_COLOR=1` is also respected. - Long-running commands show a progress indicator (OSC 9;4 when supported). ## Color palette Clawdbot uses a lobster palette for CLI output. - `accent` (#FF5A2D): headings, labels, primary highlights. - `accentBright` (#FF7A3D): command names, emphasis. - `accentDim` (#D14A22): secondary highlight text. - `info` (#FF8A5B): informational values. - `success` (#2FBF71): success states. - `warn` (#FFB020): warnings, fallbacks, attention. - `error` (#E23D2D): errors, failures. - `muted` (#8B7F77): de-emphasis, metadata. Palette source of truth: `src/terminal/palette.ts` (aka “lobster seam”). ## Command tree ``` clawdbot [--dev] [--profile ] setup onboard configure config get set unset doctor security audit reset uninstall update channels list status logs add remove login logout skills list info check plugins list info install enable disable doctor memory status index search message agent agents list add delete acp status health sessions gateway call health status discover daemon status install uninstall start stop restart service gateway status install uninstall start stop restart node status install uninstall start stop restart logs models list status set set-image aliases list|add|remove fallbacks list|add|remove|clear image-fallbacks list|add|remove|clear scan auth add|setup-token|paste-token auth order get|set|clear sandbox list recreate explain wake cron status list add edit rm enable disable runs run nodes devices node start daemon status install uninstall start stop restart approvals get set allowlist add|remove browser status start stop reset-profile tabs open focus close profiles create-profile delete-profile screenshot snapshot navigate resize click type press hover drag select upload fill dialog wait evaluate console pdf hooks list info check enable disable install update webhooks gmail setup|run pairing list approve docs dns setup tui ``` Note: plugins can add additional top-level commands (for example `clawdbot voicecall`). ## Security - `clawdbot security audit` — audit config + local state for common security foot-guns. - `clawdbot security audit --deep` — best-effort live Gateway probe. - `clawdbot security audit --fix` — tighten safe defaults and chmod state/config. ## Plugins Manage extensions and their config: - `clawdbot plugins list` — discover plugins (use `--json` for machine output). - `clawdbot plugins info ` — show details for a plugin. - `clawdbot plugins install ` — install a plugin (or add a plugin path to `plugins.load.paths`). - `clawdbot plugins enable ` / `disable ` — toggle `plugins.entries..enabled`. - `clawdbot plugins doctor` — report plugin load errors. Most plugin changes require a gateway restart. See [/plugin](/plugin). ## Memory Vector search over `MEMORY.md` + `memory/*.md`: - `clawdbot memory status` — show index stats. - `clawdbot memory index` — reindex memory files. - `clawdbot memory search ""` — semantic search over memory. ## Chat slash commands Chat messages support `/...` commands (text and native). See [/tools/slash-commands](/tools/slash-commands). Highlights: - `/status` for quick diagnostics. - `/config` for persisted config changes. - `/debug` for runtime-only config overrides (memory, not disk; requires `commands.debug: true`). ## Setup + onboarding ### `setup` Initialize config + workspace. Options: - `--workspace `: agent workspace path (default `~/clawd`). - `--wizard`: run the onboarding wizard. - `--non-interactive`: run wizard without prompts. - `--mode `: wizard mode. - `--remote-url `: remote Gateway URL. - `--remote-token `: remote Gateway token. Wizard auto-runs when any wizard flags are present (`--non-interactive`, `--mode`, `--remote-url`, `--remote-token`). ### `onboard` Interactive wizard to set up gateway, workspace, and skills. Options: - `--workspace ` - `--reset` (reset config + credentials + sessions + workspace before wizard) - `--non-interactive` - `--mode ` - `--flow ` - `--auth-choice ` - `--token-provider ` (non-interactive; used with `--auth-choice token`) - `--token ` (non-interactive; used with `--auth-choice token`) - `--token-profile-id ` (non-interactive; default: `:manual`) - `--token-expires-in ` (non-interactive; e.g. `365d`, `12h`) - `--anthropic-api-key ` - `--openai-api-key ` - `--openrouter-api-key ` - `--ai-gateway-api-key ` - `--moonshot-api-key ` - `--kimi-code-api-key ` - `--gemini-api-key ` - `--zai-api-key ` - `--minimax-api-key ` - `--opencode-zen-api-key ` - `--gateway-port ` - `--gateway-bind ` - `--gateway-auth ` - `--gateway-token ` - `--gateway-password ` - `--remote-url ` - `--remote-token ` - `--tailscale ` - `--tailscale-reset-on-exit` - `--install-daemon` - `--no-install-daemon` (alias: `--skip-daemon`) - `--daemon-runtime ` - `--skip-channels` - `--skip-skills` - `--skip-health` - `--skip-ui` - `--node-manager ` (pnpm recommended; bun not recommended for Gateway runtime) - `--json` ### `configure` Interactive configuration wizard (models, channels, skills, gateway). ### `config` Non-interactive config helpers (get/set/unset). Running `clawdbot config` with no subcommand launches the wizard. Subcommands: - `config get `: print a config value (dot/bracket path). - `config set `: set a value (JSON5 or raw string). - `config unset `: remove a value. ### `doctor` Health checks + quick fixes (config + gateway + legacy services). Options: - `--no-workspace-suggestions`: disable workspace memory hints. - `--yes`: accept defaults without prompting (headless). - `--non-interactive`: skip prompts; apply safe migrations only. - `--deep`: scan system services for extra gateway installs. ## Channel helpers ### `channels` Manage chat channel accounts (WhatsApp/Telegram/Discord/Slack/Signal/iMessage/MS Teams). Subcommands: - `channels list`: show configured channels and auth profiles (Claude Code + Codex CLI OAuth sync included). - `channels status`: check gateway reachability and channel health (`--probe` runs extra checks; use `clawdbot health` or `clawdbot status --deep` for gateway health probes). - Tip: `channels status` prints warnings with suggested fixes when it can detect common misconfigurations (then points you to `clawdbot doctor`). - `channels logs`: show recent channel logs from the gateway log file. - `channels add`: wizard-style setup when no flags are passed; flags switch to non-interactive mode. - `channels remove`: disable by default; pass `--delete` to remove config entries without prompts. - `channels login`: interactive channel login (WhatsApp Web only). - `channels logout`: log out of a channel session (if supported). Common options: - `--channel `: `whatsapp|telegram|discord|slack|signal|imessage|msteams` - `--account `: channel account id (default `default`) - `--name