Skip to content

Quick Start

Saros Industries edited this page Jun 28, 2025 · 1 revision

⚡ 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 →

🚀 Getting Started


🧠 Core Concepts


⚡ Features


📖 Guides


📋 Reference


🔌 Advanced

MCP Integration

BMAD Enterprise


🔧 Troubleshooting

Quick Navigation

🚨 Emergency Procedures

📋 Common Issues

Installation & Setup

  • 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

  • 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

  • BMAD Module Issues
    • BMAD Module Initialization Problems
    • Business Model Canvas Issues
    • Stakeholder Management Issues
    • Analytics and Reporting Issues
    • Performance Optimization

Database & API

  • Database & API Issues
    • Database Connection Problems
    • Database Migration Issues
    • API Performance and Reliability Issues
    • Data Consistency Issues
    • Transaction Problems

Performance & Memory

Security & Authentication

  • Security & Authentication Issues
    • Authentication Failures
    • Authorization Problems
    • JWT Token Issues
    • Session Management
    • CORS and Security Headers
    • SSL/TLS Configuration

Deployment & Production

  • Deployment & Production Issues
    • Production Deployment Failures
    • Environment Configuration
    • Load Balancing Issues
    • Monitoring and Logging
    • Backup and Recovery

Information to Gather

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

Tech Docs & Suport


📞 Support & Community


📋 Release Notes

Last Updated: June 28, 2025
Framework Version: CursorRIPER.sigma v1.0+

For the original verbose framework, see CursorRIPER

← Back to Home

Clone this wiki locally