Skip to content

README.md

Latest commit

 

History

History
274 lines (200 loc) · 7.27 KB

README.md

File metadata and controls

274 lines (200 loc) · 7.27 KB

PRP Core Plugin

Complete PRP (Product Requirement Prompt) workflow automation for Claude Code.

Overview

This plugin provides a comprehensive workflow for creating, executing, and shipping features using the PRP methodology - where PRP = PRD + curated codebase intelligence + agent/runbook designed to enable AI agents to ship production-ready code on the first pass.

Commands

Quick Workflow (Simple Features)

Command Description
/prp-core:prp-create Quick feature PRP creation with codebase analysis
/prp-core:prp-execute Execute a feature PRP until fully complete

Core Workflow (Complex Features)

Command Description
/prp-core:prp-prd Interactive PRD generator with implementation phases
/prp-core:prp-plan Create implementation plan (from PRD or free-form input)
/prp-core:prp-implement Execute a plan with validation loops

Issue Workflow

Command Description
/prp-core:prp-issue-investigate Analyze GitHub issue, create implementation plan
/prp-core:prp-issue-fix Execute fix from investigation artifact

Git & Review

Command Description
/prp-core:prp-commit Smart commit with natural language file targeting
/prp-core:prp-pr Create PR with template support
/prp-core:prp-review Comprehensive PR code review
/prp-core:prp-review-agents Multi-agent PR review (comments, tests, errors, types, code, docs, simplify)

Research & Analysis

Command Description
/prp-core:prp-codebase-question Research codebase questions using parallel agents - documents what exists

Agents

Specialized agents for code analysis and review workflows.

Codebase Analysis

Agent Description
codebase-analyst Documents HOW code works with file:line references
codebase-explorer Finds WHERE code lives AND extracts patterns
web-researcher Researches web for docs, APIs, best practices

Review Workflow

Agent Description
code-reviewer Project guidelines, bugs, type/module checks
comment-analyzer Comment accuracy and maintainability
pr-test-analyzer Test coverage quality and gaps
silent-failure-hunter Error handling and silent failures
type-design-analyzer Type encapsulation and invariants
code-simplifier Clarity and maintainability improvements
docs-impact-agent Updates stale documentation

Using Agents

Agents are invoked automatically by /prp-core:prp-review-agents or manually via Task tool:

/prp-core:prp-review-agents 123              # Full review of PR #123
/prp-core:prp-review-agents 123 tests errors # Specific aspects only

Workflow

Simple Features: Quick Create & Execute

/prp-core:prp-create "add pagination to user list"
    ↓
Creates feature PRP with codebase analysis
    ↓
/prp-core:prp-execute .claude/PRPs/features/add-pagination.md
    ↓
Executes PRP with validation loops

Large Features: PRD → Plan → Implement

/prp-core:prp-prd "user authentication system"
    ↓
Creates PRD with Implementation Phases table
    ↓
/prp-core:prp-plan .claude/PRPs/prds/user-auth.prd.md
    ↓
Auto-selects next pending phase, creates plan
    ↓
/prp-core:prp-implement .claude/PRPs/plans/user-auth-phase-1.plan.md
    ↓
Executes plan, updates PRD progress, archives plan
    ↓
Repeat /prp-core:prp-plan for next phase

Medium Features: Direct to Plan

/prp-core:prp-plan "add pagination to the API"
    ↓
/prp-core:prp-implement .claude/PRPs/plans/add-pagination.plan.md

Bug Fixes: Issue Workflow

/prp-core:prp-issue-investigate 123
    ↓
/prp-core:prp-issue-fix 123

Research: Codebase Questions

/prp-core:prp-codebase-question "how does authentication work"
    ↓
Spawns parallel agents to research the question
    ↓
Creates research document at .claude/PRPs/research/

# With external research
/prp-core:prp-codebase-question "what are React best practices" --web

# Follow up on previous research
/prp-core:prp-codebase-question --follow-up "what error handling patterns exist"

Installation

Option 1: From GitHub (Recommended)

# Add marketplace from GitHub
/plugin marketplace add Wirasm/PRPs-agentic-eng

# Install plugin
/plugin install prp-core@prp-marketplace

Option 2: Local Development/Testing

# Navigate to the repository root
cd /path/to/PRPs-agentic-eng

# Start Claude Code
claude

# Add local marketplace (use absolute path)
/plugin marketplace add /absolute/path/to/PRPs-agentic-eng

# Install plugin
/plugin install prp-core@prp-marketplace

# Restart Claude Code (required)

Option 3: Team Automatic Installation

Add to your project's .claude/settings.json:

{
  "extraKnownMarketplaces": {
    "prp-marketplace": {
      "source": "Wirasm/PRPs-agentic-eng"
    }
  },
  "enabledPlugins": [
    "prp-core@prp-marketplace"
  ]
}

Artifacts Structure

All artifacts are stored in .claude/PRPs/:

.claude/PRPs/
├── prds/              # Product requirement documents
├── plans/             # Implementation plans
│   └── completed/     # Archived completed plans
├── reports/           # Implementation reports
├── issues/            # Issue investigation artifacts
│   └── completed/     # Archived completed investigations
├── reviews/           # PR review reports
└── research/          # Codebase research documents

PRD Phases

PRDs include an Implementation Phases table:

| # | Phase | Description | Status | Parallel | Depends | PRP Plan |
|---|-------|-------------|--------|----------|---------|----------|
| 1 | Auth  | User login  | complete | -      | -       | [link]   |
| 2 | API   | Endpoints   | in-progress | -   | 1       | [link]   |
| 3 | UI    | Frontend    | pending | with 4  | 2       | -        |
  • Status: pending → in-progress → complete
  • Parallel: Phases that can run concurrently
  • Depends: Phases that must complete first

PRP Methodology

What is a PRP?

PRP = PRD + curated codebase intelligence + agent/runbook

A PRP is a comprehensive implementation document containing:

  1. Context - All necessary patterns, documentation, and examples
  2. Plan - Step-by-step tasks with validation gates
  3. Validation - Executable commands to verify correctness

Core Principles

  1. Context is King - Include ALL necessary information
  2. Validation Loops - Provide executable tests the AI can run and fix
  3. Information Dense - Use keywords and patterns from codebase
  4. Bounded Scope - Each plan completable by AI in one loop

Requirements

  • Claude Code installed
  • Git configured
  • GitHub CLI (gh) for PR creation

Troubleshooting

Plugin Not Loading

/plugin
/plugin uninstall prp-core@marketplace
/plugin install prp-core@marketplace
# Restart Claude Code

Commands Not Found

Ensure Claude Code restarted after installation:

/help

License

MIT License

Support