mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-17 09:46:06 +00:00
📚 Complete documentation restructure and content cleanup
- Standardize documentation structure across all sections - Fix CLI confusion and streamline user guidance - Remove fictional content and align with actual functionality - Improve technical architecture documentation - Update installation and quick-start guides - Enhance reference materials and examples 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
NomenAK
parent
f7cf87c5ad
commit
850e5a69a6
@ -96,7 +96,7 @@ Security considerations are embedded throughout all documentation, from developm
|
||||
|
||||
✅ **Phase 1 Complete**: Critical issues resolved, basic structure established
|
||||
✅ **Phase 2 Complete**: Cross-document consistency, navigation improvements, security integration
|
||||
✅ **Phase 3 Complete**: Advanced examples, visual diagrams, performance metrics, enhanced architecture documentation
|
||||
✅ **Phase 3 Complete**: Advanced examples, visual diagrams, enhanced architecture documentation
|
||||
✅ **Phase 4 Complete**: Accessibility improvements, comprehensive glossaries, skill level guidance, professional polish
|
||||
|
||||
### Accessibility & Quality Enhancements (Phase 4)
|
||||
|
||||
@ -248,7 +248,7 @@ User Input (in Claude Code): "/sc:analyze src/ --focus security"
|
||||
|
||||
1. Create `~/.claude/agents/new-specialist.md`
|
||||
2. Define expertise, triggers, and behaviors
|
||||
3. Agent available immediately
|
||||
3. Agent becomes available
|
||||
|
||||
### Adding New Modes
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# SuperClaude Installation Guide 📦
|
||||
|
||||
SuperClaude installs behavioral context files that Claude Code reads to enhance its capabilities with 21 commands, 15 agents, and 6 modes. Installation takes 2-5 minutes.
|
||||
SuperClaude installs behavioral context files that Claude Code reads to enhance its capabilities with 21 commands, 14 agents, and 5 modes.
|
||||
|
||||
## Quick Start 🚀
|
||||
|
||||
@ -12,7 +12,7 @@ SuperClaude install
|
||||
|
||||
**NPM:**
|
||||
```bash
|
||||
npm install -g superclaude # ⚠️ Verify package name exists
|
||||
npm install -g superclaude
|
||||
SuperClaude install
|
||||
```
|
||||
|
||||
@ -116,8 +116,8 @@ SuperClaude install --list-components
|
||||
**What's Installed:**
|
||||
- Framework files in `~/.claude/`
|
||||
- 21 slash commands (`/sc:*`)
|
||||
- 15 agents (`@agent-*`)
|
||||
- 6 behavioral modes
|
||||
- 14 agents (`@agent-*`)
|
||||
- 5 behavioral modes
|
||||
- MCP server configurations (if selected)
|
||||
|
||||
## Managing Your Installation 🛠️
|
||||
@ -181,11 +181,11 @@ pip uninstall SuperClaude
|
||||
## Final Notes 📝
|
||||
|
||||
**Installation Summary:**
|
||||
- **Time**: 2-5 minutes typical installation
|
||||
|
||||
- **Space**: 50MB for full installation
|
||||
- **Requirements**: Python 3.8+, Claude Code, 1GB RAM recommended
|
||||
- **Platform**: Linux, macOS, Windows supported
|
||||
- **Usage**: Immediate access to 21 commands and 6 behavioral modes
|
||||
- **Usage**: Immediate access to 21 commands and 5 behavioral modes
|
||||
|
||||
**What's Next**: Your Claude Code now has enhanced capabilities. Try `/sc:brainstorm` for your first SuperClaude experience!
|
||||
|
||||
@ -196,7 +196,7 @@ pip uninstall SuperClaude
|
||||
**Documentation Roadmap:**
|
||||
|
||||
**Beginner** (🌱 Start Here)
|
||||
- [Quick Start Guide](quick-start.md) - 5-minute setup
|
||||
- [Quick Start Guide](quick-start.md) - quick setup guide
|
||||
- [Commands Reference](../User-Guide/commands.md) - Basic usage
|
||||
|
||||
**Intermediate** (🌿 Growing)
|
||||
@ -211,4 +211,4 @@ pip uninstall SuperClaude
|
||||
|
||||
---
|
||||
|
||||
**Installation Complete!** You now have access to 21 commands, 15 agents, and 6 behavioral modes. Try `/sc:brainstorm` in Claude Code to get started.
|
||||
**Installation Complete!** You now have access to 21 commands, 14 agents, and 5 behavioral modes. Try `/sc:brainstorm` in Claude Code to get started.
|
||||
@ -10,12 +10,12 @@ SuperClaude is a **Context Engineering Framework** that enhances Claude Code by
|
||||
|
||||
## Just Start Here
|
||||
|
||||
### 🖥️ Installation (2 minutes) - Run in Terminal
|
||||
### 🖥️ Installation - Run in Terminal
|
||||
```bash
|
||||
pip install SuperClaude && SuperClaude install
|
||||
```
|
||||
|
||||
### 💬 First Context Triggers (3 minutes) - Type in Claude Code Conversation
|
||||
### 💬 First Context Triggers - Type in Claude Code Conversation
|
||||
```
|
||||
# Interactive project discovery
|
||||
/sc:brainstorm "web app for task management"
|
||||
@ -58,7 +58,7 @@ SuperClaude enhances Claude Code with:
|
||||
|
||||
**Important**: The `.md` files in `SuperClaude/` directory are NOT documentation - they are the actual context framework instructions that Claude Code reads to enhance its capabilities.
|
||||
|
||||
**Version 4.0** delivers production-ready workflow orchestration with intelligent agent coordination and session persistence.
|
||||
**Version 4.0** delivers workflow orchestration capabilities with intelligent agent coordination and session persistence.
|
||||
|
||||
## How It Works
|
||||
|
||||
|
||||
@ -23,19 +23,19 @@ pip install SuperClaude && SuperClaude install
|
||||
## 📚 Documentation Structure
|
||||
|
||||
### 🌱 Start Here (New Users)
|
||||
| Guide | Purpose | Time |
|
||||
| Guide | Purpose |
|
||||
|-------|---------|------|
|
||||
| **[Quick Start](Getting-Started/quick-start.md)** | 5-minute setup and first commands | 5 min |
|
||||
| **[Installation](Getting-Started/installation.md)** | Detailed setup instructions | 10 min |
|
||||
| **[Commands Guide](User-Guide/commands.md)** | All 21 `/sc:` commands | 20 min |
|
||||
| **[Quick Start](Getting-Started/quick-start.md)** | Setup and first commands | |
|
||||
| **[Installation](Getting-Started/installation.md)** | Detailed setup instructions | |
|
||||
| **[Commands Guide](User-Guide/commands.md)** | All 21 `/sc:` commands | |
|
||||
|
||||
### 🌿 Daily Usage (Regular Users)
|
||||
| Guide | Purpose | Use For |
|
||||
|-------|---------|---------|
|
||||
| **[Commands Guide](User-Guide/commands.md)** | Master all `/sc:` commands | Daily development |
|
||||
| **[Agents Guide](User-Guide/agents.md)** | 15 domain specialists (`@agent-*`) | Expert assistance |
|
||||
| **[Agents Guide](User-Guide/agents.md)** | 14 domain specialists (`@agent-*`) | Expert assistance |
|
||||
| **[Flags Guide](User-Guide/flags.md)** | Command behavior modification | Optimization |
|
||||
| **[Modes Guide](User-Guide/modes.md)** | 6 behavioral modes | Workflow optimization |
|
||||
| **[Modes Guide](User-Guide/modes.md)** | 5 behavioral modes | Workflow optimization |
|
||||
|
||||
### 🌲 Reference & Advanced (Power Users)
|
||||
| Guide | Purpose | Use For |
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# SuperClaude Framework Reference Documentation
|
||||
|
||||
**Complete Navigation Hub**: Your definitive guide to mastering SuperClaude Framework with structured learning paths, comprehensive references, and expert guidance for all skill levels.
|
||||
**Navigation Hub**: Structured learning paths and technical references for all skill levels.
|
||||
|
||||
**Documentation Status**: ✅ **Status: Current** - All content verified for accuracy and completeness.
|
||||
|
||||
@ -19,18 +19,18 @@ This documentation is organized for **progressive learning** with multiple entry
|
||||
|
||||
## Documentation Navigation Matrix
|
||||
|
||||
| Document | Purpose | Target Audience | Complexity | Time Investment |
|
||||
| Document | Purpose | Target Audience | Complexity | |
|
||||
|----------|---------|-----------------|------------|-----------------|
|
||||
| **[basic-examples.md](./basic-examples.md)** | Copy-paste ready commands and patterns | All users, quick reference | **Basic** | 15-30 minutes |
|
||||
| **[examples-cookbook.md](./examples-cookbook.md)** | Recipe collection hub and organization | All users, navigation | **Reference** | 5 minutes |
|
||||
| **[basic-examples.md](./basic-examples.md)** | Copy-paste ready commands and patterns | All users, quick reference | **Basic** | |
|
||||
| **[examples-cookbook.md](./examples-cookbook.md)** | Recipe collection hub and organization | All users, navigation | **Reference** | |
|
||||
| **[common-issues.md](./common-issues.md)** | Essential troubleshooting and solutions | All users, problem-solving | **Basic** | As needed |
|
||||
| **[mcp-server-guide.md](./mcp-server-guide.md)** | MCP server configuration and usage | Technical users, integration | **Intermediate** | 45-90 minutes |
|
||||
| **[mcp-server-guide.md](./mcp-server-guide.md)** | MCP server configuration and usage | Technical users, integration | **Intermediate** | |
|
||||
|
||||
| **[advanced-patterns.md](./advanced-patterns.md)** | Expert coordination and orchestration | Experienced users | **Advanced** | 90-150 minutes |
|
||||
| **[advanced-workflows.md](./advanced-workflows.md)** | Complex multi-agent orchestration | Expert users | **Advanced** | 120-180 minutes |
|
||||
| **[integration-patterns.md](./integration-patterns.md)** | Framework and system integration | Architects, experts | **Advanced** | 90-150 minutes |
|
||||
| **[advanced-patterns.md](./advanced-patterns.md)** | Expert coordination and orchestration | Experienced users | **Advanced** | |
|
||||
| **[advanced-workflows.md](./advanced-workflows.md)** | Complex multi-agent orchestration | Expert users | **Advanced** | |
|
||||
| **[integration-patterns.md](./integration-patterns.md)** | Framework and system integration | Architects, experts | **Advanced** | |
|
||||
| **[troubleshooting.md](./troubleshooting.md)** | Comprehensive diagnostic guide | All levels, deep debugging | **Variable** | As needed |
|
||||
| **[diagnostic-reference.md](./diagnostic-reference.md)** | Advanced debugging and analysis | Expert users, complex issues | **Advanced** | 60-120 minutes |
|
||||
| **[diagnostic-reference.md](./diagnostic-reference.md)** | Advanced debugging and analysis | Expert users, complex issues | **Advanced** | |
|
||||
|
||||
---
|
||||
|
||||
@ -157,20 +157,20 @@ Advanced Analysis: diagnostic-reference.md
|
||||
|
||||
## Problem-Solving Quick Reference
|
||||
|
||||
### Immediate Issues (< 5 minutes)
|
||||
### Immediate Issues
|
||||
- **Command not working**: Check [common-issues.md](./common-issues.md) → Common SuperClaude Problems
|
||||
- **Session lost**: Use `/sc:load` → See [Session Management](../User-Guide/session-management.md)
|
||||
- **Flag confusion**: Check [basic-examples.md](./basic-examples.md) → Flag Usage Examples
|
||||
|
||||
### Development Blockers (15-30 minutes)
|
||||
### Development Blockers
|
||||
- **Performance slow**: See [Advanced Workflows](./advanced-workflows.md) → Performance Patterns
|
||||
- **Complex debugging**: Use [troubleshooting.md](./troubleshooting.md) → Systematic Debugging
|
||||
- **Integration issues**: Check [integration-patterns.md](./integration-patterns.md) → Framework Patterns
|
||||
|
||||
### System-Level Issues (45+ minutes)
|
||||
### System-Level Issues
|
||||
- **Architecture problems**: Use [advanced-workflows.md](./advanced-workflows.md) → System Design
|
||||
- **Expert debugging**: Apply [diagnostic-reference.md](./diagnostic-reference.md) → Advanced Analysis
|
||||
- **Custom workflow needs**: Study [advanced-patterns.md](./advanced-patterns.md) → Custom Orchestration
|
||||
- **Custom workflow needs**: Study [advanced-patterns.md](./advanced-patterns.md) → Custom Orchestration [advanced-patterns.md](./advanced-patterns.md) → Custom Orchestration
|
||||
|
||||
---
|
||||
|
||||
|
||||
@ -129,7 +129,7 @@
|
||||
|
||||
```bash
|
||||
# Quick overview
|
||||
/sc:analyze . --quick --uc
|
||||
/sc:analyze . --overview --uc
|
||||
# Fast, compressed output
|
||||
|
||||
# Standard analysis
|
||||
@ -169,7 +169,7 @@
|
||||
# Systematic exploration of large projects
|
||||
# Step 1: Structure understanding
|
||||
/sc:load project/
|
||||
/sc:analyze . --quick --focus architecture
|
||||
/sc:analyze . --overview --focus architecture
|
||||
|
||||
# Step 2: Identify problem areas
|
||||
@agent-quality-engineer "identify high-risk modules"
|
||||
|
||||
@ -134,7 +134,7 @@
|
||||
```bash
|
||||
# Systematic analysis of large projects
|
||||
# Overview
|
||||
/sc:analyze . --quick
|
||||
/sc:analyze . --overview
|
||||
# Get high-level understanding
|
||||
|
||||
# Focused analysis by module
|
||||
|
||||
@ -10,13 +10,13 @@
|
||||
|
||||
**Purpose**: Essential SuperClaude commands and patterns for everyday development tasks. Start here for your first SuperClaude experience.
|
||||
|
||||
**Target Audience**: New users, developers learning SuperClaude fundamentals, quick task execution
|
||||
**Target Audience**: New users, developers learning SuperClaude fundamentals, immediate task application
|
||||
|
||||
**Usage Pattern**: Copy → Adapt → Execute → Learn from results
|
||||
|
||||
**Key Features**:
|
||||
- All examples verified and production-ready
|
||||
- Copy-paste utility with immediate results
|
||||
- Examples demonstrate core SuperClaude functionality
|
||||
- Clear patterns for immediate application
|
||||
- Single-focus examples for clear learning
|
||||
- Progressive complexity within basic scope
|
||||
|
||||
@ -32,7 +32,7 @@
|
||||
/sc:brainstorm "mobile app for fitness tracking"
|
||||
# Expected: Socratic dialogue, requirement elicitation, feasibility analysis
|
||||
```
|
||||
**Verification**: Activates brainstorming mode + system-architect + requirements-analyst + Context7
|
||||
**Behavior**: Triggers interactive discovery dialogue and requirements analysis
|
||||
|
||||
#### Command: /sc:analyze
|
||||
**Purpose**: Analyze existing codebase for issues and improvements
|
||||
@ -42,7 +42,7 @@
|
||||
/sc:analyze src/ --focus security
|
||||
# Expected: Comprehensive security audit, vulnerability report, improvement suggestions
|
||||
```
|
||||
**Verification**: Activates security-engineer + quality-engineer + performance-engineer
|
||||
**Behavior**: Provides comprehensive security analysis and improvement recommendations
|
||||
|
||||
#### Command: /sc:implement
|
||||
**Purpose**: Implement a complete feature with best practices
|
||||
@ -52,7 +52,7 @@
|
||||
/sc:implement "user authentication with JWT and rate limiting"
|
||||
# Expected: Complete auth implementation, security validation, tests included
|
||||
```
|
||||
**Verification**: Activates security-engineer + backend-architect + Context7 + quality gates
|
||||
**Behavior**: Delivers complete implementation following security and quality standards
|
||||
|
||||
#### Command: /sc:troubleshoot
|
||||
**Purpose**: Troubleshoot and fix a problem systematically
|
||||
@ -420,15 +420,9 @@
|
||||
|
||||
# Security hardening
|
||||
/sc:analyze . --focus security && /sc:implement "security improvements"
|
||||
@agent-security "perform OWASP Top 10 compliance check"
|
||||
|
||||
# Performance optimization
|
||||
/sc:analyze . --focus performance && /sc:implement "performance optimizations"
|
||||
@agent-performance-engineer "profile and optimize critical paths"
|
||||
|
||||
# Test coverage improvement
|
||||
# Test coverage improvement
|
||||
/sc:test --focus quality && /sc:implement "additional test coverage"
|
||||
@agent-quality-engineer "identify untested edge cases"
|
||||
```
|
||||
|
||||
### Common Feature Implementations
|
||||
@ -456,11 +450,9 @@
|
||||
# Quick analysis
|
||||
/sc:analyze src/ --scope file
|
||||
|
||||
|
||||
# Standard analysis
|
||||
/sc:analyze . --think
|
||||
|
||||
|
||||
# Deep analysis
|
||||
/sc:analyze . --think-hard --focus architecture
|
||||
|
||||
@ -472,8 +464,8 @@
|
||||
/sc:analyze . --focus security
|
||||
|
||||
|
||||
# Performance-focused implementation
|
||||
/sc:implement "API optimization" --focus performance
|
||||
# Implementation with specific focus
|
||||
/sc:implement "API optimization" --focus architecture
|
||||
|
||||
|
||||
# Quality-focused testing
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# SuperClaude Common Issues - Quick Reference 🚀
|
||||
|
||||
**2-Minute Problem Solving**: Most frequent issues with instant solutions.
|
||||
**Problem Solving Guide**: Most frequent issues with practical solutions.
|
||||
|
||||
## Top 5 Quick Fixes (90% of Issues)
|
||||
|
||||
|
||||
@ -36,19 +36,19 @@
|
||||
## Quick Navigation Guide
|
||||
|
||||
### By Experience Level
|
||||
**Beginner (Week 1-2)**
|
||||
**Beginner**
|
||||
→ Start with [Basic Examples](./basic-examples.md)
|
||||
- Essential commands and patterns
|
||||
- Simple troubleshooting workflows
|
||||
- Copy-paste solutions for common tasks
|
||||
|
||||
**Intermediate (Week 3-6)**
|
||||
**Intermediate**
|
||||
→ Progress to [Advanced Workflows](./advanced-workflows.md)
|
||||
- Multi-agent coordination
|
||||
- Complex project orchestration
|
||||
- Session management patterns
|
||||
|
||||
**Expert (Month 2+)**
|
||||
**Expert**
|
||||
→ Master [Integration Patterns](./integration-patterns.md)
|
||||
- Framework integration strategies
|
||||
- Performance optimization recipes
|
||||
@ -74,7 +74,7 @@
|
||||
|
||||
## Verified Commands Reference
|
||||
|
||||
**Core Commands** (all tested and functional):
|
||||
**Core Commands**:
|
||||
- `/sc:brainstorm` - Interactive requirements discovery
|
||||
- `/sc:analyze` - Codebase analysis and assessment
|
||||
- `/sc:implement` - Feature implementation with best practices
|
||||
|
||||
@ -517,7 +517,7 @@ npm update -g
|
||||
|
||||
# Verification
|
||||
time node -e "console.log('Node.js speed test')"
|
||||
# Should complete quickly
|
||||
# Should complete successfully
|
||||
```
|
||||
|
||||
**Issue: MCP Server Memory Leaks**
|
||||
@ -529,7 +529,7 @@ top | grep node # Monitor Node.js processes
|
||||
ps aux --sort=-%mem | head -10
|
||||
|
||||
# Solution 1: Regular Claude Code session restarts
|
||||
# Restart sessions every few hours during heavy usage
|
||||
# Restart sessions periodically during heavy usage
|
||||
|
||||
# Solution 2: Monitor specific servers
|
||||
htop # Monitor individual MCP server processes
|
||||
|
||||
@ -1,8 +1,10 @@
|
||||
# SuperClaude Agents Guide 🤖
|
||||
|
||||
SuperClaude provides 14 domain specialist agents that Claude Code can invoke for specialized expertise.
|
||||
|
||||
## ✅ Verification Status
|
||||
- **
|
||||
- **Last Tested**: 2025-01-16
|
||||
- **Agent Count**: 14 specialists available
|
||||
- **Last Tested**: 2025-01-16
|
||||
- **Test Environment**: Linux/Windows/macOS
|
||||
- **Agent Activation**: ✅ All Verified
|
||||
|
||||
@ -501,7 +503,7 @@ For troubleshooting help, see:
|
||||
- [Common Issues](../Reference/common-issues.md) - Quick fixes for frequent problems
|
||||
- [Troubleshooting Guide](../Reference/troubleshooting.md) - Comprehensive problem resolution
|
||||
|
||||
### Common Issues (< 2 minutes)
|
||||
### Common Issues
|
||||
- **No agent activation**: Use domain keywords: "security", "performance", "frontend"
|
||||
- **Wrong agents selected**: Check trigger keywords in agent documentation
|
||||
- **Too many agents**: Focus keywords on primary domain or use `/sc:focus [domain]`
|
||||
@ -552,35 +554,24 @@ For troubleshooting help, see:
|
||||
"implement server-side authentication" # Backend focus - triggers backend-architect
|
||||
```
|
||||
|
||||
### Progressive Support Levels
|
||||
### Support Levels
|
||||
|
||||
**Level 1: Quick Fix (< 2 min)**
|
||||
**Quick Fix:**
|
||||
- Use explicit domain keywords from agent trigger table
|
||||
- Try restarting Claude Code session
|
||||
- Focus on single domain to avoid confusion
|
||||
|
||||
**Level 2: Detailed Help (5-15 min)**
|
||||
```bash
|
||||
# Agent-specific diagnostics
|
||||
/sc:help agents # List available agents
|
||||
/sc:explain "agent selection process" # Understand routing
|
||||
# Review trigger keywords for target agents
|
||||
```
|
||||
**Detailed Help:**
|
||||
- See [Common Issues Guide](../Reference/common-issues.md) for agent installation problems
|
||||
- Review trigger keywords for target agents
|
||||
|
||||
**Level 3: Expert Support (30+ min)**
|
||||
```bash
|
||||
# Deep agent analysis
|
||||
SuperClaude install --diagnose
|
||||
# Check agent coordination patterns
|
||||
# Review multi-domain keyword strategies
|
||||
```
|
||||
- See [Diagnostic Reference Guide](../Reference/diagnostic-reference.md) for agent coordination analysis
|
||||
**Expert Support:**
|
||||
- Use `SuperClaude install --diagnose`
|
||||
- See [Diagnostic Reference Guide](../Reference/diagnostic-reference.md) for coordination analysis
|
||||
|
||||
**Level 4: Community Support**
|
||||
- Report agent issues at [GitHub Issues](https://github.com/SuperClaude-Org/SuperClaude_Framework/issues)
|
||||
**Community Support:**
|
||||
- Report issues at [GitHub Issues](https://github.com/SuperClaude-Org/SuperClaude_Framework/issues)
|
||||
- Include examples of expected vs actual agent activation
|
||||
- Describe the type of task and desired agent combination
|
||||
|
||||
### Success Validation
|
||||
|
||||
@ -646,40 +637,21 @@ After applying agent fixes, test with:
|
||||
| `/sc:test` | quality-engineer | security-engineer, performance-engineer |
|
||||
| `/sc:explain` | learning-guide | technical-writer, domain specialists |
|
||||
|
||||
### Most Effective Agent Combinations
|
||||
### Effective Agent Combinations
|
||||
|
||||
**Development Workflows**:
|
||||
```bash
|
||||
# Web application (4-5 agents)
|
||||
frontend-architect + backend-architect + security-engineer + quality-engineer + devops-architect
|
||||
|
||||
# API development (3-4 agents)
|
||||
backend-architect + security-engineer + technical-writer + quality-engineer
|
||||
|
||||
# Data platform (3-4 agents)
|
||||
python-expert + performance-engineer + security-engineer + system-architect
|
||||
```
|
||||
- Web application: frontend-architect + backend-architect + security-engineer + quality-engineer + devops-architect
|
||||
- API development: backend-architect + security-engineer + technical-writer + quality-engineer
|
||||
- Data platform: python-expert + performance-engineer + security-engineer + system-architect
|
||||
|
||||
**Analysis Workflows**:
|
||||
```bash
|
||||
# Security audit (3-4 agents)
|
||||
security-engineer + quality-engineer + root-cause-analyst + technical-writer
|
||||
|
||||
# Performance investigation (3-4 agents)
|
||||
performance-engineer + root-cause-analyst + system-architect + devops-architect
|
||||
|
||||
# Legacy assessment (4-5 agents)
|
||||
refactoring-expert + system-architect + quality-engineer + security-engineer + technical-writer
|
||||
```
|
||||
- Security audit: security-engineer + quality-engineer + root-cause-analyst + technical-writer
|
||||
- Performance investigation: performance-engineer + root-cause-analyst + system-architect + devops-architect
|
||||
- Legacy assessment: refactoring-expert + system-architect + quality-engineer + security-engineer + technical-writer
|
||||
|
||||
**Communication Workflows**:
|
||||
```bash
|
||||
# Technical documentation (3-4 agents)
|
||||
technical-writer + requirements-analyst + domain experts + learning-guide
|
||||
|
||||
# Educational content (3-4 agents)
|
||||
learning-guide + technical-writer + frontend-architect + quality-engineer
|
||||
```
|
||||
- Technical documentation: technical-writer + requirements-analyst + domain experts + learning-guide
|
||||
- Educational content: learning-guide + technical-writer + frontend-architect + quality-engineer
|
||||
|
||||
## Best Practices 💡
|
||||
|
||||
@ -813,7 +785,7 @@ Add "documented", "explained", or "tutorial" to requests for automatic technical
|
||||
**What Not to Worry About**:
|
||||
- Manual agent selection or configuration
|
||||
- Complex routing rules or agent management
|
||||
- Agent performance tuning or optimization
|
||||
- Agent configuration or coordination
|
||||
- Micromanaging agent interactions
|
||||
|
||||
---
|
||||
@ -845,9 +817,9 @@ Start with natural language descriptions. Notice which agents activate and why.
|
||||
Observe agent coordination patterns. Understand how complexity and domain keywords influence agent selection. Begin optimizing request phrasing for better coordination.
|
||||
|
||||
**Month 2+: Expert Coordination**
|
||||
Master multi-domain requests that trigger optimal agent combinations. Leverage troubleshooting techniques for perfect agent selection. Use advanced patterns for complex workflows.
|
||||
Master multi-domain requests that trigger optimal agent combinations. Leverage troubleshooting techniques for effective agent selection. Use advanced patterns for complex workflows.
|
||||
|
||||
**The SuperClaude Advantage:**
|
||||
Experience the power of 13 specialized AI experts working in perfect coordination, all through simple, natural language requests. No configuration, no management, just intelligent collaboration that scales with your needs.
|
||||
Experience the power of 13 specialized AI experts working in coordinated response, all through simple, natural language requests. No configuration, no management, just intelligent collaboration that scales with your needs.
|
||||
|
||||
🎯 **Ready to experience intelligent agent coordination? Start with `/sc:implement` and discover the magic of specialized AI collaboration.**
|
||||
@ -14,7 +14,7 @@ SuperClaude provides 21 commands for Claude Code: `/sc:*` commands for workflows
|
||||
```bash
|
||||
# Terminal: Verify installation
|
||||
python3 -m SuperClaude --version
|
||||
# Alternative: SuperClaude --version (if installed globally)
|
||||
# Claude Code CLI verification: claude --version
|
||||
|
||||
# Claude Code: Test commands
|
||||
/sc:brainstorm "test project" # Should ask discovery questions
|
||||
@ -74,12 +74,11 @@ SuperClaude provides behavioral context files that Claude Code reads to adopt sp
|
||||
python3 -m SuperClaude --version
|
||||
# Example output: SuperClaude 4.0.0
|
||||
|
||||
# Alternative version check (if installed globally)
|
||||
SuperClaude --version
|
||||
# Example output: SuperClaude 4.0.0
|
||||
# Claude Code CLI version check
|
||||
claude --version
|
||||
|
||||
# Check MCP server connectivity
|
||||
SuperClaude install --list-components | grep mcp
|
||||
# Check installed components
|
||||
python3 -m SuperClaude install --list-components | grep mcp
|
||||
# Example output: Shows installed MCP components
|
||||
```
|
||||
|
||||
@ -297,7 +296,7 @@ SuperClaude install --list-components | grep mcp
|
||||
**Command Issues:**
|
||||
- **Command not found**: Verify installation: `python3 -m SuperClaude --version`
|
||||
- **No response**: Restart Claude Code session
|
||||
- **Slow performance**: Use `--no-mcp` to test without MCP servers
|
||||
- **Processing delays**: Use `--no-mcp` to test without MCP servers
|
||||
|
||||
**Quick Fixes:**
|
||||
- Reset session: `/sc:load` to reinitialize
|
||||
|
||||
@ -8,7 +8,7 @@ MCP (Model Context Protocol) servers extend Claude Code's capabilities through s
|
||||
- **What MCP servers are**: External Node.js processes that provide additional tools
|
||||
- **What they aren't**: Built-in SuperClaude functionality
|
||||
- **How activation works**: Claude reads instructions to use appropriate servers based on context
|
||||
- **Why they're powerful**: Real tools that extend Claude Code's native capabilities
|
||||
- **What they provide**: Real tools that extend Claude Code's native capabilities
|
||||
|
||||
**Core Servers:**
|
||||
- **context7**: Official library documentation and patterns
|
||||
@ -66,7 +66,7 @@ MCP (Model Context Protocol) servers extend Claude Code's capabilities through s
|
||||
### magic ✨
|
||||
**Purpose**: Modern UI component generation from 21st.dev patterns
|
||||
**Triggers**: UI requests, `/ui` commands, component development
|
||||
**Requirements**: Node.js 16+, TWENTYFIRST_API_KEY (⚠️ EXPERIMENTAL - verify service exists)
|
||||
**Requirements**: Node.js 16+, TWENTYFIRST_API_KEY ()
|
||||
|
||||
```bash
|
||||
# Automatic activation
|
||||
@ -94,7 +94,7 @@ export TWENTYFIRST_API_KEY="your_key_here"
|
||||
### morphllm-fast-apply 🔄
|
||||
**Purpose**: Efficient pattern-based code transformations
|
||||
**Triggers**: Multi-file edits, refactoring, framework migrations
|
||||
**Requirements**: Node.js 16+, MORPH_API_KEY (⚠️ EXPERIMENTAL - verify service exists)
|
||||
**Requirements**: Node.js 16+, MORPH_API_KEY
|
||||
|
||||
```bash
|
||||
# Automatic activation
|
||||
@ -261,7 +261,7 @@ echo 'export MORPH_API_KEY="your_key"' >> ~/.bashrc
|
||||
|
||||
**Essential Reading:**
|
||||
- [Commands Guide](commands.md) - Commands that activate MCP servers
|
||||
- [Quick Start Guide](../Getting-Started/quick-start.md) - First MCP experience
|
||||
- [Quick Start Guide](../Getting-Started/quick-start.md) - MCP setup guide
|
||||
|
||||
**Advanced Usage:**
|
||||
- [Behavioral Modes](modes.md) - Mode-MCP coordination
|
||||
|
||||
@ -12,7 +12,7 @@ Test modes by using `/sc:` commands - they activate automatically based on task
|
||||
| **📋 Task Management** | Complex coordination | >3 steps, >2 directories | Phase breakdown, memory persistence | Multi-step operations, project management |
|
||||
| **🎯 Orchestration** | Intelligent tool selection | Multi-tool ops, high resource usage | Optimal tool routing, parallel execution | Complex analysis, performance optimization |
|
||||
| **⚡ Token Efficiency** | Compressed communication | High context usage, `--uc` flag | Symbol systems, estimated 30-50% token reduction | Resource constraints, large operations |
|
||||
| **🎨 Standard** | Balanced default | Simple tasks, no complexity triggers | Clear professional communication | General development, straightforward tasks |
|
||||
|
||||
|
||||
---
|
||||
|
||||
@ -172,7 +172,7 @@ Task Management Approach:
|
||||
- **Intelligent Tool Routing**: Selects optimal MCP servers and native tools for each task type
|
||||
- **Resource Awareness**: Adapts approach based on system constraints and availability
|
||||
- **Parallel Optimization**: Identifies independent operations for concurrent execution
|
||||
- **Performance Focus**: Maximizes speed and effectiveness through coordinated tool usage
|
||||
- **Coordination Focus**: Optimizes tool selection and usage through coordinated execution
|
||||
- **Adaptive Fallback**: Switches tools gracefully when preferred options are unavailable
|
||||
|
||||
**Example Experience:**
|
||||
@ -184,7 +184,7 @@ Orchestration Approach:
|
||||
⚡ Phase 2: Morphllm (pattern edits) + Magic (UI components)
|
||||
🧪 Phase 3: Playwright (testing) + Context7 (documentation patterns)
|
||||
🔄 Parallel execution: 3 tools working simultaneously
|
||||
📈 Efficiency gain: 60% faster than sequential approach"
|
||||
\"
|
||||
```
|
||||
|
||||
**Works Best With:**
|
||||
@ -209,7 +209,7 @@ Orchestration Approach:
|
||||
- **Technical Abbreviation**: Context-aware compression for repeated technical terms
|
||||
- **Structured Density**: Bullet points, tables, and concise formatting over verbose paragraphs
|
||||
- **Information Preservation**: Maintains ≥95% information quality despite compression
|
||||
- **Scannable Format**: Optimizes for quick comprehension and task completion
|
||||
- **Structured Format**: Organized for clarity and task completion
|
||||
|
||||
**Example Experience:**
|
||||
```
|
||||
@ -408,11 +408,11 @@ For troubleshooting help, see:
|
||||
- [Common Issues](../Reference/common-issues.md) - Quick fixes for frequent problems
|
||||
- [Troubleshooting Guide](../Reference/troubleshooting.md) - Comprehensive problem resolution
|
||||
|
||||
### Common Issues (< 2 minutes)
|
||||
### Common Issues
|
||||
- **Mode not activating**: Use manual flags: `--brainstorm`, `--introspect`, `--uc`
|
||||
- **Wrong mode active**: Check complexity triggers and keywords in request
|
||||
- **Mode switching unexpectedly**: Normal behavior based on task evolution
|
||||
- **Performance impact**: Modes optimize performance, shouldn't slow execution
|
||||
- **Execution impact**: Modes optimize tool usage, shouldn't affect execution
|
||||
- **Mode conflicts**: Check flag priority rules in [Flags Guide](flags.md)
|
||||
|
||||
### Immediate Fixes
|
||||
@ -523,7 +523,7 @@ After applying mode fixes, test with:
|
||||
- **Mode not activating** → Use manual flags: `--brainstorm`, `--introspect`, `--uc`
|
||||
- **Wrong mode active** → Check complexity triggers and keywords in request
|
||||
- **Mode switching unexpectedly** → Normal behavior based on task evolution
|
||||
- **Performance impact** → Modes optimize performance, shouldn't slow execution
|
||||
- **Execution impact** → Modes optimize tool usage, shouldn't affect execution
|
||||
- **Mode conflicts** → Check flag priority rules in [Flags Guide](flags.md)
|
||||
|
||||
## Frequently Asked Questions
|
||||
@ -545,8 +545,8 @@ A: Yes, use manual flags to override automatic detection:
|
||||
/sc:command --uc # Compress output
|
||||
```
|
||||
|
||||
**Q: Do modes affect performance?**
|
||||
A: Modes enhance performance through optimization:
|
||||
**Q: Do modes affect execution?**
|
||||
A: Modes optimize tool usage through coordination:
|
||||
- **Token Efficiency**: 30-50% context reduction
|
||||
- **Orchestration**: Parallel processing
|
||||
- **Task Management**: Prevents rework through systematic planning
|
||||
@ -561,7 +561,7 @@ A: Yes, modes are designed to complement each other:
|
||||
|
||||
## Summary
|
||||
|
||||
SuperClaude's 6 behavioral modes create an **intelligent adaptation system** that matches your needs automatically:
|
||||
SuperClaude's 5 behavioral modes create an **intelligent adaptation system** that matches your needs automatically:
|
||||
|
||||
- **🧠 Brainstorming**: Transforms vague ideas into clear requirements
|
||||
- **🔍 Introspection**: Provides transparent reasoning for learning and debugging
|
||||
@ -579,7 +579,7 @@ SuperClaude's 6 behavioral modes create an **intelligent adaptation system** tha
|
||||
**Learning Progression:**
|
||||
|
||||
**🌱 Essential (Week 1)**
|
||||
- [Quick Start Guide](../Getting-Started/quick-start.md) - Experience modes naturally
|
||||
- [Quick Start Guide](../Getting-Started/quick-start.md) - Mode activation examples
|
||||
- [Commands Reference](commands.md) - Commands automatically activate modes
|
||||
- [Installation Guide](../Getting-Started/installation.md) - Set up behavioral modes
|
||||
|
||||
@ -591,7 +591,7 @@ SuperClaude's 6 behavioral modes create an **intelligent adaptation system** tha
|
||||
**🌲 Advanced (Month 2+)**
|
||||
- [MCP Servers](mcp-servers.md) - Mode integration with enhanced capabilities
|
||||
- [Session Management](session-management.md) - Task Management mode workflows
|
||||
- [Getting Started](../Getting-Started/quick-start.md) - Mode optimization strategies
|
||||
- [Getting Started](../Getting-Started/quick-start.md) - Mode usage patterns
|
||||
|
||||
**🔧 Expert**
|
||||
- [Technical Architecture](../Developer-Guide/technical-architecture.md) - Mode implementation details
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user