Reference

Reference is the exact-surface section: the command-line interface, every configuration key, and the HTTP API the gateway serves. Use it when you know what you want to do and need the precise name of the thing that does it — a guide will not list every flag, and this section will not explain when to reach for one.

The API

PersonalClaw’s gateway is a real HTTP service, not only a dashboard backend. It serves a REST API under /api/* on the dashboard port, a WebSocket at /api/ws for chat streaming and event fan-out, and MCP: PersonalClaw consumes MCP servers, and can expose a read-only MCP endpoint of its own, which is off until you turn it on. API overview is the orientation, covering what every route shares: base URL, auth, the error envelope and its conventions.

The route list is the HTTP route reference, and it is generated rather than written: core renders it from the gateway’s own route registrations and fails its CI when the page and the code disagree. Each row carries the first line of the handler’s docstring, and core names that docstring, not any prose, as the authoritative contract for a route. So read the handler when a field matters, and if you are automating against this API, read it out of the release you are running rather than out of a page you cached.

The CLI reference covers the same system from the other side. Most of what the API does has a command, and for one-off work the command is usually the shorter path.

These pages are core’s text, published from the release this site was built from — see release provenance for which one. Corrections land in core, not here.

The reference pages

• Config reference — operator knobs (~/.personalclaw/config.json) — Most settings live in the dashboard (Settings → …).
• API overview — The gateway serves a REST + WebSocket API on the dashboard port (default 10000).
• HTTP route reference — Every HTTP route the gateway registers: 930 registrations over 755 distinct paths — 923 agent-callable (/api/, non-websocket) and 7 websocket or internal.
• CLI reference — The personalclaw command is the single entry point (installed by pip install -e . via the personalclaw console script; source: src/personalclaw/cli.py).
• Configuration reference — PersonalClaw’s core configuration lives in one JSON file: ~/.personalclaw/config.json (the directory can be relocated with the PERSONALCLAW_HOME environment variable).
• SKILL.md format reference — PersonalClaw reads the same SKILL.md files the wider agent-skill ecosystem writes.