Installation - johnpeterman72/CursorRIPER.sigma GitHub Wiki
📦 Installation Guide
Welcome! This guide will help you install and set up CursorRIPER♦Σ in your project.
📋 Prerequisites
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)
🎯 Installation Steps
Step 1: Download the Framework
Choose one of these methods:
Option A: Clone from GitHub (Recommended)
git clone https://github.com/johnpeterman72/CursorRIPER.sigma.git
cd CursorRIPER.sigma
Option B: Download ZIP
- Visit CursorRIPER.sigma repository
- Click "Code" → "Download ZIP"
- Extract to your desired location
Step 2: Copy Framework Files
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/
Step 3: Create Directory Structure
In your project root, create the memory bank:
mkdir -p memory-bank/backups
Step 4: Enable in Cursor IDE
- Open your project in Cursor IDE
- Navigate to Settings → Cursor Rules
- You should see
RIPERsigma1.0.5.mdc
in the rules list - Ensure it's enabled (checkbox checked)
Step 5: Initialize the Framework
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
🔌 Optional: Install MCP Services
If you want to use optional MCP integrations:
GitHub Integration
npm install -g @modelcontextprotocol/server-github
export GITHUB_TOKEN=your_github_token
Web Search
npm install -g @modelcontextprotocol/server-brave-search
export BRAVE_SEARCH_API_KEY=your_api_key
Browser Automation
npm install -g @executeautomation/playwright-mcp-server
Docker Integration
npm install -g docker-mcp
# Ensure Docker Desktop is running
After installing, uncomment the relevant sections in CursorRIPER.sigma.mcp.mdc
.
🏢 Optional: Enable BMAD Enterprise
For enterprise features, uncomment these in .cursor/bmad.json
:
bmad_roles.mdc
- Role-based developmentprd_system.mdc
- PRD managementquality_gates.mdc
- Quality control gatesenterprise.mdc
- Enterprise features
✅ Verify Installation
To verify everything is working:
- Check that
/memory-bank/
exists with 6.md
files - In Cursor chat, type:
What is my current mode?
- You should see:
[MODE: RESEARCH]
- Try a mode switch:
/plan
- Verify it responds:
[MODE: PLAN]
🚨 Troubleshooting Installation
"Framework not found"
- Ensure
.mdc
file is in.cursor/rules/
- Restart Cursor IDE
- Check file permissions
"Memory bank not created"
- Verify you typed
/start
- Check write permissions in the project directory
- Try creating manually:
mkdir -p memory-bank/backups
"MCP services not working"
- Verify Node.js is installed:
node --version
- Check that environment variables are set
- Ensure services are globally installed
- See MCP Setup Guides
🎉 Installation Complete!
You've successfully installed CursorRIPER♦Σ!
Next Steps:
- 📖 Read the Quick Start Guide (5 minutes)
- 🎯 Try the First Project Tutorial
- 🧠 Learn about RIPER Modes
- 🔣 Explore the Symbol Reference
Quick Test:
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