install¶
Install rp1 plugins for AI coding assistants.
Synopsis¶
Description¶
The install command installs rp1 plugins (rp1-base and rp1-dev) for your AI coding assistant. It supports Claude Code, OpenCode, and can auto-detect all installed tools.
Subcommands¶
install claude-code¶
Install plugins to Claude Code.
This command:
- Verifies Claude Code is installed
- Installs rp1-base plugin
- Installs rp1-dev plugin
- Confirms installation success
install opencode¶
Install plugins to OpenCode.
This command:
- Verifies OpenCode is installed
- Copies plugin files to OpenCode prompts directory
- Confirms installation success
install all¶
Install plugins to all detected AI tools.
This command:
- Detects installed AI tools (Claude Code, OpenCode)
- Installs plugins for each detected tool
- Reports results for all tools
Options¶
| Option | Short | Description |
|---|---|---|
--dry-run |
Show what would be installed without making changes. Also validates prerequisites (network, disk space). | |
--strict |
Fail on any missing source directories (useful for CI/CD). Exit code 5 on strict mode failures. | |
--yes |
-y |
Skip confirmation prompts |
--help |
-h |
Display help information |
Examples¶
Install for Claude Code¶
Expected output:
Installing rp1 plugins for Claude Code...
Installing rp1-base...
Installing rp1-dev...
Plugins installed successfully.
Next steps:
1. Restart Claude Code to load plugins
2. Type / to see available commands
Install for all detected tools¶
Expected output:
Detecting AI tools...
Found: Claude Code v2.0.75
Found: OpenCode v0.8.0
Installing plugins for all detected tools...
Claude Code:
Installing rp1-base...
Installing rp1-dev...
OpenCode:
Copying plugins to ~/.opencode/prompts/...
All plugins installed successfully.
Preview installation (dry run)¶
Expected output:
[DRY RUN] Would install:
- rp1-base to Claude Code
- rp1-dev to Claude Code
Validating prerequisites...
Network connectivity: OK
Disk space: OK (150 MB available)
Latest version: 0.3.1
No changes made.
Strict mode for CI/CD¶
In strict mode, the command fails with exit code 5 if any source directories are missing. This is useful for CI/CD pipelines where you want deterministic failures rather than silent warnings.
Example in CI:
Non-interactive installation¶
Skips all confirmation prompts. Useful for CI/CD or automation scripts.
Verification¶
After installation, verify plugins are correctly installed:
# Verify Claude Code installation
rp1 verify claude-code
# Verify OpenCode installation
rp1 verify opencode
Example output:
Plugin Verification: Claude Code
Component Status Path
rp1-base OK ~/.claude/commands/rp1-base
rp1-dev OK ~/.claude/commands/rp1-dev
All plugins verified successfully.
Reliability Features¶
Automatic Rollback¶
If installation fails partway through, rp1 automatically restores your previous installation from backup. You'll see a message like:
Installation failed. Restored previous installation (12 files). You can safely retry the installation.
Safe Interruption¶
You can safely press Ctrl+C during installation. The system will:
- Stop the installation gracefully
- Restore any backed-up files
- Clean up partial state
- Display guidance for retrying
Atomic Installation (OpenCode)¶
For OpenCode installations, plugins are first copied to a staging directory (~/.config/.rp1-staging/), verified, then atomically moved to the target location. This ensures you never end up with a partial installation.
Troubleshooting¶
Installation fails with 'tool not found'
Ensure your AI tool is installed and in your PATH:
If the binary is installed but not in PATH, add it to your shell configuration.
Plugins not appearing after installation
- Restart your AI tool - Plugins are only loaded at startup
- Verify installation - Run
rp1 verify claude-codeorrp1 verify opencode - Check plugin directory - Ensure plugins exist in the expected location:
- Claude Code:
~/.claude/commands/ - OpenCode:
~/.opencode/prompts/
- Claude Code:
Permission denied during installation
Check file permissions on the plugin directory:
Ensure your user has write access to these directories.
Deprecated Syntax¶
Deprecated Commands
The following commands are deprecated and will be removed in a future release:
| Deprecated | New Command |
|---|---|
rp1 install:claude-code |
rp1 install claude-code |
rp1 install:opencode |
rp1 install opencode |
The deprecated commands still work but display a warning message.
See Also¶
- Installation Guide - Complete installation walkthrough
init- Initialize rp1 in a project (includes plugin installation)update- Update CLI and plugins