Quick Start - johnpeterman72/CursorRIPER.sigma GitHub Wiki

โšก Quick Start Guide (5 Minutes)

Get up and running with CursorRIPERโ™ฆฮฃ in just 5 minutes!

๐ŸŽฏ Goal

By the end of this guide, you'll:

  • โœ… Have the framework running
  • โœ… Understand basic mode switching
  • โœ… Know essential commands
  • โœ… Be ready to start developing

๐Ÿš€ Minute 1: Enable Framework

Assuming you've installed the framework:

  1. Open your project in Cursor IDE
  2. In the AI chat, type:
/start

You should see memory files created and get confirmation.

๐Ÿ”„ Minute 2: Learn the Modes

CursorRIPERโ™ฆฮฃ has 5 modes that guide your workflow:

Mode Command Purpose Symbol
Research /r Gather information ๐Ÿ”
Innovate /i Explore ideas ๐Ÿ’ก
Plan /p Design solution ๐Ÿ“
Execute /e Write code โš™๏ธ
Review /rev Validate work ๐Ÿ”Ž

Try it: Type /research to ensure you're in research mode.

๐Ÿ›ก๏ธ Minute 3: Protect Your Code

Add protection to prevent AI from modifying critical code:

// !cp PROTECTED - Authentication logic
function authenticate(user, password) {
    // Critical security code
    return validateCredentials(user, password);
}
// !cp END-P

Protection levels:

  • !cp - PROTECTED (never modify)
  • !cg - GUARDED (ask first)
  • !cc - CRITICAL (business logic)

๐Ÿ“Ž Minute 4: Manage Context

Keep AI focused on relevant files:

!af src/main.js        # Add file to context
!ac validateUser()     # Add code function
!ad src/components/    # Add folder
!cc                    # Clear all context

The AI will now prioritize these items in its responses.

๐Ÿ” Minute 5: Understand Permissions

Each mode has different permissions:

Mode Can Do Cannot Do
Research ๐Ÿ” Read files, analyze Write code
Plan ๐Ÿ“ Create designs Execute code
Execute โš™๏ธ Write/modify code Search web

Check current permissions: !ckp

๐ŸŽฎ Try This Workflow

Let's practice a mini workflow:

  1. Start in Research:
/research
What authentication methods are used in this project?
  1. Move to Innovate:
/innovate
What are modern alternatives to our current auth system?
  1. Create a Plan:
/plan
Create a plan to implement JWT authentication
  1. Execute the Plan:
/execute
Implement the JWT authentication according to the plan
  1. Review the Work:
/review
Check if the implementation matches our plan

๐Ÿ“‹ Essential Commands Cheatsheet

Mode Switching

  • /r - Research mode
  • /i - Innovate mode
  • /p - Plan mode
  • /e - Execute mode
  • /rev - Review mode

Code Protection

  • !cp - Protect code
  • !cg - Guard code
  • !cc - Critical code

Context Management

  • !af file.js - Add file
  • !ac function() - Add code
  • !cc - Clear context
  • !cm - Set mode context

Permissions

  • !ckp - Check permissions
  • !pm operation - Is operation allowed?

โœจ Pro Tips

  1. Always declare mode - Keep AI aware of current phase
  2. Protect early - Add protection before AI sees critical code
  3. Context is key - Only include relevant files
  4. Follow the flow - Research โ†’ Innovate โ†’ Plan โ†’ Execute โ†’ Review
  5. Check memory - Your work is saved in /memory-bank/

๐ŸŽฏ What's Next?

You're ready to use CursorRIPERโ™ฆฮฃ! Here's what to explore:

๐Ÿš€ Quick Project Starter

Want to start a new project right now?

/start
/research
Analyze the requirements for [YOUR PROJECT IDEA]

The framework will guide you through each phase!


Questions? See FAQ | Issues? See Common Problems

โ† Installation | Home | First Project โ†’