CLI Reference¶
The rp1 CLI provides commands for initializing projects, managing plugin installations, and keeping rp1 up to date.
Available Commands¶
| Command | Description |
|---|---|
init |
Initialize rp1 in a project with guided setup |
install |
Install rp1 plugins for AI tools |
verify |
Verify plugin installation |
update |
Update rp1 CLI and plugins |
Agent Tools¶
Agent tools are CLI utilities designed for use by AI agents during automated workflows. They provide structured JSON output for programmatic consumption.
| Command | Description |
|---|---|
rp1-root-dir |
Resolve RP1_ROOT path with worktree awareness |
work |
Record workflow status updates for progress tracking |
worktree |
Create and manage git worktrees for isolated execution |
github-pr |
GitHub PR operations (submit-review, add-reaction, reply-comment, fetch-comments) |
See Agent Tools Reference for the full documentation.
Global Options¶
These options are available for all CLI commands:
| Option | Description |
|---|---|
--help, -h |
Display help information |
--version, -v |
Display version information |
Environment Variables¶
| Variable | Default | Description |
|---|---|---|
RP1_ROOT |
.rp1/ |
Custom location for rp1 data directory |
Using RP1_ROOT¶
To use a custom location for rp1 data:
# Set via environment variable
export RP1_ROOT=/custom/path/.rp1
rp1 init
# Or use direnv (.envrc)
echo 'export RP1_ROOT=.config/rp1' >> .envrc
direnv allow
rp1 init
Installation¶
The rp1 CLI is installed via the install script:
See Installation for detailed instructions.
See Also¶
- Installation Guide - Full installation instructions
- First Workflow - Getting started after init