Skip to content

Quick Start

Get rp1 running in under 5 minutes.

Prerequisites

Before installing rp1, ensure you have:

  • An AI coding assistant installed:
  • A codebase you want to enhance with rp1 workflows

Installation

Choose your platform and follow the installation steps:

Step 1: Add the marketplace

/plugin marketplace add rp1-run/rp1

Step 2: Install the plugins

/plugin install rp1-base
/plugin install rp1-dev

Step 3: Restart Claude Code

Close and reopen Claude Code to load the new plugins.

Step 4: Verify installation

/help

You should see rp1 commands listed (look for knowledge-build, feature-requirements, etc.).

Step 1: Install uv (if not already installed)

curl -LsSf https://astral.sh/uv/install.sh | sh

Step 2: Run the installer

curl -fsSL https://raw.githubusercontent.com/rp1-run/rp1/main/scripts/install-for-opencode.sh | bash

Step 3: Verify installation

/help

You should see rp1 commands listed (look for /rp1-base/ and /rp1-dev/).

Your First Command

Let's build a knowledge base for your codebase. This analyzes your project structure, architecture, and patterns.

/knowledge-build

/rp1-base/knowledge-build

Expected Output

After running the command, you should see output similar to:

READY [monorepo: 2 projects]

or for a single project:

READY [single-project]

This indicates rp1 has analyzed your codebase and created a knowledge base in .rp1/context/.

What Just Happened?

The knowledge-build command:

  1. Scanned your codebase - Analyzed file structure and identified key components
  2. Extracted architecture - Mapped system patterns, layers, and integrations
  3. Documented concepts - Built a domain concept map and terminology glossary
  4. Created a knowledge base - Stored everything in .rp1/context/ for future commands

Knowledge Base Files

Check out your new knowledge base:

  • .rp1/context/index.md - Project overview
  • .rp1/context/architecture.md - System architecture
  • .rp1/context/modules.md - Component breakdown
  • .rp1/context/concept_map.md - Domain concepts

Next Steps

Now that rp1 is installed and understands your codebase, explore what you can do:

  • Guides

    Step-by-step tutorials for common workflows like feature development and PR review.

    View Guides

  • Reference

    Complete documentation for all 21 commands across both plugins.

    View Reference

  • Concepts

    Understand constitutional prompting and knowledge-aware agents.

    View Concepts

Common Commands

Here are some frequently used commands to try next:

Command Description
/blueprint Start a new project with charter and PRD
/feature-requirements <id> Collect requirements for a feature
/feature-design <id> Create technical design
/pr-review Review a pull request
/code-check Run lints, tests, and coverage
Command Description
/rp1-dev/blueprint Start a new project with charter and PRD
/rp1-dev/feature-requirements <id> Collect requirements for a feature
/rp1-dev/feature-design <id> Create technical design
/rp1-dev/pr-review Review a pull request
/rp1-dev/code-check Run lints, tests, and coverage

Troubleshooting

Commands not appearing after installation?

Claude Code: Make sure you restarted Claude Code after installing the plugins.

OpenCode: Check that the installer completed successfully and the plugins are in the correct directory.

Knowledge build taking too long?

First-time builds analyze your entire codebase and can take 10-15 minutes for large projects. Subsequent builds are incremental and take 2-5 minutes.

Getting errors?

Check the GitHub Issues or open a new issue with your error message.

Need Help?