Getting Started with CursorRIPER Framework

This guide will help you set up the CursorRIPER Framework for your project and walk you through the initial steps.

Prerequisites

Before you begin, ensure you have:

• Cursor IDE installed
• Git (optional but recommended)
• Basic understanding of your project's requirements

Installation

Step 1: Copy Framework Files

Create a .cursor directory in your project root and copy the necessary files:

mkdir -p .cursor/rules
cp -r /path/to/CursorRIPER/src/.cursor/* .cursor/

Ensure you rename any .md files to .mdc files:

cd .cursor/rules/
rename 's/\.md$/.mdc/' *.md

Step 2: Create Memory Bank Directory

mkdir -p memory-bank

Step 3: Verify Installation

Your project should now have the following structure:

your-project/
└── .cursor/
    ├── rules/
    │   ├── core.mdc
    │   ├── state.mdc
    │   ├── start-phase.mdc
    │   ├── riper-workflow.mdc
    │   └── customization.mdc
    └── cursorignore

Quick Start Tutorial

Step 1: Initialize the Framework

Open your project in Cursor IDE and use the chat feature to initialize the framework:

/start

or

BEGIN START PHASE

Step 2: Follow the START Phase

The framework will guide you through six steps:

1. Requirements Gathering

   • Answer questions about your project goals
   • Define core requirements and success criteria

2. Technology Selection

   • Choose programming languages and frameworks
   • Select database and deployment technologies

3. Architecture Definition

   • Define the system architecture
   • Identify key components and their relationships

4. Project Scaffolding

   • Set up initial folder structure
   • Create configuration files

5. Environment Setup

   • Configure development environment
   • Set up testing framework

6. Memory Bank Initialization

   • Create and populate all core memory files

Step 3: Begin Development with RIPER Workflow

Once the START phase is complete, you'll automatically transition to the RIPER workflow. Use these commands to switch between modes:

• /research or ENTER RESEARCH MODE - Gather information and understand existing code
• /innovate or ENTER INNOVATE MODE - Brainstorm potential approaches
• /plan or ENTER PLAN MODE - Create detailed implementation plans
• /execute or ENTER EXECUTE MODE - Implement the approved plan
• /review or ENTER REVIEW MODE - Validate the implementation against the plan

Example Workflow

Here's a simple example of using the framework for adding a new feature:

1. Start in RESEARCH mode

   /research
   

   Ask: "Can you analyze how the user authentication system currently works?"

2. Move to INNOVATE mode

   /innovate
   

   Ask: "What approaches could we use to add a 'forgot password' feature?"

3. Transition to PLAN mode

   /plan
   

   Ask: "Create a detailed plan for implementing the forgot password feature."

4. Execute the plan

   /execute
   

   Ask: "Let's implement the forgot password feature according to the plan."

5. Review the implementation

   /review
   

   Ask: "Verify that our implementation matches the approved plan."

Migrating Existing Projects

If you have an existing project and want to adopt the CursorRIPER Framework:

1. Follow the installation steps above
2. Initialize the framework with /start
3. When gathering requirements, reference existing documentation
4. For architecture definition, document your current architecture
5. Add existing files to the project scaffold rather than creating new ones
6. Update memory bank files to reflect the current state of your project

Next Steps

• Review the Framework Components documentation
• Learn more about the Memory Bank System
• Explore Customization options

---

CursorRIPER: Adaptive development, persistent intelligence.