Docs
The documentation lives in the repository. This site does not copy it, so there is one source of truth.
Read these
- README: install, quick start, how it works, Slack and Discord setup, known limits.
- SECURITY.md: the full security model, with the limits of each control.
- CHANGELOG.md: what changed in each alpha.
- demo/README.md: what the offline demo shows and does not show.
- LICENSE (Apache-2.0) and NOTICE.
Commands
This list is taken from src/cli.ts and the bin entries in package.json at version 2.0.0-alpha.5 (the repository, not yet on npm). The published 2.0.0-alpha.3 does not have the Slack and Discord commands. Run starclaw --help for the authoritative list on your install.
Most commands also accept --policy, --state-dir, --workspace, --sandbox auto|container|process and --require-container.
| Command | What it does |
|---|---|
starclaw run <goal> | Run one goal and exit. Options: --non-interactive (nothing is approved, so everything the policy does not auto-allow is denied), --json. |
starclaw | Interactive session (the default). In-session commands: /new (fresh session, clears taint), /status, exit. |
starclaw policy init [file] | Write the conservative default policy (default file starclaw.policy.json). Refuses to overwrite. |
starclaw policy check [file] | Validate a policy file. Exit code 1 if invalid. |
starclaw doctor | Probe the isolation layers on this machine and report what is blocked, which layer is active and why. Also reports model, search, browser and channel configuration (names and set / NOT set only). |
starclaw audit verify <file> | Check an audit log offline: hash chain, signatures and head checkpoint. Options: --pubkey, --pubkey-file, --allow-missing-head, --json. Pin the public key; without it the key inside the log is trusted. |
starclaw sandbox build | status | clean | Build the Docker sandbox image, show Docker and image state, or remove leftover sandbox containers (only those labelled starclaw.sandbox=1). |
starclaw shell build | status | clean | Same three actions for the governed shell container used by tools.shell. |
starclaw schedule add | list | remove | pause | resume | Manage unattended jobs. add <name> <schedule> <goal> takes a 5-field cron expression or @every 30m; options --heartbeat and --notify. Jobs run only while the daemon runs. |
starclaw daemon | Long-running process: Telegram gateway, Slack and Discord webhook channels when enabled in the policy, and the scheduler. --no-telegram runs without Telegram. |
starclaw slack status | Check the Slack policy block and environment. Prints variable names and set / NOT set, never values. |
starclaw discord status | Same check for Discord. |
starclaw discord register [--guild <id>] | Register the /starclaw slash command with Discord, globally or in one server. |
starclaw-telegram | Telegram front end. Needs TELEGRAM_BOT_TOKEN and a numeric TELEGRAM_OWNER_ID; fails closed without them. |
starclaw-server | HTTP API and small web console on 127.0.0.1:3000. Needs STARCLAW_API_KEY (16+ characters). No TLS. |
Development
npm run build && npm test && npm run typecheck
The tests use a fake model and a fake payment rail. Nothing in the suite calls a real provider.