CLI reference
Every contractor command, grouped by setup, blueprints, and execution.
contractor is driven from the contractor CLI. Commands fall into three groups — setup, blueprints, and execution — plus a set of Claude Code slash commands installed into .claude/commands/.
Setup
Per-repo installation, AI provider slash commands, and directory scaffolding.
| Command | Description |
|---|---|
contractor repo install | Initialize the contractor/ directory structure in the current repo. |
contractor repo uninstall | Remove the contractor/ directory. |
contractor ai install [provider...] | Install AI provider slash commands (e.g. Claude Code) into .claude/commands/. |
contractor ai uninstall [provider...] | Remove AI provider slash commands. |
contractor ai list | List available providers and whether each is installed. |
Blueprints
Create, inspect, validate, and archive blueprints.
| Command | Description |
|---|---|
contractor blueprint new <name> | Create a new blueprint. Name must be kebab-case. |
contractor blueprint status [--blueprint <name>] [--json] | Show artifact completion status for a blueprint. |
contractor blueprint list [--json] | List every blueprint in the current repo. |
contractor blueprint show [<name>] [--json] | Show a blueprint's metadata and artifact state. |
contractor blueprint instructions <artifact> [--blueprint <name>] [--json] | Print the creation prompt for an artifact, with full context. |
contractor blueprint close <name> [--yes] | Archive the blueprint and merge its requirements into contractor/requirements/. |
contractor blueprint sync [--blueprint <name>] | Merge requirements into the source of truth without archiving. |
contractor blueprint validate [<name>] [--json] | Validate artifact structure and format. |
Execution
Run pipelines, watch the dashboard, and keep the global state DB healthy.
| Command | Description |
|---|---|
contractor run [--backend <name>] [--model <name>] | Run the pipeline for the active blueprint (defaults to implement → review → close). |
contractor dashboard [--target <path>] [--all] | Launch the interactive TUI dashboard. |
contractor doctor [--fix] | Report (and with --fix, repair) global state DB health and legacy contractor/.state/ layouts. |
contractor completions <bash|zsh> | Generate shell completions. |
contractor logs path [<blueprint>] | Print the per-user logs directory for a blueprint. |
Claude Code slash commands
After contractor ai install, these slash commands are available in Claude Code:
| Command | Description |
|---|---|
/contractor:explore | Investigate the codebase without modifying code. |
/contractor:propose | Create a full blueprint with all four artifacts. |
/blueprint:implement | Work through task-groups, running verify and updating checkboxes as you go. |
/blueprint:review | Review the branch for reuse, quality, efficiency, and blueprint compliance. |
/blueprint:close | Merge the branch, archive the blueprint, and clean up the worktree. |
/contractor:retro | Review and apply pending observations captured during agent sessions. |
Shell completions
# bash
eval "$(contractor completions bash)"
# zsh
eval "$(contractor completions zsh)"Configuration
Project-level configuration lives in contractor/config.yaml:
schema: contractor-base
# Project context shown to AI when creating artifacts
context: |
Tech stack: TypeScript, React, Node.js
We use conventional commits
# Per-artifact rules
rules:
proposal:
- Keep proposals under 500 words
tasks:
- Break tasks into chunks of max 2 hoursSee the Get started guide for the install-and-run flow, and Concepts for how the pipeline and loops fit together.