CLI Reference

Complete list of Crux commands and their usage.

crux init

Initialize a new project with Crux configuration and scaffolding.

crux init                          # Interactive wizard (when in a terminal)
crux init -y                       # Non-interactive, use defaults
crux init --example httpapi        # Seed with named example project

Creates .crux/config.yaml, docs/phases/, and work-notes/ directories.

crux start

Start the orchestration loop.

crux start

Launches tmux sessions for each configured agent, assigns prompts from phase docs, and begins the continuous poll-verify-advance loop.

crux start dashboard keys

Scope	Keys	Action
Global	q	Quit dashboard and request graceful shutdown
Global	?	Toggle keyboard help overlay
Global	tab / shift+tab	Cycle focused panel
Agents panel	j / k	Move selection
Agents panel	s	Pause/resume selected agent
Agents panel	x	Kill selected agent
Workspace panel	o / d / n	Switch Output / Details / Notes tabs
Workspace panel	i	Enter message input mode
Workspace panel	a	Force-advance current phase (with confirmation)
Logs panel	/	Enter filter mode
Logs panel	g / G	Jump to oldest / newest logs

crux plan

Start the interactive planning board.

crux plan

Builds phase specs and prompts in a dedicated planning TUI backed by the configured planner backend.

crux plan board keys

Scope	Keys	Action
Global	q	Quit planning board
Global	?	Toggle planner key help
Global	tab / shift+tab	Cycle focused pane
Global	ctrl+g	Trigger generation flow (generate_single_phase)
Global	ctrl+n	Reset planning session state
Timeline/Chat/Status panes	j / k	Scroll
Timeline/Chat/Status panes	pgup / pgdn	Page scroll
Input pane	enter	Send message

crux status

Show the current world state.

crux status

Displays agent statuses, current phases, prompt progress, gate results, and open questions.

crux phase

Phase management commands.

crux phase create --id 2a          # Generate phase spec + prompt doc
crux phase list                    # List all phases with status
crux phase show 2a                 # Show details for a phase
crux phase validate                # Verify all specs have exit criteria
crux phase advance 2a              # Force-advance a phase (human override)

crux phase create

Flag	Description
--id	Phase identifier (e.g., 2A, 3B)
--name	Human-readable phase name
--depends-on	Comma-separated list of dependency phase IDs
--prompts	Number of prompts to scaffold

crux phase validate

Checks:

• Every spec has exit criteria
• Every prompt has verification commands
• Parallel phases have no file conflicts

crux decisions

Search and export the decision journal.

crux decisions search "query"      # Semantic search across decision journal
crux decisions list --since 24h    # List recent decisions
crux decisions export              # Export all decisions as JSON

crux notes

View and manage per-phase work notes.

crux notes show 2a                 # Display work notes for a phase
crux notes list                    # List all work notes

crux replay

Replay a session transcript.

crux replay <session-id>           # Replay a session transcript

crux audit

View the structured audit log.

crux audit list --since 24h        # View audit log with filters
crux audit stats                   # Summary statistics

Flag	Description
--since	Time window (e.g., 1h, 24h, 7d)
--agent	Filter by agent name
--type	Filter by event type

crux completion

Generate shell completions.

crux completion bash               # Bash completions
crux completion zsh                # Zsh completions
crux completion fish               # Fish completions
crux completion powershell         # PowerShell completions

See Installation: Shell Completions for permanent installation instructions.

Global Flags

Flag	Description
--config	Path to config file (default: .crux/config.yaml)
--verbose	Enable verbose logging
--version	Print version information
--help	Show help for any command