-
-
Notifications
You must be signed in to change notification settings - Fork 34
Installation
Saros Industries edited this page Jun 29, 2025
·
2 revisions
Welcome! This guide will help you install and set up CursorRIPERβ¦Ξ£ in your project.
Before installing CursorRIPERβ¦Ξ£, ensure you have:
- β Cursor IDE (latest version)
- β A project folder initialized
- β Node.js v14+ (optional, only for MCP services)
- β Git (recommended for version control)
Choose one of these methods:
git clone https://github.com/johnpeterman72/CursorRIPER.sigma.git
cd CursorRIPER.sigma- Visit CursorRIPER.sigma repository
- Click "Code" β "Download ZIP"
- Extract to your desired location
Copy the essential files to your project:
# Copy the framework rule file to your project
cp ripersigma105.mdc /your/project/path/.cursor/rules/
# Optionally copy documentation
cp -r docs /your/project/path/In your project root, create the memory bank:
mkdir -p memory-bank/backups- Open your project in Cursor IDE
- Navigate to Settings β Cursor Rules
- You should see
RIPERsigma1.0.5.mdcin the rules list - Ensure it's enabled (checkbox checked)
In Cursor's AI chat, type:
/start
This will:
- β Create the 6 memory files (Οβ-Οβ)
- β Set up the symbol reference guide
- β Initialize the framework in RESEARCH mode
- β Confirm successful installation
If you want to use optional MCP integrations:
npm install -g @modelcontextprotocol/server-github
export GITHUB_TOKEN=your_github_tokennpm install -g @modelcontextprotocol/server-brave-search
export BRAVE_SEARCH_API_KEY=your_api_keynpm install -g @executeautomation/playwright-mcp-servernpm install -g docker-mcp
# Ensure Docker Desktop is runningAfter installing, uncomment the relevant sections in CursorRIPER.sigma.mcp.mdc.
For enterprise features, uncomment these in .cursor/bmad.json:
-
bmad_roles.mdc- Role-based development -
prd_system.mdc- PRD management -
quality_gates.mdc- Quality control gates -
enterprise.mdc- Enterprise features
To verify everything is working:
- Check that
/memory-bank/exists with 6.mdfiles - In Cursor chat, type:
What is my current mode? - You should see:
[MODE: RESEARCH] - Try a mode switch:
/plan - Verify it responds:
[MODE: PLAN]
- Ensure
.mdcfile is in.cursor/rules/ - Restart Cursor IDE
- Check file permissions
- Verify you typed
/start - Check write permissions in the project directory
- Try creating manually:
mkdir -p memory-bank/backups
- Verify Node.js is installed:
node --version - Check that environment variables are set
- Ensure services are globally installed
- See MCP Setup Guides
You've successfully installed CursorRIPERβ¦Ξ£!
- π Read the Quick Start Guide (5 minutes)
- π― Try the First Project Tutorial
- π§ Learn about RIPER Modes
- π£ Explore the Symbol Reference
Try these commands in Cursor chat:
/research # Switch to research mode
!cp # Add code protection
!af main.js # Add file to context
Need help? Check our FAQ or Common Issues
- ποΈ Framework Overview
- π RIPER Modes
- πΎ Memory System
- π£ Symbolic Notation
- π Phase Management
- π‘οΈ Code Protection
- π Context References
- π Permission System
- π Cross-References
- πΎ Backup System
- π Mode Transitions
- πΎ Memory Management
- π‘οΈ Protection Workflow
- π Context Management
- π₯ Team Collaboration
- π£ Symbol Reference
- β¨οΈ Command Reference
- π Mode Reference
- π Permission Matrix
- π API Reference
- π Overview
- π GitHub Integration
- π Web Search
- π Browser Automation
- π³ Docker Integration
-
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