CLI Commands Overview
Complete reference for all Ralph TUI command-line commands and their options.
Command Reference
Ralph TUI provides a comprehensive set of commands for managing autonomous AI agent execution. Each command serves a specific purpose in the workflow from setup to execution.
Use ralph-tui help to see all available commands, or ralph-tui <command> --help for detailed help on any specific command.
Available Commands
| Command | Description |
|---|---|
ralph-tui | Launch the interactive TUI |
ralph-tui run | Start Ralph execution |
ralph-tui resume | Resume an interrupted session |
ralph-tui status | Check session status (headless, for CI/scripts) |
ralph-tui logs | View/manage iteration output logs |
ralph-tui setup | Run interactive project setup |
ralph-tui create-prd | Create a new PRD interactively |
ralph-tui convert | Convert PRD markdown to JSON format |
Additional Commands
These commands help with configuration, plugin management, and diagnostics:
| Command | Description |
|---|---|
ralph-tui config show | Display merged configuration |
ralph-tui template show | Display current prompt template |
ralph-tui template init | Copy default template for customization |
ralph-tui template install | Alias for template init |
ralph-tui skills list | List bundled skills and installation status |
ralph-tui skills install | Install skills to your agent's skills directory |
ralph-tui plugins agents | List available agent plugins |
ralph-tui plugins trackers | List available tracker plugins |
ralph-tui doctor | Diagnose agent configuration issues |
ralph-tui info | Display system information for bug reports |
ralph-tui docs [section] | Open documentation in browser |
ralph-tui help | Show help message |
Typical Workflow
The commands are typically used in this order:
Setup
Run ralph-tui setup to configure your project. This creates the necessary configuration files and installs skills.
Create Tasks
Use ralph-tui create-prd to generate a PRD with AI assistance, or ralph-tui convert to convert an existing PRD to tasks.
Execute
Start execution with ralph-tui run. Ralph will work through your tasks autonomously.
Monitor & Resume
Check progress with ralph-tui status, review output with ralph-tui logs, and use ralph-tui resume if interrupted.
Command Categories
Execution Commands
- run - Main execution command with full options for agent, tracker, and iteration control
- resume - Continue from a saved session state
- status - JSON-friendly status output for scripts and CI pipelines
PRD & Task Management
- create-prd - AI-powered PRD creation with interactive chat mode
- convert - Transform PRD markdown into executable task formats
Setup & Maintenance
- setup - Interactive wizard for initial configuration
- logs - View, filter, and clean up iteration logs
Diagnostics & Troubleshooting
- doctor - Diagnose agent configuration and detect common issues
- info - Display system information useful for bug reports (version, OS, agent status)
Global Options
These options work with most commands:
| Option | Description |
|---|---|
--help, -h | Show help for the command |
--version, -v | Show Ralph TUI version |
--cwd <path> | Set working directory |
Next Steps
- run - Learn about the main execution command
- setup - Configure your project
- create-prd - Create your first PRD