FAQ.md

❓ Frequently Asked Questions (FAQ)

🚀 Getting Started

Q: What is CursorRIPER.sigma and how is it different from the original CursorRIPER?

A: CursorRIPER.sigma is a symbolic, ultra-efficient version of the original CursorRIPER framework. Key differences:

• 93% token reduction through symbolic notation
• Lightweight and fast compared to the verbose original
• Enhanced protection system with intelligent code annotations
• Optional enterprise features (BMAD, Docker MCP)
• Simplified workflow while maintaining all core functionality

Q: Do I need Docker to use CursorRIPER.sigma?

A: No, Docker is completely optional. The framework works perfectly without Docker. Docker MCP integration is only needed if you want:

• Containerized deployments
• Microservices architecture
• Advanced scaling capabilities
• Isolated service environments

Q: What's the difference between CursorRIPER.sigma and CursorRIPER.sigma-lite?

A:

• CursorRIPER.sigma (this version): Full-featured with context management, permissions, and optional enterprise features
• CursorRIPER.sigma-lite: Simplified version without context/permissions, focuses purely on symbolic RIPER modes

---

🛠️ Installation & Setup

Q: I'm getting Node.js version errors. What version do I need?

A: CursorRIPER.sigma requires:

• Node.js 18.0.0+ (recommended: 18 LTS or 20 LTS)
• npm 8.0.0+ or yarn 1.22.0+

Use nvm to manage Node.js versions:

nvm install 18
nvm use 18

Q: Installation fails with permission errors. How do I fix this?

A: This is usually an npm permissions issue:

Option 1 (Recommended):

mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc

Option 2:

npx create-cursoriper-app my-project

Option 3:

sudo npm install -g @cursoriper/cli --unsafe-perm

Q: Can I install CursorRIPER.sigma without global installation?

A: Yes! You can use npx for one-time usage:

npx @cursoriper/cli init my-project
cd my-project
npm start

---

🏢 BMAD Enterprise

Q: Do I need BMAD Enterprise features?

A: BMAD Enterprise is optional and designed for:

• Business model development teams
• Enterprise organizations needing role-based access
• Compliance-required environments
• Multi-tenant applications

For individual developers or small teams, the core framework is sufficient.

Q: Can I enable BMAD features later?

A: Yes! BMAD can be enabled at any time:

// framework.config.js
module.exports = {
  modules: {
    bmad: {
      enabled: true,
      config: {
        // BMAD configuration
      }
    }
  }
};

Q: What databases does BMAD support?

A: BMAD supports multiple databases:

• SQLite (development)
• PostgreSQL (recommended for production)
• MySQL/MariaDB
• MongoDB (for document storage)

---

🔧 Troubleshooting

Q: The framework won't start. What should I check first?

A: Follow this checklist:

1. Node.js version: node --version (should be 18+)
2. Dependencies: npm install or yarn install
3. Configuration: Check framework.config.js exists
4. Environment: Verify .env file has required variables
5. Logs: Check logs/framework.log for specific errors

Q: I'm getting "Module not found" errors. How do I fix this?

A: Try these solutions in order:

# 1. Clear and reinstall dependencies
rm -rf node_modules package-lock.json
npm cache clean --force
npm install

# 2. Verify framework installation
npm list @cursoriper/core

# 3. Clear framework cache
npm run framework:clear-cache

# 4. Reinstall framework
npm run framework:reinstall

Q: Performance is slow. How can I optimize it?

A: Common optimization steps:

1. Enable caching: Configure Redis for better performance
2. Database optimization: Add indexes and optimize queries
3. Memory settings: Increase Node.js heap size
4. Production mode: Set NODE_ENV=production
5. Load balancing: Use PM2 cluster mode

See our Performance Troubleshooting Guide for detailed solutions.

---

🐳 Docker & Deployment

Q: How do I deploy CursorRIPER.sigma to production?

A: We recommend this production setup:

1. With Docker (recommended):

   docker-compose -f docker-compose.prod.yml up -d

2. With PM2:

   pm2 start ecosystem.config.js --env production

3. With systemd (Linux):

   sudo systemctl start cursoriper-framework

See our Deployment Guide for complete instructions.

Q: Can I use CursorRIPER.sigma with existing Docker setups?

A: Yes! The framework is designed to integrate with existing Docker environments:

• Standalone containers
• Docker Compose stacks
• Kubernetes clusters
• Docker Swarm

Q: What's the difference between development and production configurations?

A: Key differences:

Feature	Development	Production
Database	SQLite	PostgreSQL/MySQL
Caching	Memory	Redis
SSL	Optional	Required
Logging	Console	Files + Rotation
Debug	Enabled	Disabled
Clustering	Single process	PM2 cluster

---

🔐 Security & Authentication

Q: How secure is CursorRIPER.sigma?

A: The framework includes multiple security layers:

• JWT-based authentication with secure token handling
• Role-based access control (RBAC) system
• CORS protection with configurable origins
• Security headers (HSTS, CSP, etc.)
• Input validation and sanitization
• SQL injection protection
• Rate limiting and DDoS protection

Q: Can I integrate with existing authentication systems?

A: Yes! CursorRIPER.sigma supports:

• SAML 2.0 integration
• OAuth 2.0/OpenID Connect
• LDAP/Active Directory
• Custom authentication providers

Q: How do I configure SSL/HTTPS?

A: For production HTTPS setup:

// framework.config.js
module.exports = {
  server: {
    ssl: {
      enabled: true,
      cert: '/path/to/certificate.crt',
      key: '/path/to/private.key',
      ca: '/path/to/ca-bundle.crt' // Optional
    }
  }
};

---

🔄 Migration & Updates

Q: How do I migrate from the original CursorRIPER to CursorRIPER.sigma?

A: We provide migration tools and guides:

1. Automatic migration: Use our migration utility
2. Manual migration: Follow our step-by-step guide
3. Hybrid approach: Gradual migration over time

See our Migration Guide for detailed instructions.

Q: How do I update to a new version?

A: Follow our update process:

# 1. Backup current installation
npm run framework:backup

# 2. Update framework
npm update @cursoriper/core

# 3. Run migrations if needed
npm run framework:migrate

# 4. Restart application
npm restart

Q: Will updates break my existing project?

A: We follow semantic versioning:

• Patch updates (1.0.x): Bug fixes, no breaking changes
• Minor updates (1.x.0): New features, backward compatible
• Major updates (x.0.0): May include breaking changes

Check our Breaking Changes document before major updates.

---

💡 Best Practices

Q: What are the recommended project structure conventions?

A: We recommend this structure:

my-project/
├── src/
│   ├── modules/          # Custom modules
│   ├── plugins/          # Custom plugins
│   ├── services/         # Business logic
│   └── utils/            # Utility functions
├── config/
│   ├── development.js    # Dev configuration
│   ├── production.js     # Prod configuration
│   └── framework.config.js
├── tests/
├── docs/
└── logs/

Q: How should I organize large projects?

A: For large projects, consider:

• Modular architecture with separate modules
• Microservices using Docker MCP integration
• Feature-based directory structure
• Shared libraries for common functionality

Q: What monitoring should I set up for production?

A: Essential monitoring includes:

• Application metrics (response times, error rates)
• System metrics (CPU, memory, disk)
• Database performance (query times, connections)
• User activity and business metrics
• Log aggregation and alerting

---

🆘 Getting Help

Q: Where can I get help if I'm stuck?

A: Multiple support channels available:

1. Documentation: Start with our Troubleshooting Guide
2. Community: GitHub Discussions
3. Issues: GitHub Issues
4. Email Support: support@cursoriper.com
5. Emergency: emergency@cursoriper.com (production issues)

Q: How do I report a bug?

A: Please include:

• Framework version: npm list @cursoriper/core
• Node.js version: node --version
• Operating system: Windows/macOS/Linux version
• Error messages: Full stack traces
• Steps to reproduce: Minimal example
• Expected vs actual behavior

Q: Can I contribute to the project?

A: Absolutely! See our Contributing Guide for:

• Code contributions (features, bug fixes)
• Documentation improvements
• Testing and quality assurance
• Community support and moderation

Q: Is there commercial support available?

A: Yes, we offer:

• Priority support with SLA guarantees
• Custom development and consulting
• Training and onboarding for teams
• Enterprise agreements with dedicated support

Contact: enterprise@cursoriper.com

---

📈 Performance & Scaling

Q: How many users can CursorRIPER.sigma handle?

A: Performance depends on your setup:

• Single instance: 100-500 concurrent users
• PM2 cluster: 1,000-5,000 concurrent users
• Docker scaled: 10,000+ concurrent users
• Kubernetes: Virtually unlimited with proper scaling

Q: What are the resource requirements?

A: Minimum requirements:

• Development: 2GB RAM, 1 CPU core
• Small production: 4GB RAM, 2 CPU cores
• Medium production: 8GB RAM, 4 CPU cores
• Large production: 16GB+ RAM, 8+ CPU cores

Q: How do I monitor performance in production?

A: We provide built-in monitoring:

• Prometheus metrics at /metrics
• Health checks at /health
• Application dashboards with Grafana
• Log analysis with ELK stack

---

Last Updated: June 28, 2025
Framework Version: CursorRIPER.sigma v1.0+

Need more help? Check our Support Channels or visit our Troubleshooting Guide.