docs(cli): add per-command CLI pages

This commit is contained in:
Peter Steinberger
2026-01-15 06:12:54 +00:00
parent 5b23f847d6
commit 0cbfea79fa
58 changed files with 881 additions and 23 deletions

20
docs/cli/agent.md Normal file
View File

@@ -0,0 +1,20 @@
---
summary: "CLI reference for `clawdbot agent` (send one agent turn via the Gateway)"
read_when:
- You want to run one agent turn from scripts (optionally deliver reply)
---
# `clawdbot agent`
Run an agent turn via the Gateway (use `--local` for embedded).
Related:
- Agent send tool: [Agent send](/tools/agent-send)
## Examples
```bash
clawdbot agent --to +15555550123 --message "status update" --deliver
clawdbot agent --session-id 1234 --message "Summarize inbox" --thinking medium
```

22
docs/cli/agents.md Normal file
View File

@@ -0,0 +1,22 @@
---
summary: "CLI reference for `clawdbot agents` (list/add/delete isolated agents)"
read_when:
- You want multiple isolated agents (workspaces + routing + auth)
---
# `clawdbot agents`
Manage isolated agents (workspaces + auth + routing).
Related:
- Multi-agent routing: [Multi-Agent Routing](/concepts/multi-agent)
- Agent workspace: [Agent workspace](/concepts/agent-workspace)
## Examples
```bash
clawdbot agents list
clawdbot agents add work --workspace ~/clawd-work
clawdbot agents delete work
```

44
docs/cli/channels.md Normal file
View File

@@ -0,0 +1,44 @@
---
summary: "CLI reference for `clawdbot channels` (accounts, status, login/logout, logs)"
read_when:
- You want to add/remove channel accounts (WhatsApp/Telegram/Discord/Slack/Signal/iMessage)
- You want to check channel status or tail channel logs
---
# `clawdbot channels`
Manage chat channel accounts and their runtime status on the Gateway.
Related docs:
- Channel guides: [Channels](/channels/index)
- Gateway configuration: [Configuration](/gateway/configuration)
## Common commands
```bash
clawdbot channels list
clawdbot channels status
clawdbot channels logs --channel all
```
## Add / remove accounts
```bash
clawdbot channels add --channel telegram --token <bot-token>
clawdbot channels remove --channel telegram --delete
```
Tip: `clawdbot channels add --help` shows per-channel flags (token, app token, signal-cli paths, etc).
## Login / logout (interactive)
```bash
clawdbot channels login --channel whatsapp
clawdbot channels logout --channel whatsapp
```
## Troubleshooting
- Run `clawdbot status --deep` for a broad probe.
- Use `clawdbot doctor` for guided fixes.

20
docs/cli/configure.md Normal file
View File

@@ -0,0 +1,20 @@
---
summary: "CLI reference for `clawdbot configure` / `clawdbot config` (interactive configuration prompts)"
read_when:
- You want to tweak credentials, devices, or agent defaults interactively
---
# `clawdbot configure` (alias: `config`)
Interactive prompt to set up credentials, devices, and agent defaults.
Related:
- Gateway configuration reference: [Configuration](/gateway/configuration)
## Examples
```bash
clawdbot configure
clawdbot configure --section models --section channels
```

16
docs/cli/cron.md Normal file
View File

@@ -0,0 +1,16 @@
---
summary: "CLI reference for `clawdbot cron` (schedule and run background jobs)"
read_when:
- You want scheduled jobs and wakeups
- Youre debugging cron execution and logs
---
# `clawdbot cron`
Manage cron jobs for the Gateway scheduler.
Related:
- Cron jobs: [Cron jobs](/automation/cron-jobs)
Tip: run `clawdbot cron --help` for the full command surface.

17
docs/cli/daemon.md Normal file
View File

@@ -0,0 +1,17 @@
---
summary: "CLI reference for `clawdbot daemon` (install/uninstall/status for the Gateway service)"
read_when:
- You want to run the Gateway as a background service
- Youre debugging daemon install, status, or logs
---
# `clawdbot daemon`
Manage the Gateway daemon (background service).
Related:
- Gateway CLI: [Gateway](/cli/gateway)
- macOS platform notes: [macOS](/platforms/macos)
Tip: run `clawdbot daemon --help` for platform-specific flags.

16
docs/cli/dashboard.md Normal file
View File

@@ -0,0 +1,16 @@
---
summary: "CLI reference for `clawdbot dashboard` (open the Control UI)"
read_when:
- You want to open the Control UI with your current token
- You want to print the URL without launching a browser
---
# `clawdbot dashboard`
Open the Control UI using your current auth.
```bash
clawdbot dashboard
clawdbot dashboard --no-open
```

22
docs/cli/dns.md Normal file
View File

@@ -0,0 +1,22 @@
---
summary: "CLI reference for `clawdbot dns` (wide-area discovery helpers)"
read_when:
- You want wide-area discovery (DNS-SD) via Tailscale + CoreDNS
- Youre setting up split DNS for clawdbot.internal
---
# `clawdbot dns`
DNS helpers for wide-area discovery (Tailscale + CoreDNS). Currently focused on macOS + Homebrew CoreDNS.
Related:
- Gateway discovery: [Discovery](/gateway/discovery)
- Wide-area discovery config: [Configuration](/gateway/configuration)
## Setup
```bash
clawdbot dns setup
clawdbot dns setup --apply
```

15
docs/cli/docs.md Normal file
View File

@@ -0,0 +1,15 @@
---
summary: "CLI reference for `clawdbot docs` (search the live docs index)"
read_when:
- You want to search the live Clawdbot docs from the terminal
---
# `clawdbot docs`
Search the live docs index.
```bash
clawdbot docs browser extension
clawdbot docs sandbox allowHostControl
```

23
docs/cli/doctor.md Normal file
View File

@@ -0,0 +1,23 @@
---
summary: "CLI reference for `clawdbot doctor` (health checks + guided repairs)"
read_when:
- You have connectivity/auth issues and want guided fixes
- You updated and want a sanity check
---
# `clawdbot doctor`
Health checks + quick fixes for the gateway and channels.
Related:
- Troubleshooting: [Troubleshooting](/gateway/troubleshooting)
- Security audit: [Security](/gateway/security)
## Examples
```bash
clawdbot doctor
clawdbot doctor --repair
clawdbot doctor --deep
```

15
docs/cli/health.md Normal file
View File

@@ -0,0 +1,15 @@
---
summary: "CLI reference for `clawdbot health` (gateway health endpoint via RPC)"
read_when:
- You want to quickly check the running Gateways health
---
# `clawdbot health`
Fetch health from the running Gateway.
```bash
clawdbot health
clawdbot health --json
```

22
docs/cli/hooks.md Normal file
View File

@@ -0,0 +1,22 @@
---
summary: "CLI reference for `clawdbot hooks` (Gmail Pub/Sub + webhook helpers)"
read_when:
- You want to wire Gmail Pub/Sub events into Clawdbot hooks
- You want to run the gog watch service and renew loop
---
# `clawdbot hooks`
Webhook helpers and hook-based integrations.
Related:
- Webhooks: [Webhook](/automation/webhook)
- Gmail Pub/Sub: [Gmail Pub/Sub](/automation/gmail-pubsub)
## Gmail
```bash
clawdbot hooks gmail setup --account you@example.com
clawdbot hooks gmail run
```

View File

@@ -9,6 +9,43 @@ read_when:
This page describes the current CLI behavior. If commands change, update this doc.
## Command pages
- [`setup`](/cli/setup)
- [`onboard`](/cli/onboard)
- [`configure`](/cli/configure) (alias: `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)
- [`status`](/cli/status)
- [`health`](/cli/health)
- [`sessions`](/cli/sessions)
- [`gateway`](/cli/gateway)
- [`daemon`](/cli/daemon)
- [`logs`](/cli/logs)
- [`models`](/cli/models)
- [`memory`](/cli/memory)
- [`nodes`](/cli/nodes)
- [`sandbox`](/cli/sandbox)
- [`tui`](/cli/tui)
- [`browser`](/cli/browser)
- [`wake`](/cli/wake)
- [`cron`](/cli/cron)
- [`dns`](/cli/dns)
- [`docs`](/cli/docs)
- [`hooks`](/cli/hooks)
- [`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.

23
docs/cli/logs.md Normal file
View File

@@ -0,0 +1,23 @@
---
summary: "CLI reference for `clawdbot logs` (tail gateway logs via RPC)"
read_when:
- You need to tail Gateway logs remotely (without SSH)
- You want JSON log lines for tooling
---
# `clawdbot logs`
Tail Gateway file logs over RPC (works in remote mode).
Related:
- Logging overview: [Logging](/logging)
## Examples
```bash
clawdbot logs
clawdbot logs --follow
clawdbot logs --json
clawdbot logs --limit 500
```

22
docs/cli/memory.md Normal file
View File

@@ -0,0 +1,22 @@
---
summary: "CLI reference for `clawdbot memory` (status/index/search)"
read_when:
- You want to index or search semantic memory
- Youre debugging memory availability or indexing
---
# `clawdbot memory`
Memory search tools (semantic memory status/index/search).
Related:
- Memory concept: [Memory](/concepts/memory)
## Examples
```bash
clawdbot memory status
clawdbot memory index
clawdbot memory search "release checklist"
```

39
docs/cli/models.md Normal file
View File

@@ -0,0 +1,39 @@
---
summary: "CLI reference for `clawdbot models` (status/list/set/scan, aliases, fallbacks, auth)"
read_when:
- You want to change default models or view provider auth status
- You want to scan available models/providers and debug auth profiles
---
# `clawdbot models`
Model discovery, scanning, and configuration (default model, fallbacks, auth profiles).
Related:
- Providers + models: [Models](/providers/models)
- Provider auth setup: [Getting started](/start/getting-started)
## Common commands
```bash
clawdbot models status
clawdbot models list
clawdbot models set <model-or-alias>
clawdbot models scan
```
## Aliases + fallbacks
```bash
clawdbot models aliases list
clawdbot models fallbacks list
```
## Auth profiles
```bash
clawdbot models auth add
clawdbot models auth setup-token
clawdbot models auth paste-token
```

32
docs/cli/nodes.md Normal file
View File

@@ -0,0 +1,32 @@
---
summary: "CLI reference for `clawdbot nodes` (list/status/approve/invoke, camera/canvas/screen)"
read_when:
- Youre managing paired nodes (cameras, screen, canvas)
- You need to approve requests or invoke node commands
---
# `clawdbot nodes`
Manage paired nodes (devices) and invoke node capabilities.
Related:
- Nodes overview: [Nodes](/nodes)
- Camera: [Camera nodes](/nodes/camera)
- Images: [Image nodes](/nodes/images)
## Common commands
```bash
clawdbot nodes list
clawdbot nodes pending
clawdbot nodes approve <requestId>
clawdbot nodes status
```
## Invoke / run
```bash
clawdbot nodes invoke --node <id|name|ip> --command <command> --params <json>
clawdbot nodes run --node <id|name|ip> <command...>
```

21
docs/cli/onboard.md Normal file
View File

@@ -0,0 +1,21 @@
---
summary: "CLI reference for `clawdbot onboard` (interactive onboarding wizard)"
read_when:
- You want guided setup for gateway, workspace, auth, channels, and skills
---
# `clawdbot onboard`
Interactive onboarding wizard (local or remote Gateway setup).
Related:
- Wizard guide: [Onboarding](/start/onboarding)
## Examples
```bash
clawdbot onboard
clawdbot onboard --flow quickstart
clawdbot onboard --mode remote --remote-url ws://gateway-host:18789
```

20
docs/cli/pairing.md Normal file
View File

@@ -0,0 +1,20 @@
---
summary: "CLI reference for `clawdbot pairing` (approve/list pairing requests)"
read_when:
- Youre using pairing-mode DMs and need to approve senders
---
# `clawdbot pairing`
Approve or inspect DM pairing requests (for channels that support pairing).
Related:
- Pairing flow: [Pairing](/start/pairing)
## Commands
```bash
clawdbot pairing list whatsapp
clawdbot pairing approve whatsapp <code> --notify
```

33
docs/cli/plugins.md Normal file
View File

@@ -0,0 +1,33 @@
---
summary: "CLI reference for `clawdbot plugins` (list, install, enable/disable, doctor)"
read_when:
- You want to install or manage in-process Gateway plugins
- You want to debug plugin load failures
---
# `clawdbot plugins`
Manage Gateway plugins/extensions (loaded in-process).
Related:
- Plugin system: [Plugins](/plugin)
- Security hardening: [Security](/gateway/security)
## Commands
```bash
clawdbot plugins list
clawdbot plugins info <id>
clawdbot plugins enable <id>
clawdbot plugins disable <id>
clawdbot plugins doctor
```
### Install
```bash
clawdbot plugins install <npm-spec>
```
Security note: treat plugin installs like running code. Prefer pinned versions.

17
docs/cli/reset.md Normal file
View File

@@ -0,0 +1,17 @@
---
summary: "CLI reference for `clawdbot reset` (reset local state/config)"
read_when:
- You want to wipe local state while keeping the CLI installed
- You want a dry-run of what would be removed
---
# `clawdbot reset`
Reset local config/state (keeps the CLI installed).
```bash
clawdbot reset
clawdbot reset --dry-run
clawdbot reset --scope config+creds+sessions --yes --non-interactive
```

22
docs/cli/security.md Normal file
View File

@@ -0,0 +1,22 @@
---
summary: "CLI reference for `clawdbot security` (audit and fix common security footguns)"
read_when:
- You want to run a quick security audit on config/state
- You want to apply safe “fix” suggestions (chmod, tighten defaults)
---
# `clawdbot security`
Security tools (audit + optional fixes).
Related:
- Security guide: [Security](/gateway/security)
## Audit
```bash
clawdbot security audit
clawdbot security audit --deep
clawdbot security audit --fix
```

16
docs/cli/sessions.md Normal file
View File

@@ -0,0 +1,16 @@
---
summary: "CLI reference for `clawdbot sessions` (list stored sessions + usage)"
read_when:
- You want to list stored sessions and see recent activity
---
# `clawdbot sessions`
List stored conversation sessions.
```bash
clawdbot sessions
clawdbot sessions --active 120
clawdbot sessions --json
```

28
docs/cli/setup.md Normal file
View File

@@ -0,0 +1,28 @@
---
summary: "CLI reference for `clawdbot setup` (initialize config + workspace)"
read_when:
- Youre doing first-run setup without the full onboarding wizard
- You want to set the default workspace path
---
# `clawdbot setup`
Initialize `~/.clawdbot/clawdbot.json` and the agent workspace.
Related:
- Getting started: [Getting started](/start/getting-started)
- Wizard: [Onboarding](/start/onboarding)
## Examples
```bash
clawdbot setup
clawdbot setup --workspace ~/clawd
```
To run the wizard via setup:
```bash
clawdbot setup --wizard
```

25
docs/cli/skills.md Normal file
View File

@@ -0,0 +1,25 @@
---
summary: "CLI reference for `clawdbot skills` (list/info/check) and skill eligibility"
read_when:
- You want to see which skills are available and ready to run
- You want to debug missing binaries/env/config for skills
---
# `clawdbot skills`
Inspect skills (bundled + workspace + managed overrides) and see whats eligible vs missing requirements.
Related:
- Skills system: [Skills](/tools/skills)
- Skills config: [Skills config](/tools/skills-config)
- ClawdHub installs: [ClawdHub](/tools/clawdhub)
## Commands
```bash
clawdbot skills list
clawdbot skills list --eligible
clawdbot skills info <name>
clawdbot skills check
```

18
docs/cli/status.md Normal file
View File

@@ -0,0 +1,18 @@
---
summary: "CLI reference for `clawdbot status` (diagnostics, probes, usage snapshots)"
read_when:
- You want a quick diagnosis of channel health + recent session recipients
- You want a pasteable “all” status for debugging
---
# `clawdbot status`
Diagnostics for channels + sessions.
```bash
clawdbot status
clawdbot status --all
clawdbot status --deep
clawdbot status --usage
```

22
docs/cli/tui.md Normal file
View File

@@ -0,0 +1,22 @@
---
summary: "CLI reference for `clawdbot tui` (terminal UI connected to the Gateway)"
read_when:
- You want a terminal UI for the Gateway (remote-friendly)
- You want to pass url/token/session from scripts
---
# `clawdbot tui`
Open the terminal UI connected to the Gateway.
Related:
- TUI guide: [TUI](/tui)
## Examples
```bash
clawdbot tui
clawdbot tui --url ws://127.0.0.1:18789 --token <token>
clawdbot tui --session main --deliver
```

17
docs/cli/uninstall.md Normal file
View File

@@ -0,0 +1,17 @@
---
summary: "CLI reference for `clawdbot uninstall` (remove gateway service + local data)"
read_when:
- You want to remove the gateway service and/or local state
- You want a dry-run first
---
# `clawdbot uninstall`
Uninstall the gateway service + local data (CLI remains).
```bash
clawdbot uninstall
clawdbot uninstall --all --yes
clawdbot uninstall --dry-run
```

33
docs/cli/voicecall.md Normal file
View File

@@ -0,0 +1,33 @@
---
summary: "CLI reference for `clawdbot voicecall` (voice-call plugin command surface)"
read_when:
- You use the voice-call plugin and want the CLI entry points
- You want quick examples for `voicecall call|continue|status|tail|expose`
---
# `clawdbot voicecall`
`voicecall` is a plugin-provided command. It only appears if the voice-call plugin is installed and enabled.
Primary doc:
- Voice-call plugin: [Voice Call](/plugins/voice-call)
## Common commands
```bash
clawdbot voicecall status --call-id <id>
clawdbot voicecall call --to "+15555550123" --message "Hello" --mode notify
clawdbot voicecall continue --call-id <id> --message "Any questions?"
clawdbot voicecall end --call-id <id>
```
## Exposing webhooks (Tailscale)
```bash
clawdbot voicecall expose --mode serve
clawdbot voicecall expose --mode funnel
clawdbot voicecall unexpose
```
Security note: only expose the webhook endpoint to networks you trust. Prefer Tailscale Serve over Funnel when possible.

35
docs/cli/wake.md Normal file
View File

@@ -0,0 +1,35 @@
---
summary: "CLI reference for `clawdbot wake` (enqueue a system event and optionally trigger an immediate heartbeat)"
read_when:
- You want to “poke” a running Gateway to process a system event
- You use `wake` with cron jobs or remote nodes
---
# `clawdbot wake`
Enqueue a system event on the Gateway and optionally trigger an immediate heartbeat.
This is a lightweight “poke” for automation flows where you dont want to run a full command, but you do want the Gateway to react quickly.
Related:
- Cron jobs: [Cron](/cli/cron)
- Gateway heartbeat: [Heartbeat](/gateway/heartbeat)
## Common commands
```bash
clawdbot wake --text "sync"
clawdbot wake --text "sync" --mode now
```
## Flags
- `--text <text>`: system event text.
- `--mode <mode>`: `now` or `next-heartbeat` (default).
- `--json`: machine-readable output.
## Notes
- Requires a running Gateway reachable by your current config (local or remote).
- If youre using sandboxing, `wake` still targets the Gateway; sandboxing does not block the command itself.