Commands Overview
swarm [command] [options] "<prompt>"Core Commands
Section titled “Core Commands” run Execute the full orchestration pipeline (default command).
plan Interactive planning mode — refine requirements before running.
auto Autonomous plan + run with no interaction.
task Lightweight autonomous pipeline for well-scoped tasks.
Analysis & Exploration
Section titled “Analysis & Exploration” analyze Generate a comprehensive repository context document.
brainstorm Interactive idea exploration with a strategist agent.
digest Concise highlights summary of a completed run.
Multi-Repo
Section titled “Multi-Repo” fleet Orchestrate features across multiple repositories.
Workflow Management
Section titled “Workflow Management” review Review and fix a previous run based on feedback.
prepare Generate Copilot instruction files for a repository.
session Create, list, and switch sessions (feature grouping).
finish Finalize a session — summarize and log to changelog.
list List all sessions across all repositories.
stats View agent invocation statistics.
backup & restore Sync artifacts to/from the central store.
Global Options
Section titled “Global Options”| Option | Description |
|---|---|
-v, --verbose | Enable verbose streaming output |
-e, --editor | Open interactive text editor for the prompt |
-p, --plan <file> | Use a plan file as input |
-f, --file <file> | Read prompt from a file |
-r, --resume | Resume from the last checkpoint |
--run <runId> | Specify which run to review/digest |
--session <id> | Use a specific session |
--no-tui | Disable TUI dashboard |
--auto-model | Auto-select model per task based on complexity |
--verify-build <cmd> | Shell command to verify the build |
--verify-test <cmd> | Shell command to run tests |
--verify-lint <cmd> | Shell command to run linting |
-V, --version | Show version number |
-h, --help | Show help message |
Prompt Sources
Section titled “Prompt Sources”The task description can be provided in multiple ways (first match wins):
| Source | Example |
|---|---|
--plan <file> | swarm --plan .swarm/plans/plan-latest.md |
--file <file> | swarm -f requirements.md |
--editor | swarm -e |
| Inline text | swarm "Add dark mode" |
| GitHub issue | swarm "gh:owner/repo#123" |
| GitHub issue (current repo) | swarm "gh:#42" |
| GitHub issue (URL) | swarm "https://github.com/owner/repo/issues/123" |
ISSUE_BODY env var | ISSUE_BODY="Add dark mode" swarm |