# Zeroclaw > Help users operate and interact with their ZeroClaw agent instance — through both the CLI (`zeroclaw` commands) and the REST/WebSocket gateway API. Use this skill whenever the user wants to: send messages to ZeroClaw, manage memory or cron jobs, check system status, configure channels or providers, hit the gateway API, troubleshoot their ZeroClaw setup, build from source, or do anything involving the `zeroclaw` binary or its HTTP endpoints. Trigger this even if the user just says things like 'check my agent status', 'schedule a reminder', 'store this in memory', 'list my cron jobs', 'send a message to my bot', 'set up Telegram', 'build zeroclaw', or 'my bot is broken' — these are all ZeroClaw operations. - Skill: `zeroclaw-labs/zeroclaw` (Agent Skill, multi-file: 4 files) - Install (CLI): `npx skillmds@latest add zeroclaw-labs/zeroclaw` - Raw SKILL.md: https://api.skillmd.com/api/skills/zeroclaw-labs/zeroclaw/raw - Safety review: pending - Works with: Claude Code, Claude.ai, OpenAI Codex - Category: AI & ML - Author: zeroclaw-labs (https://skillmd.com/u/zeroclaw-labs) - Updated: 2026-09-10 - Page: https://skillmd.com/skills/zeroclaw-labs/zeroclaw --- # ZeroClaw Skill You are helping a user operate their ZeroClaw agent instance. ZeroClaw is an autonomous agent runtime with a CLI and an HTTP/WebSocket gateway. Your job is to understand what the user wants to accomplish and then **execute it** — run the command, make the API call, report the result. Do not just show commands for the user to copy-paste. Actually run them via the Bash tool and tell the user what happened. The only exception is destructive operations (clearing all memory, estop kill-all) where you should confirm first. ## Adaptive Expertise Pay attention to how the user talks. Someone who says "can you hit the webhook endpoint with a POST" is telling you they know what they're doing — be concise, skip explanations, just execute. Someone who says "how do I make my bot remember things" needs more context about what's happening under the hood. Signals of technical comfort: mentions specific endpoints, HTTP methods, JSON fields, talks about tokens/auth, uses CLI flags fluently, references config files directly. Signals of less familiarity: asks "what does X do", uses casual language about the bot/agent, describes goals rather than mechanisms ("I want it to check something every morning"). Default to a middle ground — brief explanation of what you're about to do, then do it. Dial up or down from there based on cues. ## Discovery — Before You Act Before running any ZeroClaw operation, make sure you know where things are: 1. **Find the binary.** Search in this order: - `which zeroclaw` (PATH) - The current project's build output: `./target/release/zeroclaw` or `./target/debug/zeroclaw` — this is the right choice when the user is working inside the ZeroClaw source tree and may have local changes - Common install locations: `~/.cargo/bin/zeroclaw`, `~/Downloads/zeroclaw-bin/zeroclaw` If no binary is found anywhere, offer to build from source (see "Building from Source" below). If the user is a developer working on ZeroClaw itself, they'll likely want the local build — watch for cues like them editing source files, mentioning PRs, or being in the project directory. 2. **Check if the gateway is running** (only needed for REST/WebSocket operations). A quick `curl -sf http://127.0.0.1:42617/health` tells you. If it's not running and the user wants REST access, let them know and offer to start it (`zeroclaw gateway` or `zeroclaw daemon`). 3. **Check auth status.** If the gateway requires pairing (`require_pairing = true` is the default), REST calls need a bearer token. Run `zeroclaw status` to see the current state, or check `~/.zeroclaw/config.toml` for a stored token under `[gateway]`. 4. **Discover the agent alias.** Every `zeroclaw agent` invocation requires `-a ` — there is no default agent. Read `~/.zeroclaw/config.toml` and find the `[agents.]` headers; that `` is what the user means when they say "my agent." If multiple agents exist, ask the user which one to target before invoking. The examples below use `` as a placeholder for the alias you discovered. Cache these findings for the conversation — don't re-discover every time. ## Important: REPL Limitation `zeroclaw agent -a ` (interactive REPL) requires interactive stdin, which doesn't work through the Bash tool. When the user wants to chat with their agent, use single-message mode instead: ```bash zeroclaw agent -a -m "the message" ``` Each `-m` invocation is independent (no conversation history between calls). If the user needs multi-turn conversation, let them know they can run `zeroclaw agent -a ` directly in their terminal, or use the WebSocket endpoint for programmatic streaming. ## First-Time Setup If the user hasn't set up ZeroClaw yet (no `~/.zeroclaw/config.toml` exists), guide them through quickstart: ```bash zeroclaw quickstart # Interactive — picks a provider + agent zeroclaw quickstart --model-provider ollama --model qwen2.5:7b # Non-interactive zeroclaw config set channels..= # Configure a channel after quickstart ``` After quickstart, verify everything works: ```bash zeroclaw status zeroclaw doctor ``` If they already have a config but a channel is broken, edit just that channel's fields with `zeroclaw config set channels..=` rather than re-running quickstart (quickstart leaves an existing config alone). ## Building from Source If the user wants to build ZeroClaw (or no binary is installed): ```bash cargo build --release ``` This produces `target/release/zeroclaw`. For faster iteration during development, `cargo build` (debug mode) is quicker but produces a slower binary at `target/debug/zeroclaw`. You can also run directly without a separate build step: ```bash cargo run --release -- [args] ``` Before building, `cargo check` gives a quick compile validation without the full build. ## Choosing CLI vs REST Both surfaces can do most things. Rules of thumb: - **CLI is simpler** for one-off operations from the terminal. It handles auth internally and formats output nicely. Prefer CLI when the user is working locally. - **REST is needed** when the user is building an integration, scripting from another language, or accessing a remote ZeroClaw instance. Also needed for streaming (WebSocket, SSE). - If unclear, **default to CLI** — it's less setup. ## Core Operations ### Sending Messages **CLI:** `zeroclaw agent -a -m "your message here"` — always use `-m` mode (not bare `zeroclaw agent -a `) so it returns instead of blocking on the REPL. **REST:** ```bash curl -X POST http://127.0.0.1:42617/webhook \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{"message": "your message here"}' ``` Response: `{"response": "...", "model": "..."}` **WebSocket** (for streaming): connect to `ws://127.0.0.1:42617/ws/chat?token=`, send `{"type": "message", "content": "..."}`, receive `{"type": "done", "full_response": "..."}`. ### System Status Run `zeroclaw status` to see provider, model, uptime, channels, memory backend. For deeper diagnostics: `zeroclaw doctor`. **REST:** `GET /api/status` (same info as JSON), `GET /health` (no auth, quick ok/not-ok). ### Memory The CLI can list, get, and clear memories but **cannot store** them directly. To store a memory: - Via agent: `zeroclaw agent -a -m "remember that my favorite color is blue"` - Via REST: `POST /api/memory` with `{"key": "...", "content": "...", "category": "core"}` **CLI (read/delete):** - `zeroclaw memory list` — list all entries - `zeroclaw memory list --category core --limit 10` — filtered - `zeroclaw memory get "key-name"` — get specific entry - `zeroclaw memory stats` — usage statistics - `zeroclaw memory clear --key "prefix" --yes` — delete entries (confirm with user first) **REST (full CRUD):** - `GET /api/memory` — list all (optional: `?query=search+text&category=core`) - `POST /api/memory` — store: `{"key": "...", "content": "...", "category": "core"}` - `DELETE /api/memory/{key}` — delete entry Categories: `core`, `daily`, `conversation`, or any custom string. ### Cron / Scheduling **CLI:** - `zeroclaw cron list` — show all jobs - `zeroclaw cron add '0 9 * * 1-5' 'Good morning' --tz America/New_York` — recurring - `zeroclaw cron add-at '2026-03-11T10:00:00Z' 'Remind me'` — one-time at specific time - `zeroclaw cron add-every 3600000 'Check health'` — interval in ms - `zeroclaw cron once 30m 'Follow up'` — delay from now - `zeroclaw cron pause ` / `zeroclaw cron resume ` / `zeroclaw cron remove ` **REST:** - `GET /api/cron` — list jobs - `POST /api/cron` — add: `{"name": "...", "schedule": "0 9 * * *", "command": "..."}` - `DELETE /api/cron/{id}` — remove job ### Tools Tools are used automatically by the agent during conversations (shell, file ops, memory, browser, HTTP, web search, git, etc. — 30+ tools gated by security policy). To see what's available: `GET /api/tools` (REST) lists all registered tools with descriptions and parameter schemas. ### Configuration Edit `~/.zeroclaw/config.toml` directly, use `zeroclaw config set =` for one field at a time, or delete `~/.zeroclaw/` and re-run `zeroclaw quickstart` for a fresh setup. **REST:** - `GET /api/config`: compatibility whole-config read (secrets masked as `***MASKED***`) - `PATCH /api/config`: atomically update config with an RFC 6902 JSON Patch document - `OPTIONS /api/config`: get the whole-config JSON Schema; its current `Allow` header still lists legacy `PUT`, which the router does not register ### Providers & Models - `zeroclaw providers` — list all supported providers - `zeroclaw models list` — cached model catalog - `zeroclaw models refresh --all` — refresh from providers - `zeroclaw models set anthropic/claude-sonnet-4-6` — set default model Override per-message: `zeroclaw agent -a -p anthropic --model claude-sonnet-4-6 -m "hello"` ### Real-Time Events (SSE) REST only — useful for building dashboards or monitoring: ```bash curl -N -H "Authorization: Bearer " http://127.0.0.1:42617/api/events ``` Streams JSON events: `llm_request`, `tool_call_start`, `tool_call`, `agent_start`, `agent_end`, `error`. ### Cost Tracking `GET /api/cost` — returns session/daily/monthly costs, token counts, per-model breakdown. ### Emergency Stop Confirm with the user before running any estop command — these are disruptive. - `zeroclaw estop --level kill-all` — stop everything - `zeroclaw estop --level network-kill` — block all network - `zeroclaw estop --level tool-freeze --tool shell` — freeze specific tool - `zeroclaw estop status` — check current estop state - `zeroclaw estop resume --network` — resume ### Gateway Lifecycle - `zeroclaw gateway` — start HTTP gateway (foreground) - `zeroclaw gateway -p 8080 --host 127.0.0.1` — custom bind - `zeroclaw daemon` — start gateway + channels + scheduler + heartbeat - `zeroclaw service install/start/stop/status/uninstall` — OS service management ### Channels Channel availability depends on the installed build's feature set. Use `zeroclaw channels list` to inspect configured channels and `zeroclaw channels doctor` to check their health. Consult the current channel guide and generated config reference before editing `~/.zeroclaw/config.toml`; do not infer config keys from a fixed channel inventory. ### Pairing (Authentication Setup) When `require_pairing = true` (default), REST clients need a bearer token: ```bash curl -X POST http://127.0.0.1:42617/pair -H "X-Pairing-Code: " ``` Response includes `{"token": "..."}` — save this for subsequent requests. ## Common Workflows Here are multi-step sequences you're likely to need: **"Is my agent healthy?"** 1. Run `zeroclaw status` — check provider, model, channels 2. Run `zeroclaw doctor` — check connectivity, diagnose issues 3. If gateway needed: `curl -sf http://127.0.0.1:42617/health` **"Set up a new channel"** 1. Read the current config: `cat ~/.zeroclaw/config.toml` 2. Add the channel config (edit the TOML) 3. Restart: `zeroclaw service restart` (or restart daemon manually) 4. Verify: `zeroclaw channels doctor` **"Switch to a different model"** 1. Check available: `zeroclaw models list` 2. Set it: `zeroclaw models set ` 3. Verify: `zeroclaw status` 4. Test: `zeroclaw agent -a -m "hello, what model are you?"` ## Gateway Defaults - **Port:** 42617 - **Host:** 127.0.0.1 - **Auth:** Pairing required (bearer token) - **Rate limits:** 60 webhook requests/min, 10 pairing attempts/min - **Body limit:** 64KB - **Timeout:** 30 seconds - **Idempotency:** Optional `X-Idempotency-Key` header on `/webhook` (300s TTL) - **Config location:** `~/.zeroclaw/config.toml` ## Reference Files For a curated operational API reference, read `references/rest-api.md`. For precision-sensitive route work, verify the current gateway router and the documented subset exposed at `/api/openapi.json`. For common CLI commands and options, read `references/cli-reference.md`. Use `zeroclaw --help` and `zeroclaw --help` as the current command-tree authority. Only load these when you need precise details beyond what's in this file — for most operations, the quick references above are sufficient. ## Troubleshooting **"zeroclaw: command not found"** — Binary not in PATH. Check `./target/release/zeroclaw`, `~/.cargo/bin/zeroclaw`, or build from source with `cargo build --release`. **"Connection refused" on REST calls** — Gateway isn't running. Start it with `zeroclaw gateway` or `zeroclaw daemon`. **"Unauthorized" (401/403)** — Bearer token is missing or invalid. Re-pair via `POST /pair` with the pairing code, or check `~/.zeroclaw/config.toml` for the stored token. **"LLM request failed" (500)** — Provider issue. Run `zeroclaw doctor` to check connectivity. Common causes: expired API key, provider outage, rate limiting on the provider side. **"Too many requests" (429)** — You're hitting ZeroClaw's rate limit. Back off — the response includes `retry_after` with the number of seconds to wait. **Agent not using tools / acting limited** — Check autonomy settings in config.toml under `[autonomy]`. `level = "read_only"` disables most tools. Try `level = "supervised"` or `level = "full"`. **Memory not persisting** — Check `[memory]` config. If `backend = "none"`, nothing is stored. Switch to `"sqlite"` or `"markdown"`. Also verify `auto_save = true`. **Channel not responding** — Run `zeroclaw channels doctor` for the specific channel. Common issues: expired bot token, wrong allowed_users list, channel not enabled in `[channels]`. Report errors to the user with context appropriate to their expertise level. For beginners, explain what went wrong and suggest the fix. For experts, just show the error and the fix.