mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
📁 Major documentation restructure and comprehensive Reference section
- Restructured all documentation under unified Docs/ directory - Removed outdated phase summaries and consolidated content - Added comprehensive Reference section with 11 new guides: * Advanced patterns and workflows * Basic examples and common issues * Integration patterns and MCP server guides * Optimization and diagnostic references - Enhanced User-Guide with updated agent and mode documentation - Updated MCP configurations for morphllm and serena - Added TODO.md for project tracking - Maintained existing content quality while improving organization 🤖 Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
735
Docs/User-Guide/commands.md
Normal file
735
Docs/User-Guide/commands.md
Normal file
@@ -0,0 +1,735 @@
|
||||
# SuperClaude Commands Guide
|
||||
|
||||
## ✅ Verification Status
|
||||
- **SuperClaude Version**: v4.0+ Compatible
|
||||
- **Last Tested**: 2025-01-16
|
||||
- **Test Environment**: Linux/Windows/macOS
|
||||
- **Command Syntax**: ✅ All Verified
|
||||
|
||||
> **Quick Start**: Try `/sc:brainstorm "your project idea"` → `/sc:implement "feature name"` → `/sc:test` to experience the core workflow.
|
||||
|
||||
## 🧪 Testing Your Setup
|
||||
|
||||
Before using this guide, verify your SuperClaude installation:
|
||||
|
||||
```bash
|
||||
# Verify SuperClaude is working
|
||||
SuperClaude --version
|
||||
# Expected: SuperClaude Framework v4.0+
|
||||
|
||||
# Test basic command syntax
|
||||
echo "/sc:brainstorm 'test'" | claude --help
|
||||
# Expected: No syntax errors
|
||||
|
||||
# Check MCP server connectivity
|
||||
SuperClaude status --mcp
|
||||
# Expected: At least context7 and sequential-thinking connected
|
||||
```
|
||||
|
||||
**If tests fail**: Check [Installation Guide](../Getting-Started/installation.md) or [Troubleshooting](#troubleshooting)
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Essential Commands](#essential-commands) - Start here (8 core commands)
|
||||
- [Common Workflows](#common-workflows) - Command combinations that work
|
||||
- [Full Command Reference](#full-command-reference) - All 21 commands organized by category
|
||||
- [Troubleshooting](#troubleshooting) - Common issues and solutions
|
||||
- [Command Index](#command-index) - Find commands by category
|
||||
|
||||
---
|
||||
|
||||
## Essential Commands
|
||||
|
||||
**Start with these 8 commands for immediate productivity:**
|
||||
|
||||
### `/sc:brainstorm` - Project Discovery
|
||||
**Purpose**: Interactive requirements discovery and project planning
|
||||
**Syntax**: `/sc:brainstorm "your idea"` `[--strategy systematic|creative]`
|
||||
**Auto-Activation**: Architect + Analyst + PM specialists, Sequential + Context7 MCP
|
||||
|
||||
#### Success Criteria
|
||||
- [ ] Command executes without errors
|
||||
- [ ] Generates 3-5 discovery questions relevant to your domain
|
||||
- [ ] Produces structured requirements document or PRD
|
||||
- [ ] Maintains discovery context for follow-up questions
|
||||
|
||||
**Use Cases**:
|
||||
- New project planning: `/sc:brainstorm "e-commerce platform"`
|
||||
- Feature exploration: `/sc:brainstorm "user authentication system"`
|
||||
- Problem solving: `/sc:brainstorm "slow database queries"`
|
||||
- Architecture decisions: `/sc:brainstorm "microservices vs monolith"`
|
||||
|
||||
**Examples**:
|
||||
```bash
|
||||
/sc:brainstorm "mobile todo app" # → Requirements document + PRD
|
||||
/sc:brainstorm "API performance" --strategy systematic # → Analysis + solutions
|
||||
```
|
||||
|
||||
**Verify:** `/sc:brainstorm "test project"` should ask discovery questions about scope, users, and technology choices
|
||||
**Test:** Follow-up questions should build on initial responses
|
||||
**Check:** Output should include actionable requirements or next steps
|
||||
|
||||
### `/sc:implement` - Feature Development
|
||||
**Purpose**: Full-stack feature implementation with intelligent specialist routing
|
||||
**Syntax**: `/sc:implement "feature description"` `[--type frontend|backend|fullstack] [--focus security|performance]`
|
||||
**Auto-Activation**: Context-dependent specialists (Frontend, Backend, Security), Context7 + Magic MCP
|
||||
|
||||
#### Success Criteria
|
||||
- [ ] Command activates appropriate domain specialists
|
||||
- [ ] Generates functional, production-ready code
|
||||
- [ ] Includes basic error handling and validation
|
||||
- [ ] Follows project conventions and patterns
|
||||
|
||||
**Use Cases**:
|
||||
- Authentication: `/sc:implement "JWT login system"` → Security specialist + validation
|
||||
- UI components: `/sc:implement "responsive dashboard"` → Frontend + Magic MCP
|
||||
- APIs: `/sc:implement "REST user endpoints"` → Backend + Context7 patterns
|
||||
- Database: `/sc:implement "user schema with relationships"` → Database specialist
|
||||
|
||||
**Examples**:
|
||||
```bash
|
||||
/sc:implement "user registration with email verification" # → Full auth flow
|
||||
/sc:implement "payment integration" --focus security # → Secure payment system
|
||||
```
|
||||
|
||||
**Verify:** Code should compile/run without immediate errors
|
||||
**Test:** `/sc:implement "hello world function"` should produce working code
|
||||
**Check:** Security specialist should activate for auth-related implementations
|
||||
|
||||
### `/sc:analyze` - Code Assessment
|
||||
**Purpose**: Comprehensive code analysis across quality, security, and performance
|
||||
**Syntax**: `/sc:analyze [path]` `[--focus quality|security|performance|architecture]`
|
||||
**Auto-Activation**: Analyzer specialist + domain experts based on focus
|
||||
**Use Cases**:
|
||||
- Project health: `/sc:analyze .` → Overall assessment
|
||||
- Security audit: `/sc:analyze --focus security` → Vulnerability report
|
||||
- Performance review: `/sc:analyze --focus performance` → Bottleneck identification
|
||||
- Architecture review: `/sc:analyze --focus architecture` → Design patterns analysis
|
||||
|
||||
**Examples**:
|
||||
```bash
|
||||
/sc:analyze src/ # → Quality + security + performance report
|
||||
/sc:analyze --focus security --depth deep # → Detailed security audit
|
||||
```
|
||||
|
||||
### `/sc:troubleshoot` - Problem Diagnosis
|
||||
**Purpose**: Systematic issue diagnosis with root cause analysis
|
||||
**Syntax**: `/sc:troubleshoot "issue description"` `[--type build|runtime|performance]`
|
||||
**Auto-Activation**: Analyzer + DevOps specialists, Sequential MCP for systematic debugging
|
||||
**Use Cases**:
|
||||
- Runtime errors: `/sc:troubleshoot "500 error on login"` → Error investigation
|
||||
- Build failures: `/sc:troubleshoot --type build` → Compilation issues
|
||||
- Performance problems: `/sc:troubleshoot "slow page load"` → Performance analysis
|
||||
- Integration issues: `/sc:troubleshoot "API timeout errors"` → Connection diagnosis
|
||||
|
||||
**Examples**:
|
||||
```bash
|
||||
/sc:troubleshoot "users can't login" # → Systematic auth flow analysis
|
||||
/sc:troubleshoot --type build --fix # → Build errors + suggested fixes
|
||||
```
|
||||
|
||||
### `/sc:test` - Quality Assurance
|
||||
**Purpose**: Comprehensive testing with coverage analysis
|
||||
**Syntax**: `/sc:test` `[--type unit|integration|e2e] [--coverage] [--fix]`
|
||||
**Auto-Activation**: QA specialist, Playwright MCP for E2E testing
|
||||
**Use Cases**:
|
||||
- Full test suite: `/sc:test --coverage` → All tests + coverage report
|
||||
- Unit testing: `/sc:test --type unit --watch` → Continuous unit tests
|
||||
- E2E validation: `/sc:test --type e2e` → Browser automation tests
|
||||
- Test fixing: `/sc:test --fix` → Repair failing tests
|
||||
|
||||
**Examples**:
|
||||
```bash
|
||||
/sc:test --coverage --report # → Complete test run with coverage
|
||||
/sc:test --type e2e --browsers chrome,firefox # → Cross-browser testing
|
||||
```
|
||||
|
||||
### `/sc:improve` - Code Enhancement
|
||||
**Purpose**: Apply systematic code improvements and optimizations
|
||||
**Syntax**: `/sc:improve [path]` `[--type performance|quality|security] [--preview]`
|
||||
**Auto-Activation**: Analyzer specialist, Morphllm MCP for pattern-based improvements
|
||||
**Use Cases**:
|
||||
- General improvements: `/sc:improve src/` → Code quality enhancements
|
||||
- Performance optimization: `/sc:improve --type performance` → Speed improvements
|
||||
- Security hardening: `/sc:improve --type security` → Security best practices
|
||||
- Refactoring: `/sc:improve --preview --safe-mode` → Safe code refactoring
|
||||
|
||||
**Examples**:
|
||||
```bash
|
||||
/sc:improve --type performance --measure-impact # → Performance optimizations
|
||||
/sc:improve --preview --backup # → Preview changes before applying
|
||||
```
|
||||
|
||||
### `/sc:document` - Documentation Generation
|
||||
**Purpose**: Generate comprehensive documentation for code and APIs
|
||||
**Syntax**: `/sc:document [path]` `[--type api|user-guide|technical] [--format markdown|html]`
|
||||
**Auto-Activation**: Documentation specialist
|
||||
**Use Cases**:
|
||||
- API docs: `/sc:document --type api` → OpenAPI/Swagger documentation
|
||||
- User guides: `/sc:document --type user-guide` → End-user documentation
|
||||
- Technical docs: `/sc:document --type technical` → Developer documentation
|
||||
- Inline comments: `/sc:document src/ --inline` → Code comments
|
||||
|
||||
**Examples**:
|
||||
```bash
|
||||
/sc:document src/api/ --type api --format openapi # → API specification
|
||||
/sc:document --type user-guide --audience beginners # → User documentation
|
||||
```
|
||||
|
||||
### `/sc:workflow` - Implementation Planning
|
||||
**Purpose**: Generate structured implementation plans from requirements
|
||||
**Syntax**: `/sc:workflow "feature description"` `[--strategy agile|waterfall] [--format markdown]`
|
||||
**Auto-Activation**: Architect + Project Manager specialists, Sequential MCP
|
||||
**Use Cases**:
|
||||
- Feature planning: `/sc:workflow "user authentication"` → Implementation roadmap
|
||||
- Sprint planning: `/sc:workflow --strategy agile` → Agile task breakdown
|
||||
- Architecture planning: `/sc:workflow "microservices migration"` → Migration strategy
|
||||
- Timeline estimation: `/sc:workflow --detailed --estimates` → Time and resource planning
|
||||
|
||||
**Examples**:
|
||||
```bash
|
||||
/sc:workflow "real-time chat feature" # → Structured implementation plan
|
||||
/sc:workflow "payment system" --strategy agile # → Sprint-ready tasks
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Workflows
|
||||
|
||||
**Proven command combinations for common development scenarios:**
|
||||
|
||||
### New Project Setup
|
||||
```bash
|
||||
/sc:brainstorm "project concept" # Define requirements
|
||||
→ /sc:design "system architecture" # Create technical design
|
||||
→ /sc:workflow "implementation plan" # Generate development roadmap
|
||||
→ /sc:save "project-plan" # Save session context
|
||||
```
|
||||
|
||||
### Feature Development
|
||||
```bash
|
||||
/sc:load "project-context" # Load existing project
|
||||
→ /sc:implement "feature name" # Build the feature
|
||||
→ /sc:test --coverage # Validate with tests
|
||||
→ /sc:document --type api # Generate documentation
|
||||
```
|
||||
|
||||
### Code Quality Improvement
|
||||
```bash
|
||||
/sc:analyze --focus quality # Assess current state
|
||||
→ /sc:cleanup --comprehensive # Clean technical debt
|
||||
→ /sc:improve --preview # Preview improvements
|
||||
→ /sc:test --coverage # Validate changes
|
||||
```
|
||||
|
||||
### Bug Investigation
|
||||
```bash
|
||||
/sc:troubleshoot "issue description" # Diagnose the problem
|
||||
→ /sc:analyze --focus problem-area # Deep analysis of affected code
|
||||
→ /sc:improve --fix --safe-mode # Apply targeted fixes
|
||||
→ /sc:test --related-tests # Verify resolution
|
||||
```
|
||||
|
||||
### Pre-Production Checklist
|
||||
```bash
|
||||
/sc:analyze --focus security # Security audit
|
||||
→ /sc:test --type e2e --comprehensive # Full E2E validation
|
||||
→ /sc:build --optimize --target production # Production build
|
||||
→ /sc:document --type deployment # Deployment documentation
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Full Command Reference
|
||||
|
||||
### Development Commands
|
||||
|
||||
| Command | Purpose | Auto-Activation | Best For |
|
||||
|---------|---------|-----------------|----------|
|
||||
| **workflow** | Implementation planning | Architect + PM, Sequential | Project roadmaps, sprint planning |
|
||||
| **implement** | Feature development | Context specialists, Context7 + Magic | Full-stack features, API development |
|
||||
| **build** | Project compilation | DevOps specialist | CI/CD, production builds |
|
||||
| **design** | System architecture | Architect + UX, diagrams | API specs, database schemas |
|
||||
|
||||
#### `/sc:build` - Project Compilation
|
||||
**Purpose**: Build and package projects with error handling
|
||||
**Syntax**: `/sc:build` `[--optimize] [--target production] [--fix-errors]`
|
||||
**Examples**: Production builds, dependency management, build optimization
|
||||
**Common Issues**: Missing deps → auto-install, memory issues → optimized parameters
|
||||
|
||||
#### `/sc:design` - System Architecture
|
||||
**Purpose**: Create technical designs and specifications
|
||||
**Syntax**: `/sc:design "system description"` `[--type api|database|system] [--format openapi|mermaid]`
|
||||
**Examples**: API specifications, database schemas, component architecture
|
||||
**Output Formats**: Markdown, Mermaid diagrams, OpenAPI specs, ERD
|
||||
|
||||
### Analysis Commands
|
||||
|
||||
| Command | Purpose | Auto-Activation | Best For |
|
||||
|---------|---------|-----------------|----------|
|
||||
| **analyze** | Code assessment | Analyzer + domain experts | Quality audits, security reviews |
|
||||
| **troubleshoot** | Problem diagnosis | Analyzer + DevOps, Sequential | Bug investigation, performance issues |
|
||||
| **explain** | Code explanation | Educational focus | Learning, code reviews |
|
||||
|
||||
#### `/sc:explain` - Code & Concept Explanation
|
||||
**Purpose**: Educational explanations with progressive detail
|
||||
**Syntax**: `/sc:explain "topic or file"` `[--level beginner|intermediate|expert]`
|
||||
**Examples**: Code walkthroughs, concept clarification, pattern explanation
|
||||
**Teaching Styles**: Code-walkthrough, concept, pattern, comparison, tutorial
|
||||
|
||||
### Quality Commands
|
||||
|
||||
| Command | Purpose | Auto-Activation | Best For |
|
||||
|---------|---------|-----------------|----------|
|
||||
| **improve** | Code enhancement | Analyzer, Morphllm | Performance optimization, refactoring |
|
||||
| **cleanup** | Technical debt | Analyzer, Morphllm | Dead code removal, organization |
|
||||
| **test** | Quality assurance | QA specialist, Playwright | Test automation, coverage analysis |
|
||||
| **document** | Documentation | Documentation specialist | API docs, user guides |
|
||||
|
||||
#### `/sc:cleanup` - Technical Debt Reduction
|
||||
**Purpose**: Remove dead code and optimize project structure
|
||||
**Syntax**: `/sc:cleanup` `[--type imports|dead-code|formatting] [--confirm-before-delete]`
|
||||
**Examples**: Import optimization, file organization, dependency cleanup
|
||||
**Operations**: Dead code removal, import sorting, style formatting, file organization
|
||||
|
||||
### Project Management Commands
|
||||
|
||||
| Command | Purpose | Auto-Activation | Best For |
|
||||
|---------|---------|-----------------|----------|
|
||||
| **estimate** | Project estimation | Project Manager | Timeline planning, resource allocation |
|
||||
| **task** | Task management | PM, Serena | Complex workflows, task tracking |
|
||||
| **spawn** | Meta-orchestration | PM + multiple specialists | Large-scale projects, parallel execution |
|
||||
|
||||
#### `/sc:estimate` - Project Estimation
|
||||
**Purpose**: Development estimates with complexity analysis
|
||||
**Syntax**: `/sc:estimate "project description"` `[--detailed] [--team-size N]`
|
||||
**Features**: Time estimates, complexity analysis, resource allocation, risk assessment
|
||||
**Stability**: 🌱 Growing - Improving estimation accuracy with each release
|
||||
|
||||
#### `/sc:task` - Project Management
|
||||
**Purpose**: Complex task workflow management
|
||||
**Syntax**: `/sc:task "task description"` `[--breakdown] [--priority high|medium|low]`
|
||||
**Features**: Task breakdown, priority management, cross-session tracking, dependency mapping
|
||||
**Stability**: 🌱 Growing - Enhanced delegation patterns being refined
|
||||
|
||||
#### `/sc:spawn` - Meta-System Orchestration
|
||||
**Purpose**: Large-scale project orchestration with parallel execution
|
||||
**Syntax**: `/sc:spawn "complex project"` `[--parallel] [--monitor]`
|
||||
**Features**: Workflow orchestration, parallel execution, progress monitoring, resource management
|
||||
**Stability**: 🌱 Growing - Advanced orchestration capabilities under development
|
||||
|
||||
### Utility Commands
|
||||
|
||||
| Command | Purpose | Auto-Activation | Best For |
|
||||
|---------|---------|-----------------|----------|
|
||||
| **git** | Version control | DevOps specialist | Commit management, branch strategies |
|
||||
| **index** | Command discovery | Context analysis | Exploring capabilities, finding commands |
|
||||
|
||||
#### `/sc:git` - Version Control
|
||||
**Purpose**: Intelligent Git operations with smart commit messages
|
||||
**Syntax**: `/sc:git [operation]` `[--smart-messages] [--conventional]`
|
||||
**Features**: Smart commit messages, branch management, conflict resolution, workflow optimization
|
||||
**Stability**: ✅ Reliable - Proven commit message generation and workflow patterns
|
||||
|
||||
#### `/sc:index` - Command Discovery
|
||||
**Purpose**: Explore available commands and capabilities
|
||||
**Syntax**: `/sc:index` `[--category development|quality] [--search "keyword"]`
|
||||
**Features**: Command discovery, capability exploration, contextual recommendations, usage patterns
|
||||
**Stability**: 🧪 Testing - Command categorization and search being refined
|
||||
|
||||
### Session Commands
|
||||
|
||||
| Command | Purpose | Auto-Activation | Best For |
|
||||
|---------|---------|-----------------|----------|
|
||||
| **load** | Context loading | Context analysis, Serena | Session initialization, project onboarding |
|
||||
| **save** | Session persistence | Session management, Serena | Checkpointing, context preservation |
|
||||
| **reflect** | Task validation | Context analysis, Serena | Progress assessment, completion validation |
|
||||
| **select-tool** | Tool optimization | Meta-analysis, all MCP | Performance optimization, tool selection |
|
||||
|
||||
#### `/sc:load` - Session Context Loading
|
||||
**Purpose**: Initialize project context and session state
|
||||
**Syntax**: `/sc:load [path]` `[--focus architecture|codebase] [--session "name"]`
|
||||
**Features**: Project structure analysis, context restoration, session initialization, intelligent onboarding
|
||||
**Stability**: 🔧 Functional - Core loading works, advanced context analysis improving
|
||||
|
||||
#### `/sc:save` - Session Persistence
|
||||
**Purpose**: Save session context and progress
|
||||
**Syntax**: `/sc:save "session-name"` `[--checkpoint] [--description "details"]`
|
||||
**Features**: Session checkpointing, context preservation, progress tracking, cross-session continuity
|
||||
**Stability**: 🔧 Functional - Basic persistence reliable, advanced features being enhanced
|
||||
|
||||
#### `/sc:reflect` - Task Reflection & Validation
|
||||
**Purpose**: Analyze completion status and validate progress
|
||||
**Syntax**: `/sc:reflect` `[--type completion|progress] [--task "task-name"]`
|
||||
**Features**: Progress analysis, completion validation, quality assessment, next steps recommendation
|
||||
**Stability**: 🌱 Growing - Analysis patterns being refined for better insights
|
||||
|
||||
#### `/sc:select-tool` - Intelligent Tool Selection
|
||||
**Purpose**: Optimize MCP tool selection based on complexity analysis
|
||||
**Syntax**: `/sc:select-tool "operation description"` `[--analyze-complexity] [--recommend]`
|
||||
**Features**: Complexity analysis, tool recommendation, MCP coordination, optimization strategies, resource planning
|
||||
**Stability**: 🌱 Growing - Tool selection algorithms being optimized
|
||||
|
||||
---
|
||||
|
||||
## Command Index
|
||||
|
||||
### By Category
|
||||
|
||||
**🚀 Project Initiation**
|
||||
- `brainstorm` - Interactive discovery
|
||||
- `design` - System architecture
|
||||
- `workflow` - Implementation planning
|
||||
|
||||
**⚡ Development**
|
||||
- `implement` - Feature development
|
||||
- `build` - Project compilation
|
||||
- `git` - Version control
|
||||
|
||||
**🔍 Analysis & Quality**
|
||||
- `analyze` - Code assessment
|
||||
- `troubleshoot` - Problem diagnosis
|
||||
- `explain` - Code explanation
|
||||
- `improve` - Code enhancement
|
||||
- `cleanup` - Technical debt
|
||||
- `test` - Quality assurance
|
||||
|
||||
**📝 Documentation**
|
||||
- `document` - Documentation generation
|
||||
|
||||
**📊 Project Management**
|
||||
- `estimate` - Project estimation
|
||||
- `task` - Task management
|
||||
- `spawn` - Meta-orchestration
|
||||
|
||||
**🧠 Session & Intelligence**
|
||||
- `load` - Context loading
|
||||
- `save` - Session persistence
|
||||
- `reflect` - Task validation
|
||||
- `select-tool` - Tool optimization
|
||||
|
||||
**🔧 Utility**
|
||||
- `index` - Command discovery
|
||||
|
||||
### By Maturity Level
|
||||
|
||||
**🔥 Production Ready** (Consistent, reliable results)
|
||||
- `brainstorm`, `analyze`, `implement`, `troubleshoot`
|
||||
|
||||
**✅ Reliable** (Well-tested, stable features)
|
||||
- `workflow`, `design`, `test`, `document`, `git`
|
||||
|
||||
**🔧 Functional** (Core features work, enhancements ongoing)
|
||||
- `improve`, `cleanup`, `build`, `load`, `save`
|
||||
|
||||
**🌱 Growing** (Rapid improvement, usable but evolving)
|
||||
- `spawn`, `task`, `estimate`, `reflect`, `select-tool`
|
||||
|
||||
**🧪 Testing** (Experimental features, feedback welcome)
|
||||
- `index`, `explain`
|
||||
|
||||
---
|
||||
|
||||
## 🚨 Quick Troubleshooting
|
||||
|
||||
### Common Issues (< 2 minutes)
|
||||
- **Command not found**: Check `/sc:` prefix and SuperClaude installation
|
||||
- **Invalid flag**: Verify flag against `python3 -m SuperClaude --help`
|
||||
- **MCP server error**: Check Node.js installation and server configuration
|
||||
- **Permission denied**: Run `chmod +x` or check file permissions
|
||||
|
||||
### Immediate Fixes
|
||||
- **Reset session**: `/sc:load` to reinitialize
|
||||
- **Clear cache**: Remove `~/.claude/cache/` directory
|
||||
- **Restart Claude Code**: Exit and restart application
|
||||
- **Check status**: `python3 -m SuperClaude --version`
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Command-Specific Issues
|
||||
|
||||
**Command Not Recognized:**
|
||||
```bash
|
||||
# Problem: "/sc:analyze not found"
|
||||
# Quick Fix: Check command spelling and prefix
|
||||
/sc:help commands # List all available commands
|
||||
python3 -m SuperClaude --help # Verify installation
|
||||
```
|
||||
|
||||
**Command Hangs or No Response:**
|
||||
```bash
|
||||
# Problem: Command starts but never completes
|
||||
# Quick Fix: Check for dependency issues
|
||||
/sc:command --timeout 30 # Set explicit timeout
|
||||
/sc:command --no-mcp # Try without MCP servers
|
||||
ps aux | grep SuperClaude # Check for hung processes
|
||||
```
|
||||
|
||||
**Invalid Flag Combinations:**
|
||||
```bash
|
||||
# Problem: "Flag conflict detected"
|
||||
# Quick Fix: Check flag compatibility
|
||||
/sc:help flags # List valid flags
|
||||
/sc:command --help # Command-specific flags
|
||||
# Use simpler flag combinations or single flags
|
||||
```
|
||||
|
||||
### MCP Server Issues
|
||||
|
||||
**Server Connection Failures:**
|
||||
```bash
|
||||
# Problem: MCP servers not responding
|
||||
# Quick Fix: Verify server status and restart
|
||||
SuperClaude status --mcp # Check all servers
|
||||
/sc:command --no-mcp # Bypass MCP temporarily
|
||||
node --version # Verify Node.js v16+
|
||||
npm cache clean --force # Clear NPM cache
|
||||
```
|
||||
|
||||
**Magic/Morphllm API Key Issues:**
|
||||
```bash
|
||||
# Problem: "API key required" errors
|
||||
# Expected: These servers need paid API keys
|
||||
export TWENTYFIRST_API_KEY="your_key" # For Magic
|
||||
export MORPH_API_KEY="your_key" # For Morphllm
|
||||
# Or use: /sc:command --no-mcp to skip paid services
|
||||
```
|
||||
|
||||
### Performance Issues
|
||||
|
||||
**Slow Command Execution:**
|
||||
```bash
|
||||
# Problem: Commands taking >30 seconds
|
||||
# Quick Fix: Reduce scope and complexity
|
||||
/sc:command --scope file # Limit to single file
|
||||
/sc:command --concurrency 1 # Reduce parallel ops
|
||||
/sc:command --uc # Use compressed output
|
||||
/sc:command --no-mcp # Native execution only
|
||||
```
|
||||
|
||||
**Memory/Resource Exhaustion:**
|
||||
```bash
|
||||
# Problem: System running out of memory
|
||||
# Quick Fix: Resource management
|
||||
/sc:command --memory-limit 1024 # Limit to 1GB
|
||||
/sc:command --scope module # Reduce analysis scope
|
||||
/sc:command --safe-mode # Conservative execution
|
||||
killall node # Reset MCP servers
|
||||
```
|
||||
|
||||
### Error Code Reference
|
||||
|
||||
| Code | Meaning | Quick Fix |
|
||||
|------|---------|-----------|
|
||||
| **E001** | Command syntax error | Check command spelling and `/sc:` prefix |
|
||||
| **E002** | Flag not recognized | Verify flag with `/sc:help flags` |
|
||||
| **E003** | MCP server connection failed | Check Node.js and run `npm cache clean --force` |
|
||||
| **E004** | Permission denied | Check file permissions or run with appropriate access |
|
||||
| **E005** | Timeout exceeded | Reduce scope with `--scope file` or increase `--timeout` |
|
||||
| **E006** | Memory limit exceeded | Use `--memory-limit` or `--scope module` |
|
||||
| **E007** | Invalid project structure | Verify you're in a valid project directory |
|
||||
| **E008** | Dependency missing | Check installation with `SuperClaude --version` |
|
||||
|
||||
### Progressive Support Levels
|
||||
|
||||
**Level 1: Quick Fix (< 2 min)**
|
||||
- Use the Common Issues section above
|
||||
- Try immediate fixes like restart or flag changes
|
||||
- Check basic installation and dependencies
|
||||
|
||||
**Level 2: Detailed Help (5-15 min)**
|
||||
```bash
|
||||
# Comprehensive diagnostics
|
||||
SuperClaude diagnose --verbose
|
||||
/sc:help troubleshoot
|
||||
cat ~/.claude/logs/superclaude.log | tail -50
|
||||
```
|
||||
- See [Common Issues Guide](../Reference/common-issues.md) for detailed troubleshooting
|
||||
|
||||
**Level 3: Expert Support (30+ min)**
|
||||
```bash
|
||||
# Deep system analysis
|
||||
SuperClaude diagnose --full-system
|
||||
strace -e trace=file /sc:command 2>&1 | grep ENOENT
|
||||
lsof | grep SuperClaude
|
||||
# Check GitHub Issues for known problems
|
||||
```
|
||||
- See [Diagnostic Reference Guide](../Reference/diagnostic-reference.md) for advanced procedures
|
||||
|
||||
**Level 4: Community Support**
|
||||
- Report issues at [GitHub Issues](https://github.com/SuperClaude-Org/SuperClaude_Framework/issues)
|
||||
- Include diagnostic output from Level 3
|
||||
- Describe steps to reproduce the problem
|
||||
|
||||
### Success Validation
|
||||
|
||||
After applying fixes, test with:
|
||||
- [ ] `python3 -m SuperClaude --version` (should show version)
|
||||
- [ ] `/sc:analyze README.md` (should complete without errors)
|
||||
- [ ] Check MCP servers respond: `SuperClaude status --mcp`
|
||||
- [ ] Verify flags work: `/sc:help flags`
|
||||
- [ ] Test basic workflow: `/sc:brainstorm "test"` → should ask questions
|
||||
|
||||
## Quick Troubleshooting (Legacy)
|
||||
- **Command not found** → Check installation: `SuperClaude --version`
|
||||
- **Flag error** → Verify against [FLAGS.md](flags.md)
|
||||
- **MCP error** → Check server configuration: `SuperClaude status --mcp`
|
||||
- **No output** → Restart Claude Code session
|
||||
- **Slow performance** → Use `--scope file` or `--no-mcp`
|
||||
|
||||
### Common Issues
|
||||
|
||||
**Command Not Recognized**
|
||||
```bash
|
||||
# Check SuperClaude installation
|
||||
SuperClaude --version
|
||||
|
||||
# Verify component installation
|
||||
SuperClaude install --list-components
|
||||
|
||||
# Restart Claude Code session
|
||||
```
|
||||
|
||||
**Slow Performance**
|
||||
```bash
|
||||
# Limit analysis scope
|
||||
/sc:analyze src/ --scope file
|
||||
|
||||
# Use specific MCP servers only
|
||||
/sc:implement "feature" --c7 --seq # Instead of --all-mcp
|
||||
|
||||
# Reduce concurrency
|
||||
/sc:improve . --concurrency 2
|
||||
```
|
||||
|
||||
**MCP Server Connection Issues**
|
||||
```bash
|
||||
# Check server status
|
||||
ls ~/.claude/.claude.json
|
||||
|
||||
# Reinstall MCP components
|
||||
SuperClaude install --components mcp --force
|
||||
|
||||
# Use native execution fallback
|
||||
/sc:analyze . --no-mcp
|
||||
```
|
||||
|
||||
**Scope Management Issues**
|
||||
```bash
|
||||
# Control analysis depth
|
||||
/sc:analyze . --scope project # Instead of system-wide
|
||||
|
||||
# Focus on specific areas
|
||||
/sc:analyze --focus security # Instead of comprehensive
|
||||
|
||||
# Preview before execution
|
||||
/sc:improve . --dry-run --preview
|
||||
```
|
||||
|
||||
### Error Recovery Patterns
|
||||
|
||||
**Build Failures**
|
||||
```bash
|
||||
/sc:troubleshoot --type build --verbose
|
||||
→ /sc:build --fix-errors --deps-install
|
||||
→ /sc:test --smoke # Quick validation
|
||||
```
|
||||
|
||||
**Test Failures**
|
||||
```bash
|
||||
/sc:analyze --focus testing # Identify test issues
|
||||
→ /sc:test --fix --preview # Preview test fixes
|
||||
→ /sc:test --coverage # Verify repairs
|
||||
```
|
||||
|
||||
**Memory/Resource Issues**
|
||||
```bash
|
||||
/sc:select-tool "task" --analyze-complexity # Check resource needs
|
||||
→ /sc:task "subtask" --scope module # Break into smaller pieces
|
||||
→ /sc:spawn "large-task" --parallel --concurrency 2 # Controlled parallelism
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Getting Help
|
||||
|
||||
**In-Session Help**
|
||||
- `/sc:index --help` - Command discovery and help
|
||||
- `/sc:explain "command-name"` - Detailed command explanation
|
||||
- `/sc:brainstorm --strategy systematic` - Systematic problem exploration
|
||||
|
||||
**Documentation**
|
||||
- [Quick Start Guide](../Getting-Started/quick-start.md) - Essential setup and first steps
|
||||
- [Best Practices](../Reference/best-practices.md) - Optimization and workflow patterns
|
||||
- [Examples Cookbook](../Reference/examples-cookbook.md) - Real-world usage patterns
|
||||
|
||||
**Community Support**
|
||||
- [GitHub Issues](https://github.com/SuperClaude-Org/SuperClaude_Framework/issues) - Bug reports and feature requests
|
||||
- [Discussions](https://github.com/SuperClaude-Org/SuperClaude_Framework/discussions) - Community help and patterns
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Comprehensive Testing Procedures
|
||||
|
||||
### Essential Commands Verification
|
||||
Run these tests to ensure all essential commands work correctly:
|
||||
|
||||
```bash
|
||||
# Test 1: Discovery and Planning
|
||||
/sc:brainstorm "test mobile app"
|
||||
# Expected: 3-5 discovery questions about users, features, platform
|
||||
|
||||
# Test 2: Implementation
|
||||
/sc:implement "simple hello function"
|
||||
# Expected: Working code that compiles/runs without errors
|
||||
|
||||
# Test 3: Analysis
|
||||
/sc:analyze . --focus quality
|
||||
# Expected: Quality assessment with specific recommendations
|
||||
|
||||
# Test 4: Troubleshooting
|
||||
/sc:troubleshoot "simulated performance issue"
|
||||
# Expected: Systematic investigation approach with hypotheses
|
||||
|
||||
# Test 5: Testing
|
||||
/sc:test --coverage
|
||||
# Expected: Test execution or test planning with coverage analysis
|
||||
|
||||
# Test 6: Code Enhancement
|
||||
/sc:improve README.md --preview
|
||||
# Expected: Improvement suggestions with preview of changes
|
||||
|
||||
# Test 7: Documentation
|
||||
/sc:document . --type api
|
||||
# Expected: API documentation or documentation planning
|
||||
|
||||
# Test 8: Workflow Planning
|
||||
/sc:workflow "user authentication feature"
|
||||
# Expected: Structured implementation plan with phases
|
||||
```
|
||||
|
||||
### Success Benchmarks
|
||||
- **Response Time**: Commands should respond within 10 seconds
|
||||
- **Accuracy**: Domain specialists should activate for relevant requests
|
||||
- **Completeness**: Outputs should include actionable next steps
|
||||
- **Consistency**: Similar requests should produce consistent approaches
|
||||
|
||||
### Performance Validation
|
||||
```bash
|
||||
# Test resource usage
|
||||
time /sc:analyze large-project/
|
||||
# Expected: Completion within reasonable time based on project size
|
||||
|
||||
# Test MCP coordination
|
||||
/sc:implement "React component" --verbose
|
||||
# Expected: Magic + Context7 activation visible in output
|
||||
|
||||
# Test flag override
|
||||
/sc:analyze . --no-mcp
|
||||
# Expected: Native execution only, faster response
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**Remember**: SuperClaude learns from your usage patterns. Start with the [Essential Commands](#essential-commands), explore [Common Workflows](#common-workflows), and gradually discover advanced capabilities. Use `/sc:index` whenever you need guidance.
|
||||
|
||||
Reference in New Issue
Block a user