Skip to Content
kusaw docsv1.0.0
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

CommandDescription
newCreate and register a factory
registerRegister an existing kusaw.yaml
listList registered factories
useSet the default factory
forgetRemove a factory from the registry without deleting its files

Run

CommandDescription
upStart serve and ui and keep them running
downStop the factory supervisor and its serve and ui children
serveRun the worker loop and the Monitor until Ctrl-C
uiRun the Dashboard server on 127.0.0.1
intakeRun the intake steps in this terminal, then queue the spec
triageGroup and assess idea files before intake
addCheck the spec structurally and queue it

Inspect

CommandDescription
statusShow queue state, Monitor state, the active run, and recent runs
runsShow a run and its attempt provenance
sandboxCheck the OS sandbox backend on this machine
provenanceCompare attempt provenance records
logsPrint supervisor, serve, and ui logs
metricsShow run metrics over a date range
outcomesList outcome labels for delivered commits
improveList and decide improvement proposals
capabilitiesList and approve repo-scoped capabilities
scorersList scorers and their calibration
budgetShow or set the machine-wide usage budget
glossaryList glossary terms, or print one entry
workflowsList workflows, the default, and routing rules
routingTest routing rules without adding a task

Control

CommandDescription
pausePause the queue; the active run continues and no new run starts
resumeUnpause the queue, or rerun failed repos with --failed-only
stopStop one run, or with --all stop every running run and pause the queue
approveApprove a waiting gate
rejectReject a waiting gate; the note is feedback
requeueStart a new run from that run's branch. The note is optional.
noteSend a note to a running run without stopping it
restartRerun every repo of a finished run from its base commits
dismissRemove the worktree of a needs_attention or taken-over run and keep the branch
routeRoute a waiting task to a workflow, or classify without setting

Configure

CommandDescription
configChange kusaw.yaml
schemaPrint the JSON Schema for kusaw.yaml
validateValidate kusaw.yaml and handshake every listed step
telemetryShow and control opt-in metadata telemetry

Tools

CommandDescription
stepRun a built-in step
mcpServe Kusaw tools over stdio for Claude Code and Cursor
benchCapture a run and replay it as a benchmark
repo-runRun a command under a repo's command environment
agent-argsPrint or run the agent argv the built-ins use
claude-argsPrint or run the Claude Code argv the built-ins use
extractResume a session and print a validated JSON block
git-envPrint trusted GIT_CONFIG_* entries for a custom step
safepathCheck whether paths stay inside a root
promptHelpers for assembling step prompts
worktreesPrune old run worktrees and stale locks
updateCheck for a new kusaw, confirm, download, and verify it
rollbackRestore the previous kusaw version and the last update's backup
versionPrint version, commit, build date, Go version, and protocol versions

Other

CommandDescription
atlasBuild and inspect the local code index
candidatesList a run's best-of-N candidates, including compare-only stages
completionGenerate the autocompletion script for the specified shell
connectorList, check, and call factory connectors
docsShow document-store context a step would get
effectsList a run's effects, or apply or reject held ones
evidenceList a run's evidence files, or open one
helpHelp about any command
orderList, show, check, and control Work orders
portsList machine-wide port leases
reportingShow and control first-party anonymous usage and error reports
runCheck the spec structurally and queue it
scorecardsSummarise attempt scorecards across runs, including compare-only stages
serviceStart the factory at login (systemd, launchd, or Task Scheduler)
servicesList a run's declared services, or tail or restart one
signingUnlock the signing key for factory deliveries
subtasksList a run's plan subtasks

On this page