Command Reference - johnpeterman72/CursorRIPER GitHub Wiki

Command Reference

This page provides a comprehensive reference for all commands and operations available in the CursorRIPER Framework.

Core Commands

Mode Transition Commands

These commands change the current operational mode of the framework.

Command Shorthand Description Requirements
ENTER RESEARCH MODE /research Switch to RESEARCH mode PROJECT_PHASE in ["DEVELOPMENT", "MAINTENANCE"]
ENTER INNOVATE MODE /innovate Switch to INNOVATE mode PROJECT_PHASE in ["DEVELOPMENT", "MAINTENANCE"]
ENTER PLAN MODE /plan Switch to PLAN mode PROJECT_PHASE in ["DEVELOPMENT", "MAINTENANCE"]
ENTER EXECUTE MODE /execute Switch to EXECUTE mode PROJECT_PHASE in ["DEVELOPMENT", "MAINTENANCE"]
ENTER REVIEW MODE /review Switch to REVIEW mode PROJECT_PHASE in ["DEVELOPMENT", "MAINTENANCE"]
BEGIN START PHASE /start Begin or resume START phase None

Phase Transition Commands

These commands change the project phase.

Command Description Requirements
TRANSITION TO MAINTENANCE Switch from DEVELOPMENT to MAINTENANCE PROJECT_PHASE = "DEVELOPMENT"
TRANSITION TO DEVELOPMENT Switch from MAINTENANCE to DEVELOPMENT PROJECT_PHASE = "MAINTENANCE"
CONFIRM RE-INITIALIZATION Allow re-initialization of an existing project After warning about re-initialization

Memory Bank Commands

These commands manage the memory bank.

Command Description Example
UPDATE MEMORY BANK Update all memory files based on recent changes UPDATE MEMORY BANK
UPDATE [filename] Update a specific memory file UPDATE activeContext.md
BACKUP MEMORY BANK Create a backup of the current memory bank BACKUP MEMORY BANK
RESTORE MEMORY BANK [date] Restore memory bank from backup RESTORE MEMORY BANK 20250405_123456
ARCHIVE [component] Archive a framework component ARCHIVE start-phase

Mode-Specific Commands

RESEARCH Mode Commands

Commands specific to information gathering in RESEARCH mode.

Command Description Example
ANALYZE [component] Analyze specific component or file ANALYZE authentication system
DOCUMENT [finding] Document a finding in the memory bank DOCUMENT API authentication flow
DISCOVER [topic] Search for information on a topic DISCOVER database schema
CONNECT [components] Identify connections between components CONNECT user service and auth module

INNOVATE Mode Commands

Commands specific to brainstorming in INNOVATE mode.

Command Description Example
BRAINSTORM [topic] Generate ideas for a topic BRAINSTORM authentication approaches
COMPARE [options] Compare different approaches COMPARE JWT vs session authentication
EVALUATE [approach] Evaluate pros and cons of an approach EVALUATE microservice architecture
CAPTURE [decision] Document a design decision CAPTURE decision to use Redux for state management
PRIORITIZE [ideas] Rank ideas by importance or feasibility PRIORITIZE feature implementation order

PLAN Mode Commands

Commands specific to planning in PLAN mode.

Command Description Example
CREATE PLAN FOR [feature] Create a detailed plan for a feature CREATE PLAN FOR user authentication
CLARIFY [aspect] Request clarification on a specific aspect CLARIFY database schema requirements
DETAIL [step] Provide more detail for a plan step DETAIL implementation of password reset functionality
REVISE PLAN Modify the current plan REVISE PLAN to include email notifications
APPROVE PLAN Indicate plan approval to proceed to EXECUTE APPROVE PLAN

EXECUTE Mode Commands

Commands specific to implementation in EXECUTE mode.

Command Description Example
IMPLEMENT [step] Implement a specific step from the plan IMPLEMENT step 3: create user model
CONTINUE FROM [step] Resume implementation from a specific step CONTINUE FROM step 5
FLAG ISSUE [description] Report an issue during implementation FLAG ISSUE password hashing implementation is unclear
MARK COMPLETE [step] Mark a step as completed MARK COMPLETE step 2
RETURN TO PLAN Switch back to PLAN mode due to issues RETURN TO PLAN

REVIEW Mode Commands

Commands specific to validation in REVIEW mode.

Command Description Example
REVIEW [component] Review a specific component or feature REVIEW authentication implementation
VALIDATE AGAINST [plan] Compare implementation with a specific plan VALIDATE AGAINST authentication plan
IDENTIFY DEVIATIONS Find any deviations from the plan IDENTIFY DEVIATIONS
ACCEPT DEVIATION [description] Accept a specific deviation as necessary ACCEPT DEVIATION alternative password hashing method
VERIFY [aspect] Verify a specific aspect of the implementation VERIFY input validation

START Phase Commands

Commands specific to the START phase of project initialization.

Command Description Example
PROCEED TO NEXT STEP Move to the next step in START phase PROCEED TO NEXT STEP
COMPLETE [step] Mark a specific step as completed COMPLETE Requirements Gathering
REVISIT [step] Return to a previous step REVISIT Technology Selection
ADD REQUIREMENT [description] Add a project requirement ADD REQUIREMENT mobile responsiveness
DEFINE ARCHITECTURE [description] Define system architecture DEFINE ARCHITECTURE microservices with API gateway
SELECT TECHNOLOGY [choice] Choose a technology for the project SELECT TECHNOLOGY React for frontend

Customization Commands

Commands for modifying framework behavior.

Command Description Example
SET [preference] [value] Set a customization preference SET RESPONSE_VERBOSITY "DETAILED"
RESET [preference] Reset a preference to default RESET PLAN_QUESTION_COUNT
ADD CUSTOM COMMAND [alias] [command] Create command shortcut ADD CUSTOM COMMAND "/r" "/research"
EXTEND MODE [mode] [behavior] Add custom behavior to a mode EXTEND MODE RESEARCH "Document API endpoints"
UPDATE CUSTOMIZATION Apply customization changes UPDATE CUSTOMIZATION

Memory Bank Management

File Creation Commands

Command Description Example
CREATE MEMORY FILE [filename] Create a new memory file CREATE MEMORY FILE components.md
INITIALIZE MEMORY BANK Create all required memory files INITIALIZE MEMORY BANK
TEMPLATE [filename] Generate a template for a memory file TEMPLATE featureStatus.md

Content Management Commands

Command Description Example
ADD TO [filename] [section] [content] Add content to a specific section ADD TO progress.md "Known Issues" "Login timeout bug"
UPDATE SECTION [filename] [section] Update a specific section UPDATE SECTION techContext.md "Dependencies"
INCREMENT VERSION [filename] Increase version number of a file INCREMENT VERSION systemPatterns.md
REFRESH [filename] Update timestamp and verify content REFRESH activeContext.md

Backup and Recovery Commands

Command Description Example
LIST BACKUPS Show available memory bank backups LIST BACKUPS
CREATE BACKUP [description] Create named backup CREATE BACKUP "Before refactoring"
RESTORE FROM [backup] Restore specific backup RESTORE FROM "Before refactoring"
COMPARE WITH [backup] Show differences with backup COMPARE WITH 20250405_123456

Project Management Commands

Status Commands

Command Description Example
SHOW STATUS Display current project status SHOW STATUS
SHOW PROGRESS Show implementation progress SHOW PROGRESS
LIST MEMORY FILES List all memory bank files LIST MEMORY FILES
SHOW CURRENT MODE Display current RIPER mode SHOW CURRENT MODE
SHOW FRAMEWORK VERSION Display framework version SHOW FRAMEWORK VERSION

Project Structure Commands

Command Description Example
CREATE COMPONENT [name] Create a new project component CREATE COMPONENT PaymentService
DEFINE PROJECT STRUCTURE Set up project folder structure DEFINE PROJECT STRUCTURE
ADD DEPENDENCY [name] [version] Add project dependency ADD DEPENDENCY react 18.2.0
SETUP ENVIRONMENT [type] Configure development environment SETUP ENVIRONMENT development

Advanced Commands

Framework Management Commands

Command Description Example
UPDATE FRAMEWORK Update to latest framework version UPDATE FRAMEWORK
DOWNGRADE FRAMEWORK [version] Revert to earlier version DOWNGRADE FRAMEWORK 1.0.0
ENABLE FEATURE [feature] Enable optional framework feature ENABLE FEATURE auto-backup
DISABLE FEATURE [feature] Disable framework feature DISABLE FEATURE mode-transitions

Integration Commands

Command Description Example
SYNC WITH [system] Synchronize with external system SYNC WITH Jira
EXPORT MEMORY TO [format] Export memory bank to other format EXPORT MEMORY TO HTML
GENERATE REPORT [type] Create project report GENERATE REPORT progress
IMPORT FROM [source] Import data from external source IMPORT FROM requirements.doc

Diagnostic Commands

Command Description Example
DIAGNOSE FRAMEWORK Check framework for issues DIAGNOSE FRAMEWORK
VERIFY MEMORY INTEGRITY Check memory bank consistency VERIFY MEMORY INTEGRITY
DEBUG MODE [mode] Enable detailed logs for mode DEBUG MODE EXECUTE
REPAIR MEMORY [file] Attempt to fix corrupted memory file REPAIR MEMORY activeContext.md
SHOW LOGS Display framework activity logs SHOW LOGS

Command Usage Examples

Basic Workflow Example

/start
# Complete START phase...

/research
Analyze the current authentication system

/innovate
What approaches could we use to implement password reset functionality?

/plan
Create a detailed plan for implementing password reset

/execute
Implement step 1 of the password reset plan

/review
Verify our password reset implementation against the plan

Memory Bank Management Example

BACKUP MEMORY BANK
# Make changes...

UPDATE activeContext.md
# Modify current focus

UPDATE SECTION progress.md "What's In Progress"
# Update progress on current features

COMPARE WITH 20250405_123456
# See what's changed since backup

RESTORE FROM 20250405_123456
# Revert to backup if needed

Customization Example

SET RESPONSE_VERBOSITY "DETAILED"
# Get more detailed responses

SET PLAN_QUESTION_COUNT 7
# Get more clarifying questions in PLAN mode

ADD CUSTOM COMMAND "/dev" "TRANSITION TO DEVELOPMENT"
# Create shortcut for phase transition

UPDATE CUSTOMIZATION
# Apply changes

Command Format Conventions

  • Commands are case-insensitive but conventionally written in uppercase
  • Parameters are specified in square brackets: [parameter]
  • Optional parameters are specified with question marks: [parameter?]
  • Multiple-choice parameters use pipe symbols: [option1|option2]
  • Commands can be chained with semicolons: COMMAND1; COMMAND2
  • Comments can be added with hash symbols: COMMAND # Comment

Command Context Sensitivity

Commands may behave differently depending on context:

  1. Project Phase Context

    • Some commands only work in specific phases
    • Phase transitions require meeting prerequisites
  2. Mode Context

    • Mode-specific commands only work in their respective modes
    • Mode transitions can be restricted based on state
  3. Memory Bank Context

    • File operations require properly initialized memory bank
    • Some commands reference specific memory file content
  4. Customization Context

    • Command behavior may change based on customization settings
    • Some commands may be enabled/disabled by preferences

CursorRIPER: Adaptive development, persistent intelligence.