Skip to content

Latest commit

 

History

History
655 lines (542 loc) · 22.3 KB

File metadata and controls

655 lines (542 loc) · 22.3 KB

CursorRIPER♦Σ

🔣 CursorRIPER Σ Comprehensive Symbol Reference Guide

v3.0 | Created: 2025-04-10 | Updated: 2025-06-27

🆕 What's New in v3.0

  • Added MCP service integrations: GitHub (Θ), Web Search (Λ), Puppeteer (Υ), Docker (Ξ)
  • Added BMAD-Method integration: Roles (Β), PRD (Ρ), Gates (Κ), Enterprise (Ε)
  • Extended reference map (ℜ) with all new services
  • Added comprehensive command shortcuts for all systems

📁 File Symbols

Symbol Description
📂 /memory-bank/
📦 /memory-bank/backups/
σ₁ projectbrief.md
σ₂ systemPatterns.md
σ₃ techContext.md
σ₄ activeContext.md
σ₅ progress.md
σ₆ protection.md

🔄 Mode & Phase Symbols

Symbol Emoji Description
Ω₁ 🔍 RESEARCH mode
Ω₂ 💡 INNOVATE mode
Ω₃ 📝 PLAN mode
Ω₄ ⚙️ EXECUTE mode
Ω₅ 🔎 REVIEW mode
Π₁ 🌱 UNINITIATED phase
Π₂ 🚧 INITIALIZING phase
Π₃ 🏗️ DEVELOPMENT phase
Π₄ 🔧 MAINTENANCE phase

🛡️ Protection Symbols (Ψ)

Symbol Description
Ψ₁ PROTECTED - Do not modify
Ψ₂ GUARDED - Ask before modifying
Ψ₃ INFO - Context note
Ψ₄ DEBUG - Debugging code
Ψ₅ TEST - Testing code
Ψ₆ CRITICAL - Business logic

📎 Context Symbols (Γ)

Symbol Emoji Cursor Symbol Description
Γ₁ 📄 @Files File reference
Γ₂ 📁 @Folders Folder reference
Γ₃ 💻 @Code Code reference
Γ₄ 📚 @Docs Documentation reference
Γ₅ 📏 @Cursor Rules Project rules reference
Γ₆ 🔄 @Git Git history reference
Γ₇ 📝 @Notepads Notepad reference
Γ₈ 📌 #Files File context without reference
Γ₉ 🗃️ @Filesystem Filesystem reference

📁 Filesystem Symbols (Φ)

Symbol Description
Φ_fs MCP Filesystem operations set
Φ_fs.read Read file content
Φ_fs.read_multi Read multiple files
Φ_fs.write Write to file
Φ_fs.edit Edit file content
Φ_fs.create_dir Create directory
Φ_fs.list List directory contents
Φ_fs.tree Get directory tree structure
Φ_fs.move Move or rename file/directory
Φ_fs.search Search for files/patterns
Φ_fs.info Get file metadata
Φ_fs.allowed List allowed directories

🔐 Permission Symbols (ℙ)

Symbol Description
{C: create, R: read, U: update, D: delete} - CRUD permissions
ℙ(Ω₁) {R: ✓, C: ✗, U: ✗, D: ✗} - Research mode permissions
ℙ(Ω₂) {R: ✓, C: ~, U: ✗, D: ✗} - Innovate mode permissions
ℙ(Ω₃) {R: ✓, C: ✓, U: ~, D: ✗} - Plan mode permissions
ℙ(Ω₄) {R: ✓, C: ✓, U: ✓, D: ~} - Execute mode permissions
ℙ(Ω₅) {R: ✓, C: ✗, U: ✗, D: ✗} - Review mode permissions

🔍 Filesystem Permission Matrix (ℙΦ)

Mode Read Create Update Delete Description
Ω₁ (Research) Read-only access
Ω₂ (Innovate) ~ Read with conceptual creation
Ω₃ (Plan) ~ Read/create with limited updates
Ω₄ (Execute) ~ Full access with limited deletion
Ω₅ (Review) Read-only access

🔍 Operation Sets (𝕆)

Symbol Description
𝕆ᵣₑₐₗ {modify_files, write_code, delete_content, refactor} - Real operations
𝕆ᵥᵢᵣₜᵤₐₗ {suggest_ideas, explore_concepts, evaluate_approaches} - Virtual operations
𝕆ₒᵦₛₑᵣᵥₑ {read_files, analyze_content, identify_patterns} - Observe operations
𝕆fs_read {read, read_multi, list, tree, search, info, allowed} - Filesystem read operations
𝕆fs_create {write, create_dir} - Filesystem create operations
𝕆fs_update {edit, move} - Filesystem update operations
𝕆fs_delete {delete} - Filesystem delete operations

📊 Status Indicators

Symbol Description
Complete/Done
In Progress
🔜 Planned/Upcoming
⚠️ Warning/Risk
Blocked/Failed
🟢 Active context
🟡 Partially relevant context
🔴 Deprecated/removed context
🟣 Essential/core context
Permitted operation
Forbidden operation
~ Conditional/Limited operation

🏷️ Common Indexing

Pattern Description
R₁, R₂... Requirements
F₁, F₂... Features
T₁, T₂... Tasks
D₁, D₂... Decisions
I₁, I₂... Issues
M₁, M₂... Milestones
P₁, P₂... Protected Regions
C₁, C₂... Context References
O₁, O₂... Operations

🧮 Mathematical Operators

Symbol Description
Leads to/Results in
AND (logical)
OR (logical)
¬ NOT (logical)
Bi-directional relationship
One-way relationship/transition
Intersection/overlap
Union/combine
Element of/belongs to
Not an element of

🛠️ Protection Commands

Command Description
!cp Add PROTECTED comment
!cg Add GUARDED comment
!ci Add INFO comment
!cd Add DEBUG comment
!ct Add TEST comment
!cc Add CRITICAL comment

🔍 Context Commands

Command Function Description
!af Add File Add file reference to context
!ad Add Directory Add folder reference to context
!ac Add Code Add code reference to context
!adoc Add Doc Add documentation reference to context
!ar Add Rule Add rule reference to context
!ag Add Git Add git reference to context
!an Add Notepad Add notepad reference to context
!pf Pin File Pin file to context without reference
!afs Add Filesystem Add filesystem reference to context
!cs Context Status Set context reference status
!cr Context Remove Remove context reference
!cc Context Clear Clear all context references
!cm Context Mode Set context for current mode

🔐 Permission Commands

Command Description
!ckp Check permissions for current mode
!pm Check if operation is permitted
!sp Show permissions for specified mode
!vm Verify mode appropriate for operation

🐙 GitHub Commands (SΘ)

Command Function Description
!gr search_repositories Search GitHub repositories
!gc create_repository Create new repository
!gp push_files Push files to repository
!gpr create_pull_request Create pull request
!gi create_issue Create new issue
!gb create_branch Create new branch
!gm merge_pull_request Merge pull request

🔍 Web Search Commands (SΛ)

Command Function Description
!ws brave_web_search Search the web
!wl brave_local_search Search local businesses
!wf fetch_url Fetch URL content
!wc clear cache Clear search cache
!wh show history Show search history

🎭 Browser Commands (SΥ)

Command Function Description
!pn navigate Navigate to URL
!ps screenshot Take screenshot
!pc click Click element
!pf fill Fill form field
!pt start test Start test recording
!pe end test End test recording
!pg get content Get page content

🐳 Docker Commands (SΞ)

Command Function Description
!dc create container Create new container
!dd deploy compose Deploy compose stack
!dl get logs Get container logs
!dls list containers List all containers
!ds stop container Stop container
!dr remove container Remove container

👥 BMAD Role Commands (S_roles)

Command Function Description
!br switch_role Switch active role
!bra show artifacts Show role artifacts
!brp show permissions Show role permissions
!brg show gates Show allowed gates
!brh role history Show role history
!brs role suggestions Suggest role for mode

📄 PRD Commands (S_prd)

Command Function Description
!prd open_active_prd Open active PRD
!prdn create_new_prd Create new PRD
!prda archive_prd Archive current PRD
!prds show_status Show PRD status
!prdv validate_prd Validate PRD components
!prdc check_complete Check PRD completeness
!prdh prd_history Show PRD history

🚦 Gate Commands (S_gates)

Command Function Description
!kg check_gate Check current gate
!kga approve_gate Approve gate
!kgc view_checklist View gate checklist
!kgb show_blockers Show gate blockers
!kgh gate_history Show gate history
!kgr request_approval Request gate approval
!kgs skip_gate Skip gate (emergency)

🏢 Enterprise Commands (S_enterprise)

Command Function Description
!edg generate_docs Generate all docs
!edgt generate_tech Generate tech docs
!edga generate_api Generate API docs
!edgu generate_user Generate user guide
!evb bump_version Bump version
!evt create_tag Create version tag
!evc view_changelog View changelog
!ecr compliance_report Compliance report
!ecs compliance_score Compliance score
!ecg compliance_gaps Compliance gaps
!eal audit_search Search audit logs
!ear audit_report Generate audit report
!eaa audit_alerts Configure audit alerts

📁 Filesystem Commands (SΦ)

Command Function Description
!fr Φ_fs.read Read file content
!fm Φ_fs.read_multi Read multiple files
!fw Φ_fs.write Write to file
!fe Φ_fs.edit Edit file content
!fc Φ_fs.create_dir Create directory
!fl Φ_fs.list List directory contents
!ft Φ_fs.tree Get directory tree structure
!fv Φ_fs.move Move or rename file/directory
!fs Φ_fs.search Search for files/patterns
!fi Φ_fs.info Get file metadata
!fa Φ_fs.allowed List allowed directories

🔄 Mode-Context Mapping

Mode Symbol Default Context Description
RESEARCH 🔍 Ω₁ [Γ₄, Γ₂, Γ₆, Γ₉] Docs, Folders, Git, Filesystem
INNOVATE 💡 Ω₂ [Γ₃, Γ₄, Γ₇] Code, Docs, Notepads
PLAN 📝 Ω₃ [Γ₁, Γ₂, Γ₅, Γ₉] Files, Folders, Rules, Filesystem
EXECUTE ⚙️ Ω₄ [Γ₃, Γ₁, Γ₈, Γ₉] Code, Files, Pinned Files, Filesystem
REVIEW 🔎 Ω₅ [Γ₃, Γ₁, Γ₆, Γ₉] Code, Files, Git, Filesystem

🛡️ Filesystem Protection Levels (ΨΦ)

Level Name Operations Description
ψ₁ Public All operations Full access
ψ₂ Visible read, list, search, info Read and list only
ψ₃ Limited read, info Basic read only
ψ₄ Private info Metadata only
ψ₅ Restricted none No access
ψ₆ Forbidden none No access, enforced

🐙 GitHub Symbols (Θ)

Symbol Description
Θ GitHub operations set
Θ_ops GitHub operation mappings
Mode-specific GitHub restrictions
ℙΘ GitHub permission matrix
GitHub command shortcuts

🔍 Web Search Symbols (Λ)

Symbol Description
Λ Web search operations set
Λ_ops Search operation mappings
Mode-specific search restrictions
ℙΛ Search permission matrix
Search command shortcuts
Γ₁₀ Search results context
Γ₁₁ Search history context

🎭 Puppeteer/Playwright Symbols (Υ)

Symbol Description
Υ Browser automation operations set
Υ_ops Browser operation mappings
Mode-specific browser restrictions
ℙΥ Browser permission matrix
Browser command shortcuts
ΨΥ Browser protection levels

🐳 Docker Symbols (Ξ)

Symbol Description
Ξ Container operations set
Ξ_ops Docker operation mappings
Mode-specific Docker restrictions
ℙΞ Docker permission matrix
Docker command shortcuts
ΔΞ Docker safety protocols

👥 BMAD Role Symbols (Β)

Symbol Description
Β BMAD role system
Β₁ Product Owner role
Β₂ Architect role
Β₃ Developer role
Β₄ QA Engineer role
Β₅ DevOps role
Γ_roles Role context integration

📄 PRD Symbols (Ρ)

Symbol Description
Ρ PRD component system
Ρ₁ Business Objectives
Ρ₂ Functional Requirements
Ρ₃ Technical Constraints
Ρ₄ User Stories
Ρ₅ Acceptance Criteria
Ρ₆ Success Metrics
Ρ_state PRD state management

🚦 Quality Gate Symbols (Κ)

Symbol Description
Κ Quality gate system
Κ₁ PRD Approval Gate
Κ₂ Design Review Gate
Κ₃ Code Review Gate
Κ₄ QA Signoff Gate
Κ₅ Deployment Approval Gate

🏢 Enterprise Symbols (Ε)

Symbol Description
Ε Enterprise feature system
Ε_docs Documentation system
Ε_version Versioning system
Ε_compliance Compliance system
Ε_audit Audit system

🔗 Cross-Reference Notation

Reference Type Syntax Example Description
Standard [↗️σₙ:Xᵢ] [↗️σ₁:R₁] Reference to item in memory file
With Context [↗️σₙ:Xᵢ|Γₘ] [↗️σ₁:R₁|Γ₃] Reference with context
Context-only [Γₙ:item] [Γ₃:validate()] Direct context reference
Protection+Context [Ψₙ+Γₘ:item] [Ψ₁+Γ₃:auth()] Protected context reference
Permission [ℙ(Ω₁):read_only] [ℙ(Ω₁):read_only] Reference to mode permissions
Operation Set [𝕊(Ω₄):𝕆ᵣₑₐₗ] [𝕊(Ω₄):𝕆ᵣₑₐₗ] Reference to mode operations
Filesystem [Γ₉:path/to/file.js] [Γ₉:src/main.js] Filesystem path reference
Filesystem Operation [Φ_fs.read:path] [Φ_fs.read:config.json] Filesystem operation reference

🛡️ Protection-Context Integration

Symbol Combination Description
🔒💻 Ψ₁ + Γ₃ Protected code
🛡️💻 Ψ₂ + Γ₃ Guarded code
ℹ️💻 Ψ₃ + Γ₃ Info code
🐞💻 Ψ₄ + Γ₃ Debug code
🧪💻 Ψ₅ + Γ₃ Test code
⚠️💻 Ψ₆ + Γ₃ Critical code
🔒🗃️ Ψ₁ + Γ₉ Protected filesystem path
🛡️🗃️ Ψ₂ + Γ₉ Guarded filesystem path

📊 Context Operations

Operation Syntax Description
Intersection Γₙ ∩ Γₘ Context elements common to both
Union Γₙ ∪ Γₘ Combined context elements
Difference Γₙ \ Γₘ Context difference operation
Apply to Mode Γₙ → Ωₘ Applying context to mode
Apply to Protection Γₙ → Ψₘ Applying context to Protection level
Store in Memory Γₙ ⟶ σₘ Storing context in memory file

📐 Context Functions (ΦΓ)

Function Syntax Description
ΦΓ₁ expand(Γₙ) Full context expansion
ΦΓ₂ filter(Γₙ, criteria) Filtered context
ΦΓ₃ persist(Γₙ, 📂) Save context to memory
ΦΓ₄ retrieve(Γₙ, 📂) Load context from memory
ΦΓ₅ rank(Γₙ, relevance) Prioritize context

📁 Filesystem Functions (Υ_fs)

Function Syntax Description
Υ_fs.validate_path validate_path(path) Validate file path exists and is allowed
Υ_fs.validate_content validate_content(content) Validate content safety and size
Υ_fs.validate_operation validate_operation(op, Ω) Validate operation is permitted in mode
execute_fs_op execute_fs_op(op, ...args) Execute filesystem operation with validation
has_mcp_filesystem has_mcp_filesystem() Check if MCP filesystem is available

🔄 Context Transition Functions

Transition Syntax Description
Mode transition Ω₁ → Ω₂ ⟶ MΓ₁ → MΓ₂ Update context during mode switch
Version change Γ₁ → Γ₁' Context version change
Apply protection Ψₙ(Γₘ) ⟶ PΓₙ Apply protection to context

🧩 @ Memory Integration (σΓ)

Integration Description
σΓ₁ activeContext.md + Γ section
σΓ₂ activeContext.contextReferences = [Γ₁...Γₙ]
σΓ₃ Φ_symbol_persist(Γ₁...Γₙ, 📂) = persist @ references

📝 Context Usage Examples

// Add specific file to context
!af src/main.js

// Add filesystem path to context
!afs /path/to/project/

// Add code element with status
!ac validateUser()
!cs validateUser() essential

// Apply mode-specific context
!cm

// Cross-reference with context
Requirement [↗️σ₁:R₁|Γ₃:auth()] specifies...

// Reference protected code
The 🔒💻 auth() function should not be modified

// Apply context persistence
ΦΓ₃(Γ₃, 📂) // Save code context to memory

// Filter context by criteria
ΦΓ₂(Γ₃, "validate") // Filter code context for validation functions

// Check permissions for current mode
!ckp

// Verify if operation is permitted in current mode
!pm modify_files

📁 Filesystem Usage Examples

// Read a file
!fr("path/to/file.js")

// List directory contents
!fl("src/components")

// Search for JavaScript files
!fs("src", "*.js")

// Write to a file (Execute mode only)
!fw("output.txt", "File content")

// Get file metadata
!fi("config.json")

// Create directory (Plan or Execute mode)
!fc("new-directory")

// Reference a filesystem path in cross-reference
The implementation in [Γ₉:src/utils/helpers.js] handles this case

📋 Implementation Examples

Memory File Updates Integration

// Add to activeContext.md template
## 🔮 Context References
- Active Files: [fileA, fileB, ...]
- Active Code: [functionA, classB, ...]
- Active Docs: [docX, docY, ...]
- Active Filesystem: [path1, path2, ...]
- Context Command: !ac functionA

Context Persistence Implementation

Φ_context = {
  active_references: [],
  add_reference(type, name) = {
    active_references.push({type, name, added: now()})
    update_file(𝕄[3], format(active_references))
  },
  clear_references() = {
    active_references = []
    update_file(𝕄[3], "")
  }
}

Filesystem Operation Validation

execute_fs_op(op, ...args) = {
  if (!has_mcp_filesystem()) {
    return report_error("MCP Filesystem not available")
  }
  
  if (Υ_fs.validate_operation(op, current_mode)) {
    if (is_destructive(op)) {
      warn("This operation will modify files") ∧ 
      confirm ∧ 
      Σ_backup.create_backup()
    }
    return op(...args)
  } else {
    return block_operation(op, "Operation not permitted")
  }
}

Mode Transitions with Context Implementation

Ω₁ → Ω₂ = {
  backup_context(),
  update_mode(Ω₂),
  apply_default_context(MΓ₂),
  update_file(𝕄[3])
}

🔢 Indexing Array (𝕋)

Index Function Description
𝕋[0] read_files Read and analyze project files
𝕋[1] ask_questions Ask questions about project requirements
𝕋[2] observe_code Observe and understand existing code
𝕋[3] document_findings Document research findings
𝕋[4] suggest_ideas Suggest innovative ideas
𝕋[5] explore_options Explore potential approaches
𝕋[6] evaluate_approaches Evaluate different approaches
𝕋[7] create_plan Create project implementation plan
𝕋[8] detail_specifications Detail technical specifications
𝕋[9] sequence_steps Create step sequence for implementation
𝕋[10] implement_code Implement code according to plan
𝕋[11] follow_plan Follow the implementation plan
𝕋[12] test_implementation Test the implemented solution
𝕋[13] validate_output Validate output against requirements
𝕋[14] verify_against_plan Verify implementation against plan
𝕋[15] report_deviations Report any deviations from plan

Mode-Function Mapping

Mode Active Functions Inactive Functions Description
🔍 RESEARCH (Ω₁) +𝕋[0:3] -𝕋[4:15] Use research functions only
💡 INNOVATE (Ω₂) +𝕋[4:6] -𝕋[8:15] Use ideation functions only
📝 PLAN (Ω₃) +𝕋[7:9] -𝕋[10:15] Use planning functions only
⚙️ EXECUTE (Ω₄) +𝕋[10:12] -[improve,create,deviate] Use implementation functions only
🔎 REVIEW (Ω₅) +𝕋[13:15] -[modify,improve] Use review functions only

Function Activation Syntax

// Examples of function activation rules:
+𝕋[0:3] = Activate functions 0, 1, 2, 3
-𝕋[4:15] = Deactivate functions 4 through 15
+𝕋[7] = Activate function 7 only
-[improve,create,deviate] = Deactivate specific operations

This comprehensive reference guide consolidates all symbolic notation for the CursorRIPER Σ framework