SuperClaude/docs/reference

SuperClaude Framework Reference Documentation

Navigation Hub: Structured learning paths and technical references for all skill levels.

Documentation Status: ✅ Status: Current - All content verified for accuracy and completeness.

How to Use This Reference Library

This documentation is organized for progressive learning with multiple entry points:

• 📱 Quick Reference: Jump to specific solutions for immediate needs
• 📚 Learning Paths: Structured progression from beginner to expert
• 🔍 Problem-Solving: Targeted troubleshooting and diagnostic guidance
• ⚡ Performance: Optimization patterns and advanced techniques

Verification Standards: All examples tested, commands validated, patterns proven in real-world usage.

---

Documentation Navigation Matrix

Document	Purpose	Target Audience	Complexity
basic-examples.md	Copy-paste ready commands and patterns	All users, quick reference	Basic
examples-cookbook.md	Recipe collection hub and organization	All users, navigation	Reference
common-issues.md	Essential troubleshooting and solutions	All users, problem-solving	Basic	As needed
mcp-server-guide.md	MCP server configuration and usage	Technical users, integration	Intermediate

| advanced-patterns.md | Expert coordination and orchestration | Experienced users | Advanced | | | advanced-workflows.md | Complex multi-agent orchestration | Expert users | Advanced | | | integration-patterns.md | Framework and system integration | Architects, experts | Advanced | | | troubleshooting.md | Comprehensive diagnostic guide | All levels, deep debugging | Variable | As needed | | diagnostic-reference.md | Advanced debugging and analysis | Expert users, complex issues | Advanced | |

---

Recommended Learning Paths

New Users (Week 1 Foundation)

Goal: Establish confident SuperClaude usage with essential workflows

Day 1-2: ../getting-started/quick-start.md
   ↓ Foundation building and first commands
Day 3-4: basic-examples.md  
   ↓ Practical application and pattern recognition
Day 5-7: common-issues.md
   ↓ Problem resolution and confidence building

Success Metrics: Can execute basic commands, manage sessions, resolve common issues independently.

Intermediate Users (Week 2-3 Enhancement)

Goal: Master coordination patterns and technical depth

Week 2: advanced-patterns.md
   ↓ Multi-agent coordination and orchestration mastery
Week 3: mcp-server-guide.md + advanced-workflows.md
   ↓ Performance excellence and technical configuration

Success Metrics: Can orchestrate complex workflows, optimize performance, configure MCP servers.

Expert Users (Advanced Mastery)

Goal: Complete framework mastery and complex system integration

Phase 1: advanced-workflows.md
   ↓ Complex orchestration and enterprise patterns
Phase 2: integration-patterns.md
   ↓ Framework integration and architectural mastery
Phase 3: diagnostic-reference.md
   ↓ Advanced debugging and system analysis

Success Metrics: Can design custom workflows, integrate with any framework, diagnose complex issues.

Problem-Solving Path (As Needed)

Goal: Immediate issue resolution and diagnostic guidance

Quick Issues: common-issues.md
   ↓ Common problems and immediate solutions
Complex Debugging: troubleshooting.md
   ↓ Comprehensive diagnostic approach  
Advanced Analysis: diagnostic-reference.md
   ↓ Expert-level debugging and analysis

---

Command Quick Reference

Essential SuperClaude Commands

Command Pattern	Purpose	Example
/sc:load	Restore session context	/sc:load project_name
/sc:save	Preserve session state	/sc:save "milestone checkpoint"
--think	Enable structured analysis	--think analyze performance bottlenecks
--brainstorm	Collaborative requirement discovery	--brainstorm new authentication system
--task-manage	Multi-step operation orchestration	--task-manage refactor user module

Performance & Efficiency Flags

Flag	Purpose	Best For
--uc / --ultracompressed	Token-efficient communication	Large operations, context pressure
--orchestrate	Optimize tool selection	Multi-tool operations, performance needs
--loop	Iterative improvement cycles	Code refinement, quality enhancement
--validate	Pre-execution risk assessment	Production environments, critical operations

MCP Server Activation

Flag	Server	Best For
--c7 / --context7	Context7	Official documentation, framework patterns
--seq / --sequential	Sequential	Complex analysis, debugging, system design
--magic	Magic	UI components, design systems, frontend work
--morph / --morphllm	Morphllm	Bulk transformations, pattern-based edits
--serena	Serena	Symbol operations, project memory, large codebases
--play / --playwright	Playwright	Browser testing, E2E scenarios, visual validation

---

Framework Integration Quick Start

React/Next.js Projects

# Initialize with React patterns
--c7 --magic "implement Next.js authentication with TypeScript"

# Component development workflow  
--magic --think "create responsive dashboard component"

Node.js/Express Backend

# API development with best practices
--c7 --seq "design RESTful API with Express and MongoDB"

# Performance optimization
--think --orchestrate "optimize database queries and caching"

Full-Stack Development

# Complete application workflow
--task-manage --all-mcp "build full-stack e-commerce platform"

# Integration testing
--play --seq "implement end-to-end testing strategy"

---

Problem-Solving Quick Reference

Immediate Issues

• Command not working: Check common-issues.md → Common SuperClaude Problems
• Session lost: Use /sc:load → See Session Management
• Flag confusion: Check basic-examples.md → Flag Usage Examples

Development Blockers

• Performance slow: See Advanced Workflows → Performance Patterns
• Complex debugging: Use troubleshooting.md → Systematic Debugging
• Integration issues: Check integration-patterns.md → Framework Patterns

System-Level Issues

• Architecture problems: Use advanced-workflows.md → System Design
• Expert debugging: Apply diagnostic-reference.md → Advanced Analysis
• Custom workflow needs: Study advanced-patterns.md → Custom Orchestration advanced-patterns.md → Custom Orchestration

---

Documentation Health & Verification

Quality Assurance

• ✅ Commands Tested: All examples tested and functional
• ✅ Patterns Proven: Real-world usage validation in production environments
• ✅ Cross-References: Internal links verified and maintained
• ✅ Regular Updates: Documentation synchronized with framework evolution

Accuracy Standards

• Command Syntax: Verified against latest SuperClaude implementation
• Flag Behavior: Tested in multiple scenarios and environments
• MCP Integration: Confirmed compatibility with current MCP server versions
• Performance Claims: Benchmarked and measured in realistic conditions

Reporting Issues

Found outdated information or broken examples?

1. Quick Fixes: Check common-issues.md first
2. Documentation Bugs: Report via project issues with specific file and line
3. Missing Patterns: Suggest additions with use case description
4. Verification Requests: Request re-testing of specific examples

---

Expert Tips for Maximum Productivity

Daily Workflow Optimization

1. Session Management: Always start with /sc:load, end with /sc:save
2. Flag Combinations: Combine complementary flags: --think --c7 for documented analysis
3. Progressive Complexity: Start simple, add sophistication incrementally
4. Tool Specialization: Match tools to tasks: Magic for UI, Sequential for analysis

Learning Acceleration

1. Follow the Paths: Use recommended learning sequences for structured growth
2. Practice Patterns: Repeat common workflows until they become intuitive
3. Experiment Safely: Use feature branches and checkpoints for exploration
4. Community Learning: Share discoveries and learn from others' approaches

Troubleshooting Mastery

1. Systematic Approach: Always start with common-issues.md
2. Evidence Gathering: Use --think for complex problem analysis
3. Root Cause Focus: Address underlying issues, not just symptoms
4. Documentation First: Check official docs before experimental solutions

---

Advanced Resources & Integration

Framework-Specific Guides

• React/Next.js: See integration-patterns.md → React Integration
• Vue/Nuxt: See integration-patterns.md → Vue Ecosystem
• Node.js/Express: See integration-patterns.md → Backend Patterns
• Python/Django: See integration-patterns.md → Python Workflows

Specialized Workflows

• DevOps Integration: advanced-workflows.md → CI/CD Patterns
• Testing Strategies: advanced-patterns.md → Testing Orchestration
• Performance Engineering: Advanced Patterns → Complex Coordination
• Security Implementation: integration-patterns.md → Security Patterns

Community & Support

• Best Practices: Continuously updated based on community feedback
• Pattern Library: Growing collection of proven workflow patterns
• Expert Network: Connect with experienced SuperClaude practitioners
• Regular Updates: Documentation evolves with framework capabilities

---

Start Your Journey: New to SuperClaude? Begin with Quick Start Guide for immediate productivity gains.

Need Answers Now: Jump to basic-examples.md for copy-paste solutions.

Ready for Advanced: Explore advanced-patterns.md for expert-level orchestration.