129 lines
3.7 KiB
Markdown
129 lines
3.7 KiB
Markdown
# ZeroClaw Commands Reference
|
|
|
|
This reference is derived from the current CLI surface (`zeroclaw --help`).
|
|
|
|
Last verified: **February 18, 2026**.
|
|
|
|
## Top-Level Commands
|
|
|
|
| Command | Purpose |
|
|
|---|---|
|
|
| `onboard` | Initialize workspace/config quickly or interactively |
|
|
| `agent` | Run interactive chat or single-message mode |
|
|
| `gateway` | Start webhook and WhatsApp HTTP gateway |
|
|
| `daemon` | Start supervised runtime (gateway + channels + optional heartbeat/scheduler) |
|
|
| `service` | Manage user-level OS service lifecycle |
|
|
| `doctor` | Run diagnostics and freshness checks |
|
|
| `status` | Print current configuration and system summary |
|
|
| `cron` | Manage scheduled tasks |
|
|
| `models` | Refresh provider model catalogs |
|
|
| `providers` | List provider IDs, aliases, and active provider |
|
|
| `channel` | Manage channels and channel health checks |
|
|
| `integrations` | Inspect integration details |
|
|
| `skills` | List/install/remove skills |
|
|
| `migrate` | Import from external runtimes (currently OpenClaw) |
|
|
| `hardware` | Discover and introspect USB hardware |
|
|
| `peripheral` | Configure and flash peripherals |
|
|
|
|
## Command Groups
|
|
|
|
### `onboard`
|
|
|
|
- `zeroclaw onboard`
|
|
- `zeroclaw onboard --interactive`
|
|
- `zeroclaw onboard --channels-only`
|
|
- `zeroclaw onboard --api-key <KEY> --provider <ID> --memory <sqlite|lucid|markdown|none>`
|
|
|
|
### `agent`
|
|
|
|
- `zeroclaw agent`
|
|
- `zeroclaw agent -m "Hello"`
|
|
- `zeroclaw agent --provider <ID> --model <MODEL> --temperature <0.0-2.0>`
|
|
- `zeroclaw agent --peripheral <board:path>`
|
|
|
|
### `gateway` / `daemon`
|
|
|
|
- `zeroclaw gateway [--host <HOST>] [--port <PORT>]`
|
|
- `zeroclaw daemon [--host <HOST>] [--port <PORT>]`
|
|
|
|
### `service`
|
|
|
|
- `zeroclaw service install`
|
|
- `zeroclaw service start`
|
|
- `zeroclaw service stop`
|
|
- `zeroclaw service status`
|
|
- `zeroclaw service uninstall`
|
|
|
|
### `cron`
|
|
|
|
- `zeroclaw cron list`
|
|
- `zeroclaw cron add <expr> [--tz <IANA_TZ>] <command>`
|
|
- `zeroclaw cron add-at <rfc3339_timestamp> <command>`
|
|
- `zeroclaw cron add-every <every_ms> <command>`
|
|
- `zeroclaw cron once <delay> <command>`
|
|
- `zeroclaw cron remove <id>`
|
|
- `zeroclaw cron pause <id>`
|
|
- `zeroclaw cron resume <id>`
|
|
|
|
### `models`
|
|
|
|
- `zeroclaw models refresh`
|
|
- `zeroclaw models refresh --provider <ID>`
|
|
- `zeroclaw models refresh --force`
|
|
|
|
`models refresh` currently supports live catalog refresh for provider IDs: `openrouter`, `openai`, `anthropic`, `groq`, `mistral`, `deepseek`, `xai`, `together-ai`, `gemini`, `ollama`, `astrai`, `venice`, `fireworks`, `cohere`, `moonshot`, `glm`, `zai`, `qwen`, and `nvidia`.
|
|
|
|
### `channel`
|
|
|
|
- `zeroclaw channel list`
|
|
- `zeroclaw channel start`
|
|
- `zeroclaw channel doctor`
|
|
- `zeroclaw channel bind-telegram <IDENTITY>`
|
|
- `zeroclaw channel add <type> <json>`
|
|
- `zeroclaw channel remove <name>`
|
|
|
|
Runtime in-chat commands (Telegram/Discord while channel server is running):
|
|
|
|
- `/models`
|
|
- `/models <provider>`
|
|
- `/model`
|
|
- `/model <model-id>`
|
|
|
|
`add/remove` currently route you back to managed setup/manual config paths (not full declarative mutators yet).
|
|
|
|
### `integrations`
|
|
|
|
- `zeroclaw integrations info <name>`
|
|
|
|
### `skills`
|
|
|
|
- `zeroclaw skills list`
|
|
- `zeroclaw skills install <source>`
|
|
- `zeroclaw skills remove <name>`
|
|
|
|
### `migrate`
|
|
|
|
- `zeroclaw migrate openclaw [--source <path>] [--dry-run]`
|
|
|
|
### `hardware`
|
|
|
|
- `zeroclaw hardware discover`
|
|
- `zeroclaw hardware introspect <path>`
|
|
- `zeroclaw hardware info [--chip <chip_name>]`
|
|
|
|
### `peripheral`
|
|
|
|
- `zeroclaw peripheral list`
|
|
- `zeroclaw peripheral add <board> <path>`
|
|
- `zeroclaw peripheral flash [--port <serial_port>]`
|
|
- `zeroclaw peripheral setup-uno-q [--host <ip_or_host>]`
|
|
- `zeroclaw peripheral flash-nucleo`
|
|
|
|
## Validation Tip
|
|
|
|
To verify docs against your current binary quickly:
|
|
|
|
```bash
|
|
zeroclaw --help
|
|
zeroclaw <command> --help
|
|
```
|