CLI Reference
Ralph provides a comprehensive set of commands for managing PRD-driven development sessions. This page gives an overview of all available commands.
Basic Usage
ralph # Open the Ralph UI
ralph <command> [options] # Run a specific command
Core Commands
| Command | Description |
|---|
init | Initialize a new PRD project |
run [n] | Run n iterations (default: 10) |
resume | Resume a previously interrupted session |
stop | Stop a running Ralph process |
status | Show current session state and progress |
Task Commands
| Command | Description |
|---|
task list | List all tasks with status |
task current | Show the next pending task |
task done <id> | Mark a task as done |
task undone <id> | Mark a task as not done |
task add | Add a new task |
task edit <id> | Edit an existing task |
task show <id> | Show task details |
task remove <id> | Remove a task |
Progress Commands
| Command | Description |
|---|
progress | Show progress notes |
progress add <text> | Add a progress note |
progress clear | Clear all progress notes |
Session Commands
| Command | Description |
|---|
session | Show session information |
archive | Archive completed tasks and progress |
clear | Clear session data (archives first) |
Configuration Commands
| Command | Description |
|---|
config | View current configuration |
setup | Configure global preferences |
Guardrails Commands
| Command | Description |
|---|
guardrails | List all guardrails |
guardrails add <text> | Add a new guardrail |
guardrails remove <id> | Remove a guardrail |
guardrails toggle <id> | Enable/disable a guardrail |
guardrails generate | Auto-generate guardrails |
Dependency Commands
| Command | Description |
|---|
dependency | Show dependency graph |
dependency graph | Show dependency graph |
dependency validate | Validate task dependencies |
dependency ready | Show tasks ready to start |
dependency blocked | Show blocked tasks |
dependency order | Show execution order |
dependency show <id> | Show dependencies for a task |
dependency set <id> [deps...] | Set dependencies for a task |
dependency add <id> <dep> | Add a dependency to a task |
dependency remove <id> <dep> | Remove a dependency from a task |
Analysis Commands
| Command | Description |
|---|
analyze | Show failure pattern analysis |
analyze debt | Show technical debt review |
analyze export | Export analysis as JSON |
analyze clear | Clear failure history |
memory | Show session memory |
memory export | Export memory as markdown |
memory clear | Clear session memory |
GitHub Commands
| Command | Description |
|---|
auth | Show authentication status |
auth login | Authenticate with GitHub |
auth logout | Disconnect from GitHub |
github | Show GitHub integration status |
Project Commands
| Command | Description |
|---|
projects | List all registered projects |
projects current | Show current project details |
projects prune | Remove invalid projects |
migrate | Migrate local .ralph to global storage |
Utility Commands
| Command | Description |
|---|
usage | View usage statistics |
update | Check for and install updates |
help | Show help message |
Global Options
| Option | Description |
|---|
-b, --background | Run in background/daemon mode |
--dry-run | Simulate without running agents |
--json | Output in JSON format |
Next Steps
