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:
- Open your project in Cursor IDE
- 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:
- Start in Research:
/research
What authentication methods are used in this project?
- Move to Innovate:
/innovate
What are modern alternatives to our current auth system?
- Create a Plan:
/plan
Create a plan to implement JWT authentication
- Execute the Plan:
/execute
Implement the JWT authentication according to the plan
- 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
- Always declare mode - Keep AI aware of current phase
- Protect early - Add protection before AI sees critical code
- Context is key - Only include relevant files
- Follow the flow - Research โ Innovate โ Plan โ Execute โ Review
- Check memory - Your work is saved in
/memory-bank/
๐ฏ What's Next?
You're ready to use CursorRIPERโฆฮฃ! Here's what to explore:
- ๐ First Project Tutorial - Build something real
- ๐ง Understanding RIPER Modes - Deep dive into workflow
- ๐ Memory System - How memory works
- ๐ฃ Symbol Reference - All symbols explained
๐ 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