Skip to main content
Documentation
DOCS · CLI REFERENCE

CLI Commands

Complete reference for Ralph Workflow command-line interface.

CLI Commands

Ralph provides a simple but powerful command-line interface.

Basic Usage

# Run workflow in current directory
$ ralph

# Initialize with a template
$ ralph --init <template>

# Resume interrupted workflow
$ ralph --resume

Commands & Flags

ralph

Run the workflow pipeline in the current directory.

$ ralph [OPTIONS]
Flag Description
--init <template> Initialize with a work guide template
--resume Resume from last checkpoint
--with-rebase Run git rebase before starting
--dry-run Preview what would happen without executing
--diagnose Run configuration diagnostics
--list List available templates
--completion <shell> Generate shell completions
--version Show version information
--help Show help message

--init

Initialize a project with a work guide template. Creates PROMPT.md from the selected template.

$ ralph --init feature-spec
$ ralph --init bug-fix
$ ralph --init refactor

Available Templates

Run ralph --list to see all 16+ available templates including test, docs, security-audit, performance-optimization, and more.

--resume

Resume an interrupted workflow from the last checkpoint.

$ ralph --resume

Ralph reads .agent/checkpoint.json and continues from where it stopped. Useful after:

  • Rate limit errors
  • Network interruptions
  • Manual pauses (Ctrl+C)
  • System restarts

--diagnose

Run diagnostics to verify your setup:

$ ralph --diagnose

Ralph Workflow Diagnostics

 Ralph version: 0.1.0
 Git repository: detected
 Configuration: ~/.config/ralph-workflow.toml
 Available agents: opencode, ccs
 Developer fallback chain: configured
 Reviewer fallback chain: configured

All checks passed!

--with-rebase

Rebase the current branch before starting the workflow:

$ ralph --with-rebase

Useful when working on feature branches that may have fallen behind main.

--dry-run

Preview what Ralph would do without making changes:

$ ralph --dry-run

Shows the planned phases and agents without executing.

Shell Completions

Generate shell completions for tab-completion support:

# Bash
$ ralph --completion bash > ~/.local/share/bash-completion/completions/ralph

# Zsh
$ ralph --completion zsh > ~/.zfunc/_ralph

# Fish
$ ralph --completion fish > ~/.config/fish/completions/ralph.fish

Exit Codes

Code Meaning
0 Success
1 General error
2 Configuration error
3 Agent error (all agents failed)
130 Interrupted (Ctrl+C)

Next Steps

Loading…