-
-
Notifications
You must be signed in to change notification settings - Fork 140
CLI Reference
All commands are accessed via the openswarm binary.
openswarm
Launches the TUI chat interface. Equivalent to openswarm chat --tui.
Run a task through the agent pipeline. No config.yaml needed.
openswarm run "Fix the bug in auth.ts" -p ~/dev/my-project openswarm run "Add unit tests" --pipeline --model claude-sonnet-4-20250514
| Option | Description | Default |
|---|---|---|
-p, --path <path> |
Project path | cwd |
-m, --model <model> |
Model override | adapter default |
--pipeline |
Full pipeline (Worker + Reviewer) | off |
--worker-only |
Worker only, skip review | off |
--max-iterations <n> |
Max Worker↔Reviewer iterations | 3 |
-v, --verbose |
Verbose output | off |
Start an interactive chat session.
openswarm chat # New session (TUI mode) openswarm chat my-session # Resume named session openswarm chat --tui # Force TUI mode (default)
Sessions are persisted at ~/.openswarm/chat/<session-id>.json.
Execute a task via the daemon. Auto-starts daemon if not running.
openswarm exec "Run tests and fix failures" --local --pipeline openswarm exec "Refactor auth module" --path ~/dev/project --timeout 300
| Option | Description | Default |
|---|---|---|
--path <path> |
Project path | cwd |
--timeout <seconds> |
Timeout | 600 |
--no-auto-start |
Don't auto-start daemon | off |
--local |
Execute locally (no daemon) | off |
--pipeline |
Full pipeline | off |
--worker-only |
Worker only | off |
-m, --model <model> |
Model override | — |
-v, --verbose |
Verbose output | off |
Exit codes: 0 success · 1 failure · 2 timeout
Start the full daemon. Requires config.yaml with Discord and Linear configuration.
openswarm start
See Configuration for the config file format.
npm run service:install # Build + install launchd service npm run service:start # Start npm run service:stop # Stop npm run service:restart # Restart npm run service:status # Status + recent logs npm run service:logs # stdout (follow mode) npm run service:errors # stderr (follow mode) npm run service:uninstall # Uninstall
Generate a sample config.yaml in the current directory.
openswarm init
openswarm init --force # Overwrite existing configValidate config.yaml structure and values using Zod schemas.
openswarm validate
Open the web dashboard in a browser.
openswarm dash # Open on port 3847 openswarm dash -p 8080 # Custom port openswarm dash --no-open # Start server without opening browser
The dashboard shows: pipeline stages, cost tracking, worktree status, and live logs.
Code Registry inspection and BS Detector.
# File inspection openswarm check src/foo.ts # File brief (entities, tests, risk) openswarm check --stats # Registry statistics openswarm check --high-risk # High-risk entities (untested + complex) openswarm check --untested # Untested entities openswarm check --deprecated # Deprecated entities openswarm check --search "funcName" # Full-text search (FTS5) openswarm check --tag "needs-refactor" # Filter by tag # Scanning openswarm check --scan # Scan repo → register all entities openswarm check --scan -v # Verbose scan # BS Detector openswarm check --bs # Scan for bad code patterns # CI/CD mode openswarm check --ci # JSON output, exit 1 on critical issues openswarm check --tree [dir] # Directory tree with entity counts + risk # Scoping openswarm check --project <id> # Scope to specific project
See Code Registry for details.
Annotate a code entity in the registry.
openswarm annotate "MyClass" --deprecate "Use NewClass instead" openswarm annotate "myFunc" --tag "needs-refactor" openswarm annotate "myFunc" --untag "needs-refactor" openswarm annotate "myFunc" --status active openswarm annotate "myFunc" --note "Handles edge case for empty input" openswarm annotate "myFunc" --risk high openswarm annotate "myFunc" --warn "security: SQL injection risk"
OAuth authentication for the GPT adapter.
openswarm auth login --provider gpt # OAuth PKCE login openswarm auth status # Show stored auth profiles openswarm auth logout --provider gpt # Remove stored tokens
Getting Started
Reference
Deep Dive
Help