-
-
Notifications
You must be signed in to change notification settings - Fork 34
Quick Start
Get up and running with CursorRIPER♦Σ in just 5 minutes!
By the end of this guide, you'll:
- ✅ Have the framework running
- ✅ Understand basic mode switching
- ✅ Know essential commands
- ✅ Be ready to start developing
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.
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.
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-PProtection levels:
-
!cp- PROTECTED (never modify) -
!cg- GUARDED (ask first) -
!cc- CRITICAL (business logic)
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.
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
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
-
/r- Research mode -
/i- Innovate mode -
/p- Plan mode -
/e- Execute mode -
/rev- Review mode
-
!cp- Protect code -
!cg- Guard code -
!cc- Critical code
-
!af file.js- Add file -
!ac function()- Add code -
!cc- Clear context -
!cm- Set mode context
-
!ckp- Check permissions -
!pm operation- Is operation allowed?
- 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/
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
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
- 🔄 Mode Transitions
- 💾 Memory Management
- 🛡️ Protection Workflow
- 📎 Context Management
- 👥 Team Collaboration
-
Installation Issues
- Node.js Version Compatibility
- Package Installation Failures
- Framework Dependencies Missing
- Database Connection Issues
- Port Conflicts
- Environment Setup Issues
- Build and Development Issues
- Framework CLI Issues
-
Configuration & Runtime Issues
- Framework Configuration Problems
- Runtime Performance Issues
- Module Loading and Plugin Issues
- Database and Storage Issues
- Memory Leaks and High Memory Usage
- High CPU Usage
-
BMAD Module Issues
- BMAD Module Initialization Problems
- Business Model Canvas Issues
- Stakeholder Management Issues
- Analytics and Reporting Issues
- Performance Optimization
-
Database & API Issues
- Database Connection Problems
- Database Migration Issues
- API Performance and Reliability Issues
- Data Consistency Issues
- Transaction Problems
-
Performance & Memory Issues
- Memory Management
- CPU Optimization
- Database Query Performance
- Caching Issues
- Resource Monitoring
-
Security & Authentication Issues
- Authentication Failures
- Authorization Problems
- JWT Token Issues
- Session Management
- CORS and Security Headers
- SSL/TLS Configuration
-
Deployment & Production Issues
- Production Deployment Failures
- Environment Configuration
- Load Balancing Issues
- Monitoring and Logging
- Backup and Recovery
When reporting issues, please include:
- Framework version (
npm list @cursoriper/core) - Node.js version (
node --version) - Operating system and version
- Error messages and stack traces
- Steps to reproduce the issue
- Configuration files (sanitized)
- Recent changes or deployments
- Technical Support: support@cursoriper.com
- Documentation: https://docs.cursoriper.com
- Community Forum: https://community.cursoriper.com