CLI reference
CLI reference
Every kusaw command. Hidden commands and flags are omitted.
CLI reference
Every kusaw command. Hidden commands and flags are omitted.
Factory
| Command | Description |
|---|---|
| new | Create and register a factory |
| register | Register an existing kusaw.yaml |
| list | List registered factories |
| use | Set the default factory |
| forget | Remove a factory from the registry without deleting its files |
Run
| Command | Description |
|---|---|
| up | Start serve and ui and keep them running |
| down | Stop the factory supervisor and its serve and ui children |
| serve | Run the worker loop and the Monitor until Ctrl-C |
| ui | Run the Dashboard server on 127.0.0.1 |
| intake | Run the intake steps in this terminal, then queue the spec |
| triage | Group and assess idea files before intake |
| add | Check the spec structurally and queue it |
Inspect
| Command | Description |
|---|---|
| status | Show queue state, Monitor state, the active run, and recent runs |
| runs | Show a run and its attempt provenance |
| sandbox | Check the OS sandbox backend on this machine |
| provenance | Compare attempt provenance records |
| logs | Print supervisor, serve, and ui logs |
| metrics | Show run metrics over a date range |
| outcomes | List outcome labels for delivered commits |
| improve | List and decide improvement proposals |
| capabilities | List and approve repo-scoped capabilities |
| scorers | List scorers and their calibration |
| budget | Show or set the machine-wide usage budget |
| glossary | List glossary terms, or print one entry |
| workflows | List workflows, the default, and routing rules |
| routing | Test routing rules without adding a task |
Control
| Command | Description |
|---|---|
| pause | Pause the queue; the active run continues and no new run starts |
| resume | Unpause the queue, or rerun failed repos with --failed-only |
| stop | Stop one run, or with --all stop every running run and pause the queue |
| approve | Approve a waiting gate |
| reject | Reject a waiting gate; the note is feedback |
| requeue | Start a new run from that run's branch. The note is optional. |
| note | Send a note to a running run without stopping it |
| restart | Rerun every repo of a finished run from its base commits |
| dismiss | Remove the worktree of a needs_attention or taken-over run and keep the branch |
| route | Route a waiting task to a workflow, or classify without setting |
Configure
| Command | Description |
|---|---|
| config | Change kusaw.yaml |
| schema | Print the JSON Schema for kusaw.yaml |
| validate | Validate kusaw.yaml and handshake every listed step |
| telemetry | Show and control opt-in metadata telemetry |
Tools
| Command | Description |
|---|---|
| step | Run a built-in step |
| mcp | Serve Kusaw tools over stdio for Claude Code and Cursor |
| bench | Capture a run and replay it as a benchmark |
| repo-run | Run a command under a repo's command environment |
| agent-args | Print or run the agent argv the built-ins use |
| claude-args | Print or run the Claude Code argv the built-ins use |
| extract | Resume a session and print a validated JSON block |
| git-env | Print trusted GIT_CONFIG_* entries for a custom step |
| safepath | Check whether paths stay inside a root |
| prompt | Helpers for assembling step prompts |
| worktrees | Prune old run worktrees and stale locks |
| update | Check for a new kusaw, confirm, download, and verify it |
| rollback | Restore the previous kusaw version and the last update's backup |
| version | Print version, commit, build date, Go version, and protocol versions |
Other
| Command | Description |
|---|---|
| atlas | Build and inspect the local code index |
| candidates | List a run's best-of-N candidates, including compare-only stages |
| completion | Generate the autocompletion script for the specified shell |
| connector | List, check, and call factory connectors |
| docs | Show document-store context a step would get |
| effects | List a run's effects, or apply or reject held ones |
| evidence | List a run's evidence files, or open one |
| help | Help about any command |
| order | List, show, check, and control Work orders |
| ports | List machine-wide port leases |
| reporting | Show and control first-party anonymous usage and error reports |
| run | Check the spec structurally and queue it |
| scorecards | Summarise attempt scorecards across runs, including compare-only stages |
| service | Start the factory at login (systemd, launchd, or Task Scheduler) |
| services | List a run's declared services, or tail or restart one |
| signing | Unlock the signing key for factory deliveries |
| subtasks | List a run's plan subtasks |