-
-
Notifications
You must be signed in to change notification settings - Fork 34
Command Reference
Saros Industries edited this page Jun 28, 2025
·
1 revision
Complete reference for all commands available in the CursorRIPERβ¦Ξ£ framework, organized by category.
| Command | Action | Example |
|---|---|---|
/r |
Research mode | /research |
/i |
Innovate mode | /innovate |
/p |
Plan mode | /plan |
/e |
Execute mode | /execute |
/rev |
Review mode | /review |
!cp |
Add protection | !cp // Critical code |
!af |
Add file context | !af src/main.js |
!ckp |
Check permissions | !ckp |
| Command | Shortcut | Description | Example |
|---|---|---|---|
/research |
/r |
Enter RESEARCH mode | /r |
/innovate |
/i |
Enter INNOVATE mode | /i |
/plan |
/p |
Enter PLAN mode | /p |
/execute |
/e |
Enter EXECUTE mode | /e |
/review |
/rev |
Enter REVIEW mode | /rev |
| Command | Description | Example Output |
|---|---|---|
| Current mode? | Check active mode | [MODE: EXECUTE] |
| Show mode | Display mode info | EXECUTE (Ξ©β): Implementation |
| Command | Level | Description | Example |
|---|---|---|---|
!cp |
PROTECTED | Never modify | !cp // API keys |
!cg |
GUARDED | Ask permission | !cg // Core logic |
!ci |
INFO | Context note | !ci // Config info |
!cd |
DEBUG | Temporary code | !cd // Debug logs |
!ct |
TEST | Test code | !ct // Test fixture |
!cc |
CRITICAL | Business logic | !cc // Payment logic |
// !cp PROTECTED - Description
const SECRET = process.env.SECRET;
// !cp END-P| Command | Type | Description | Example |
|---|---|---|---|
!af |
File | Add file reference | !af src/auth.js |
!ad |
Directory | Add folder reference | !ad src/components/ |
!ac |
Code | Add code reference | !ac validateUser() |
!adoc |
Docs | Add documentation | !adoc "API Guide" |
!ar |
Rules | Add rules reference | !ar "Style Guide" |
!ag |
Git | Add git reference | !ag feature-branch |
!an |
Notepad | Add notepad | !an "Todo List" |
!pf |
Pin | Pin file | !pf config.json |
| Command | Action | Description | Example |
|---|---|---|---|
!cs |
Set status | Update context status | !cs file.js active |
!cr |
Remove | Remove from context | !cr old-file.js |
!cc |
Clear | Clear all context | !cc |
!cm |
Mode context | Set mode defaults | !cm |
-
active- Currently working -
partial- May reference -
essential- Always needed -
deprecated- To be removed
| Command | Description | Example Output |
|---|---|---|
!ckp |
Current mode permissions | EXECUTE: C:β R:β U:β D:~ |
!pm |
Check operation |
!pm write_code β β Allowed
|
!sp |
Show mode permissions |
!sp plan β PLAN: C:β R:β U:~ D:β
|
!vm |
Verify mode for operation |
!vm delete_file β Use EXECUTE
|
| Command | Description | When to Use |
|---|---|---|
/start |
Initialize framework | First time setup |
Initialize |
Same as /start | Alternative command |
| Command | Description | Example Output |
|---|---|---|
Show framework status |
Current state | Phase, mode, progress |
Check memory health |
Memory status | Update frequency, size |
Framework version |
Version info | v1.0.5 |
| Command | Description | Target |
|---|---|---|
Show requirements |
View requirements | Οβ |
Show architecture |
View patterns | Οβ |
Show tech stack |
View technology | Οβ |
Show current focus |
View context | Οβ |
Show progress |
View status | Οβ |
Show protected code |
View registry | Οβ |
| Command | Description | Example |
|---|---|---|
Add requirement |
New requirement | Add requirement: API rate limiting |
Update progress |
Change status | Update progress: Auth 80% complete |
Mark issue resolved |
Close issue | Mark issue Iβ resolved |
Add pattern |
New pattern | Add pattern: Repository pattern |
| Format | Description | Example |
|---|---|---|
[βοΈΟβ:Xα΅’] |
Basic reference | [βοΈΟβ:Rβ] |
[βοΈΟβ:Xα΅’|Ξβ] |
With context | [βοΈΟβ:Rβ|Ξβ] |
[Ξβ:item] |
Context only | [Ξβ:validateUser()] |
| Command | Description | Example |
|---|---|---|
Check references |
Validate links | Finds broken refs |
Update references |
Fix broken links | Updates targets |
List references to X |
Find usage | List references to Rβ |
| Command | Description | Output |
|---|---|---|
Create plan for X |
Generate plan | Numbered checklist |
Detail specifications |
Expand plan | Detailed specs |
Sequence steps |
Order tasks | Priority list |
| Command | Description | Output |
|---|---|---|
Review implementation |
Check code | Pass/fail report |
Verify against plan |
Compare | Deviation list |
Check protection coverage |
Audit | Coverage report |
| Command | Description | When Used |
|---|---|---|
Create backup |
Manual backup | Before risky ops |
List backups |
Show available | Recovery planning |
Restore from backup |
Recovery | After issues |
| Command | Description | Example |
|---|---|---|
Search for X |
Find in project | Search for auth logic |
Find references to Y |
Trace usage | Find references to Rβ |
Locate pattern Z |
Find implementations | Locate Repository pattern |
Research Mode:
/r
What authentication methods are used?
!af src/auth/ # Add auth folder
!ag main # Check git history
Plan Mode:
/p
Create detailed plan for JWT implementation
!ar "Security Standards" # Add standards
The plan will be numbered 1-N
Execute Mode:
/e
Implement step 3 from the plan
!cp # Protect critical parts
!af src/new-file.js # Track new files
Feature Context:
!cc # Clear old
!af src/feature/main.js # Main file
!ac featureLogic() # Core function
!adoc "Feature Spec" # Requirements
Debug Context:
!ag "error message" # Search git
!af error.log # Log file
!ac buggyFunction() # Problem code
| Allowed | Forbidden |
|---|---|
| Read commands | Write commands |
| Search commands | Create commands |
| Analysis commands | Modify commands |
| Allowed | Forbidden |
|---|---|
| All file operations | Web search |
| Code generation | Plan changes |
| Testing | Design decisions |
Combine related commands:
/e && !cm && !af main.js
Set context before requesting:
!af auth.js
!ac validateUser()
"Implement the validation logic"
Add protection inline:
"Create payment processor with !cc protection"
Keep context focused:
# After feature complete
!cc # Clear context
Track your command patterns:
-
/e- Execute mode (35%) -
!af- Add file (20%) -
/r- Research mode (15%) -
!cp- Add protection (10%) -
!cc- Clear context (8%)
- Average commands per feature: 25
- Context commands: 40%
- Mode switches: 20%
- Protection: 15%
- Other: 25%
- Mode switches:
/r,/p,/e - Basic protection:
!cp - Simple context:
!af
- All protection levels
- Context management
- Permission checks
- Cross-references
- Complex patterns
- Command combinations
- Workflow optimization
- Custom shortcuts
| Service | Command | Description |
|---|---|---|
| GitHub | !gr |
Search repos |
| GitHub | !gp |
Push files |
| Search | !ws |
Web search |
| Browser | !pn |
Navigate URL |
| Docker | !dc |
Create container |
| Feature | Command | Description |
|---|---|---|
| Roles | !br |
Switch role |
| PRD | !prdn |
New PRD |
| Gates | !kg |
Check gate |
| Docs | !edg |
Generate docs |
- ποΈ 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