Skip to content
rr homev0.29.3
Docs menu

Claude Code plugin

The rr plugin teaches Claude Code how to use the rr CLI, including commands, configuration, and troubleshooting.

Install

/plugin marketplace add https://github.com/rileyhilliard/rr
/plugin install rr@rr

What It Does

Once installed, Claude understands:

  • Commands: rr run, rr exec, rr sync, rr doctor, rr monitor, and all subcommands
  • Two-config system: Global hosts at ~/.rr/config.yaml, project settings at .rr.yaml
  • Structured output: Reading the JSON phase and result events rr writes to stderr by default, including test summaries, failures, and error codes
  • Task arguments: -- before flag-like args, {args} placeholders, and forward_args for parallel tasks
  • Workflows: Initial setup, daily development, multi-host load balancing
  • Troubleshooting: Connection issues, slow syncs, stuck locks

Usage

Guided Setup

Run from your project root to set up rr:

/rr:setup

This walks through:

  1. Creating/verifying global config with hosts (remote machines, or this machine as a local host)
  2. Creating project config with appropriate sync exclusions and tasks
  3. Verifying SSH connectivity
  4. Testing remote execution
  5. Checking dependencies on the remote host

General Help

The rr skill activates automatically when you ask about remote development, running commands on remote machines, or mention rr.

Examples:

Run the tests on my remote machine
Why is rr failing to connect?
Add a new host to my rr config

Plugin Structure

.claude-plugin/
├── marketplace.json
└── plugin.json
plugins/rr/
├── commands/
│   └── setup.md        # /rr:setup - guided setup workflow
└── skills/
    └── rr/
        ├── SKILL.md    # rr knowledge - auto-invoked when relevant
        └── reference/  # config, commands, tasks, requirements, JSON output, troubleshooting
  • Commands (/rr:setup): User-invoked actions
  • Skills (rr): Context Claude uses automatically when working with rr

Alternative Installation

Personal installation (without plugin)

Copy to your Claude config directory:

# Skills
cp -r /path/to/rr/plugins/rr/skills/* ~/.claude/skills/

# Commands
cp /path/to/rr/plugins/rr/commands/*.md ~/.claude/commands/

What Claude Learns

Topic Coverage
Commands All CLI commands with flags and examples
Configuration Global vs project config, all fields, variable expansion
Host management Adding, removing, listing hosts, including this machine as a local host
Sync Exclude/preserve patterns, rsync flags
Locking How distributed locks work, unlocking stuck locks
Tasks Defining and running named tasks, passing args, parallel tasks, dependencies
Output JSON events, result details, error codes, exit codes
Load balancing Multi-host setup, failover behavior
Troubleshooting Common issues and fixes

Updating

/plugin update rr@rr

Uninstalling

/plugin uninstall rr@rr

View as Markdown