Framework Overview - johnpeterman72/CursorRIPER.sigma GitHub Wiki
ποΈ CursorRIPERβ¦Ξ£ Framework Overview
Welcome to the comprehensive overview of the CursorRIPERβ¦Ξ£ framework - a revolutionary approach to AI-assisted software development.
π― What is CursorRIPERβ¦Ξ£?
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
π§© Core Philosophy
1. Symbolic Efficiency
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.
2. Modal Development
Five distinct modes guide the development process:
- π Research - Information gathering
- π‘ Innovate - Solution exploration
- π Plan - Specification creation
- βοΈ Execute - Implementation
- π Review - Validation
3. Protection-First
Critical code is protected from AI modification through annotation:
// !cp PROTECTED - Core authentication
function authenticate() { /* ... */ }
// !cp END-P
ποΈ Framework Architecture
βββββββββββββββββββββββββββββββββββββββββββ
β 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 (Ξ,Ξ‘,Ξ,Ξ) β
βββββββββββββββββββββββββββββββββββββββββββ
π Key Components
1. Mode Engine (Ξ©)
Controls workflow phases and enforces mode-specific behaviors:
- Each mode has specific permissions
- Transitions are tracked and validated
- Context updates automatically
2. Memory System (Ξ£)
Six persistent files maintain project knowledge:
- Οβ - Requirements and scope
- Οβ - Architecture decisions
- Οβ - Technology stack
- Οβ - Current context
- Οβ - Progress tracking
- Οβ - Protected regions
3. Protection System (Ξ¨)
Multi-level code protection:
- Ξ¨β PROTECTED - Never modify
- Ξ¨β GUARDED - Ask permission
- Ξ¨β INFO - Context notes
- Ξ¨β DEBUG - Temporary code
- Ξ¨β TEST - Test code
- Ξ¨β CRITICAL - Business logic
4. Context System (Ξ)
Eight types of context references:
- Ξβ Files
- Ξβ Folders
- Ξβ Code elements
- Ξβ Documentation
- Ξβ Project rules
- Ξβ Git history
- Ξβ Notepads
- Ξβ Pinned files
5. Permission System (β)
CRUD permissions per mode:
- Create - New files/code
- Read - Access information
- Update - Modify existing
- Delete - Remove content
π― Design Goals
1. Token Efficiency
- Symbolic notation reduces prompt size
- More context fits in token limits
- Faster AI processing
2. Workflow Structure
- Clear phases prevent confusion
- Mode restrictions improve focus
- Systematic approach reduces errors
3. Code Safety
- Protection prevents unwanted changes
- Permissions limit dangerous operations
- Backups ensure recovery
4. Knowledge Persistence
- Memory files track all decisions
- Context preserved across sessions
- Progress never lost
5. Extensibility
- Optional MCP services
- Enterprise BMAD features
- Modular architecture
π How It Works
1. Initialization
/start
Creates memory structure and enters RESEARCH mode.
2. Mode-Driven Workflow
/research β /innovate β /plan β /execute β /review
Each mode enables specific operations.
3. Automatic Tracking
- Memory files update continuously
- Context adjusts per mode
- Protection enforced automatically
4. Symbol Translation
AI interprets symbols:
Ξ©β = πR βΆ β(Ξ©β) βΆ +π[0:3] -π[4:15]
Means: "Research mode with read-only permissions, enabling research functions."
π‘ Key Innovations
1. Compressed Notation
- Greek letters for systems
- Subscripts for indexing
- Emoji for visual recognition
- Mathematical operators for relationships
2. Modal Permissions
- Mode determines allowed operations
- Violations caught automatically
- Safe fallbacks implemented
3. Living Documentation
- Memory files are always current
- Cross-references maintain relationships
- Progress tracked automatically
4. Intelligent Context
- Mode-appropriate context loading
- Relevance-based filtering
- Automatic cleanup
π Benefits
For Developers:
- β Structured workflow prevents mistakes
- β Protection keeps critical code safe
- β Context management improves focus
- β Memory system tracks everything
For AI:
- β Clear operational boundaries
- β Reduced token usage
- β Consistent behavior patterns
- β Better understanding of intent
For Teams:
- β Standardized development process
- β Shared memory across sessions
- β Clear protection boundaries
- β Traceable decision history
π Optional Extensions
MCP Services:
- GitHub (Ξ) - Repository integration
- Web Search (Ξ) - Research capabilities
- Browser (Ξ₯) - Automation testing
- Docker (Ξ) - Container management
BMAD Enterprise:
- Roles (Ξ) - Team member roles
- PRD (Ξ‘) - Requirements management
- Gates (Ξ) - Quality checkpoints
- Enterprise (Ξ) - Advanced features
π Framework Comparison
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 |
π Learning Path
- Start Here β RIPER Modes
- Then β Memory System
- Next β Symbolic Notation
- Finally β Phase Management
π Getting Started
Ready to transform your development workflow?