CLI
CLI overview
Run, resume, inspect, generate, and search past runs from one CLI.
circuit <command> [options]The circuit binary is the command-line entry point. run executes a flow
against a goal; you pass the flow id explicitly. The other commands resume,
inspect, and manage runs.
Commands
| Command | Description |
|---|---|
| run | Execute a flow against a goal. |
| resume | Resume a paused run at a checkpoint. |
| checkpoints | List runs parked at a checkpoint, waiting on a decision. |
| handoff | Save, resume, or clear a continuity record. |
| history | Index and query evidence from past runs. |
| memory | Record, list, and forget operator notes. |
| config | Read and edit the layered config. |
| create | Scaffold a custom flow from a description. |
| generate | Have a model author a custom flow from a description. |
| preview | Show connector, model, and effort per step without running anything. |
| uninstall | Remove Circuit's instruction block and print host removal commands. |
| runs | Inspect the status of a run. |
| reclaim | Remove leftover worktrees from interrupted runs. |
| version | Print the Circuit version. |
Conventions
Many commands accept --json for machine-readable output.
--progress jsonl streams progress events as they happen. jsonl is the only
supported format.
Run folders default to .circuit/runs/<run-id>. Pass --run-folder <path> to
set your own.