Skip to content

CLI reference

The worca command is installed by pip install worca-cc. Run worca --help or worca <command> --help for the authoritative, version-matched flags.

worca {init,run,pause,stop,resume,status,multi-status,integrations,templates,cleanup,workspace,graphify}

Initialize or upgrade worca in a project.

FlagPurpose
--upgradeUpgrade an existing installation (migrates settings, refreshes the runtime).
--forceOverwrite everything (destructive reset to the template).
--checkDry-run — show what would change.
--source PATHInitialize from a local worca-cc checkout.

Run the pipeline. See Running from the CLI.

FlagPurpose
--prompt TEXTInline work request.
--source REFExternal source (gh:issue:42, bd:bd-abc).
--spec PATH / --plan PATHSpec file, or a plan that skips the Planner.
--template IDApply a template before running.
--param KEY=VALUEOverride a template parameter (repeatable).
--msize N / --mloops NTurn / loop multipliers (1–10).
--max-beads NCap Coordinator bead decomposition for this run. 0 = auto.
--claude-md-mode MODEPin which CLAUDE.md files load (all / project / project+local / none). See CLAUDE.md load mode.
--worktreeRun in an isolated git worktree.
--branch BRANCHWorktree base branch (--worktree only).
--guide PATHReference guide for planning (--worktree only, repeatable).
--resumeResume from the last checkpoint.

Lifecycle control for a run, by run ID:

Terminal window
worca pause <run-id>
worca stop <run-id>
worca resume <run-id>
worca status <run-id>

worca multi-status shows every parallel pipeline at once.

Manage pipeline templates. See Authoring templates.

SubcommandPurpose
list [--json]List all resolvable templates.
show <id>Show one template’s definition.
save <id> [--description ...] [--global]Snapshot current settings as a template.
create --from-file <path> [--global]Create a template from a JSON file (use - for stdin).
delete <id> [--global]Delete a project or user template.
export --to <dest> [--templates <ids>] [--include-models] [--include-pricing]Export templates as a portable bundle. <dest> is a file path, gist (secret), or gist:public. Secrets are redacted before write. See Share via export/import bundles.
import --from <src> [--scope project|user] [--non-interactive]Import templates from a bundle. <src> is a file path, HTTPS URL, or gist URL/ID. Collisions prompt interactively; import is atomic with rollback.
advise [--prompt TEXT] [--spec PATH] [--source REF] [--json]LLM-backed recommendation for which template best matches a work source. Powers the launcher’s Suggest button. See Launching a run.

Remove finished worktrees. See Worktree cleanup.

FlagPurpose
--allRemove all completed/failed worktrees.
--run-id IDRemove one by run ID.
--fleet-id ID / --workspace-id IDRemove a fleet/workspace and its children.
--older-than DURATIONe.g. 7d, 24h, 30m.
--dry-runPreview only.
SubcommandPurpose
init <parent> [--force]Scaffold workspace.json from sibling git repos.
migrateConvert a legacy workspace.json (repos) to the current schema (projects).

See Workspace runs.

Manage the knowledge graph integration.

SubcommandPurpose
statusShow effective config and detection state.
recommendSurvey the project and advise enable/skip.
enable / disableToggle Graphify for this project.
updateBuild the current HEAD snapshot if missing.
rebuildDelete and rebuild the current HEAD snapshot.
gcRemove all cached snapshots for this repo.

worca integrations status shows chat-integration health from the UI server. See Chat integrations.