-
-
Notifications
You must be signed in to change notification settings - Fork 34
Framework Overview
Welcome to the comprehensive overview of the CursorRIPERβ¦Ξ£ framework - a revolutionary approach to AI-assisted software development.
CursorRIPERβ¦Ξ£ (Sigma) is a symbolic notation framework that enhances AI-assisted development through:
- Structured workflows via RIPER modes
- Token efficiency through symbolic notation
- Code protection with intelligent annotations
- Context management for focused assistance
- Permission enforcement for safer operations
- Automatic memory for persistent project knowledge
Traditional frameworks use verbose instructions. CursorRIPERβ¦Ξ£ uses symbols:
Traditional approach:
"You are currently in research mode. In this mode, you can read files,
analyze code, and ask questions, but you cannot write code or modify files."
CursorRIPERβ¦Ξ£ approach:
Ξ©β = πR βΆ β(Ξ©β) βΆ +π[0:3] -π[4:15]
This achieves 93% token reduction while maintaining full functionality.
Five distinct modes guide the development process:
- π Research - Information gathering
- π‘ Innovate - Solution exploration
- π Plan - Specification creation
- βοΈ Execute - Implementation
- π Review - Validation
Critical code is protected from AI modification through annotation:
// !cp PROTECTED - Core authentication
function authenticate() { /* ... */ }
// !cp END-Pβββββββββββββββββββββββββββββββββββββββββββ
β CursorRIPERβ¦Ξ£ Framework β
βββββββββββββββββββββββββββββββββββββββββββ€
β π RIPER Mode Engine (Ξ©) β
β βββ Research (Ξ©β) β
β βββ Innovate (Ξ©β) β
β βββ Plan (Ξ©β) β
β βββ Execute (Ξ©β) β
β βββ Review (Ξ©β
) β
βββββββββββββββββββββββββββββββββββββββββββ€
β πΎ Memory System (Ξ£) β
β βββ Project Brief (Οβ) β
β βββ System Patterns (Οβ) β
β βββ Tech Context (Οβ) β
β βββ Active Context (Οβ) β
β βββ Progress (Οβ
) β
β βββ Protection Registry (Οβ) β
βββββββββββββββββββββββββββββββββββββββββββ€
β π‘οΈ Protection System (Ξ¨) β
β βββ Code Protection Levels β
β βββ Context References (Ξ) β
β βββ Permission Matrix (β) β
βββββββββββββββββββββββββββββββββββββββββββ€
β π Optional Extensions β
β βββ MCP Services (Ξ,Ξ,Ξ₯,Ξ) β
β βββ BMAD Enterprise (Ξ,Ξ‘,Ξ,Ξ) β
βββββββββββββββββββββββββββββββββββββββββββ
Controls workflow phases and enforces mode-specific behaviors:
- Each mode has specific permissions
- Transitions are tracked and validated
- Context updates automatically
Six persistent files maintain project knowledge:
- Οβ - Requirements and scope
- Οβ - Architecture decisions
- Οβ - Technology stack
- Οβ - Current context
- Οβ - Progress tracking
- Οβ - Protected regions
Multi-level code protection:
- Ξ¨β PROTECTED - Never modify
- Ξ¨β GUARDED - Ask permission
- Ξ¨β INFO - Context notes
- Ξ¨β DEBUG - Temporary code
- Ξ¨β TEST - Test code
- Ξ¨β CRITICAL - Business logic
Eight types of context references:
- Ξβ Files
- Ξβ Folders
- Ξβ Code elements
- Ξβ Documentation
- Ξβ Project rules
- Ξβ Git history
- Ξβ Notepads
- Ξβ Pinned files
CRUD permissions per mode:
- Create - New files/code
- Read - Access information
- Update - Modify existing
- Delete - Remove content
- Symbolic notation reduces prompt size
- More context fits in token limits
- Faster AI processing
- Clear phases prevent confusion
- Mode restrictions improve focus
- Systematic approach reduces errors
- Protection prevents unwanted changes
- Permissions limit dangerous operations
- Backups ensure recovery
- Memory files track all decisions
- Context preserved across sessions
- Progress never lost
- Optional MCP services
- Enterprise BMAD features
- Modular architecture
/start
Creates memory structure and enters RESEARCH mode.
/research β /innovate β /plan β /execute β /review
Each mode enables specific operations.
- Memory files update continuously
- Context adjusts per mode
- Protection enforced automatically
AI interprets symbols:
Ξ©β = πR βΆ β(Ξ©β) βΆ +π[0:3] -π[4:15]
Means: "Research mode with read-only permissions, enabling research functions."
- Greek letters for systems
- Subscripts for indexing
- Emoji for visual recognition
- Mathematical operators for relationships
- Mode determines allowed operations
- Violations caught automatically
- Safe fallbacks implemented
- Memory files are always current
- Cross-references maintain relationships
- Progress tracked automatically
- Mode-appropriate context loading
- Relevance-based filtering
- Automatic cleanup
- β Structured workflow prevents mistakes
- β Protection keeps critical code safe
- β Context management improves focus
- β Memory system tracks everything
- β Clear operational boundaries
- β Reduced token usage
- β Consistent behavior patterns
- β Better understanding of intent
- β Standardized development process
- β Shared memory across sessions
- β Clear protection boundaries
- β Traceable decision history
- GitHub (Ξ) - Repository integration
- Web Search (Ξ) - Research capabilities
- Browser (Ξ₯) - Automation testing
- Docker (Ξ) - Container management
- Roles (Ξ) - Team member roles
- PRD (Ξ‘) - Requirements management
- Gates (Ξ) - Quality checkpoints
- Enterprise (Ξ) - Advanced features
| Feature | Traditional | CursorRIPERβ¦Ξ£ |
|---|---|---|
| Token Usage | High (~15K) | Low (<1K) |
| Workflow Structure | Loose | Strict RIPER |
| Code Protection | Manual | Automatic |
| Context Management | Ad-hoc | Systematic |
| Memory | Session-only | Persistent |
| Permissions | Undefined | Mode-specific |
- Start Here β RIPER Modes
- Then β Memory System
- Next β Symbolic Notation
- Finally β Phase Management
Ready to transform your development workflow?
- ποΈ 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