mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
23a103d5dc
- Fix @include references to use underscore format (Universal_Legend, Standard_Messages_Templates) - Add missing ultracompressed.yml shared pattern file - Update broken reference paths in all 18 command files - Ensure consistent template naming across command system - Optimize command file structure with standardized includes 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
331 lines
13 KiB
Markdown
331 lines
13 KiB
Markdown
# SuperClaude – The Professional Development Framework for Claude Code
|
||
|
||
[](https://opensource.org/licenses/MIT)
|
||
[](https://github.com/NomenAK/SuperClaude)
|
||
[](https://github.com/NomenAK/SuperClaude/issues)
|
||
[](https://github.com/NomenAK/SuperClaude/blob/master/CONTRIBUTING.md)
|
||
|
||
**A sophisticated configuration framework that transforms Claude Code into a specialized, token-efficient development partner with 18 professional commands, 9 cognitive personas, and evidence-based methodology.**
|
||
|
||
## 🎯 The Professional Problem
|
||
|
||
Claude Code is powerful, but lacks specialization. Development teams need:
|
||
- **Consistent expertise** across different technical domains
|
||
- **Token efficiency** for complex, long-running projects
|
||
- **Evidence-based standards** instead of generic suggestions
|
||
- **Context preservation** during multi-session debugging
|
||
- **Specialized thinking modes** for architecture, security, performance
|
||
|
||
## ✨ The SuperClaude Solution
|
||
|
||
SuperClaude transforms Claude Code into a professional development framework with:
|
||
- **18 Specialized Commands** covering the complete development lifecycle
|
||
- **9 Cognitive Personas** for domain-specific expertise
|
||
- **Advanced Token Optimization** with 70% reduction capabilities
|
||
- **Evidence-Based Methodology** requiring documentation and metrics
|
||
- **Professional MCP Integration** with Context7, Sequential, Magic, Puppeteer
|
||
- **Git-Integrated Checkpoints** for safe experimentation
|
||
|
||
## 🚀 Professional Installation
|
||
|
||
```bash
|
||
git clone https://github.com/NomenAK/SuperClaude.git
|
||
cd SuperClaude
|
||
./install.sh # Default: ~/.claude/
|
||
# OR
|
||
./install.sh --dir /opt/claude # Custom location
|
||
./install.sh --dir ./project-claude # Project-specific
|
||
```
|
||
|
||
Zero dependencies. Installs to `~/.claude/` by default. The installer automatically backs up existing configurations and validates the installation.
|
||
|
||
## 💡 Core Capabilities
|
||
|
||
### 🧠 **Cognitive Personas**
|
||
Switch Claude's entire professional mindset:
|
||
|
||
```bash
|
||
/analyze --persona-architect # Systems thinking, scalability focus
|
||
/build --persona-frontend # UX-obsessed, accessibility-first
|
||
/scan --persona-security # Threat modeling, zero-trust
|
||
/troubleshoot --persona-analyzer # Evidence-based root cause analysis
|
||
```
|
||
|
||
Each persona brings specialized knowledge, different priorities, and domain-specific best practices.
|
||
|
||
### ⚡ **18 Professional Commands**
|
||
Complete development lifecycle coverage:
|
||
|
||
**Development Commands**
|
||
```bash
|
||
/build --react --magic --tdd # Full-stack development with AI components
|
||
/dev-setup --ci --monitor # Professional environment setup
|
||
/test --coverage --e2e --pup # Comprehensive testing strategies
|
||
```
|
||
|
||
**Analysis & Quality**
|
||
```bash
|
||
/analyze --architecture --seq # Deep system analysis
|
||
/troubleshoot --prod --five-whys # Production issue resolution
|
||
/improve --performance --iterate # Evidence-based optimization
|
||
/explain --depth expert --visual # Technical documentation
|
||
```
|
||
|
||
**Operations & Security**
|
||
```bash
|
||
/deploy --env prod --plan # Safe production deployment
|
||
/scan --security --owasp --deps # Professional security audits
|
||
/migrate --dry-run --rollback # Safe database migrations
|
||
/cleanup --all --validate # Professional maintenance
|
||
```
|
||
|
||
### 🎛️ **Advanced MCP Integration**
|
||
- **Context7**: Instant access to official library documentation
|
||
- **Sequential**: Multi-step reasoning for complex problems
|
||
- **Magic**: AI-generated UI components matching your patterns
|
||
- **Puppeteer**: Real browser testing and validation
|
||
|
||
### 📊 **Token Efficiency Architecture**
|
||
SuperClaude's @include template system eliminates duplication:
|
||
- **70% token reduction** with UltraCompressed mode
|
||
- **Template reference validation** ensures system integrity
|
||
- **Smart caching** prevents redundant operations
|
||
- **Dynamic compression** based on context usage
|
||
|
||
## 🎮 Professional Workflows
|
||
|
||
### Enterprise Architecture Flow
|
||
```bash
|
||
--persona-architect
|
||
/design --api --ddd --bounded-context # Domain-driven design
|
||
/estimate --detailed --worst-case # Resource planning
|
||
--persona-security
|
||
/scan --security --validate # Security review
|
||
--persona-backend
|
||
/build --api --tdd --coverage # Professional implementation
|
||
```
|
||
|
||
### Production Issue Resolution
|
||
```bash
|
||
--persona-analyzer
|
||
/troubleshoot --investigate --prod # Systematic analysis
|
||
/analyze --profile --perf # Performance bottlenecks
|
||
--persona-performance
|
||
/improve --performance --threshold 95% # Optimization targets
|
||
/test --integration --e2e # Validation testing
|
||
```
|
||
|
||
### Full-Stack Feature Development
|
||
```bash
|
||
--persona-frontend
|
||
/build --react --magic --watch # UI development
|
||
--persona-qa
|
||
/test --coverage --e2e --strict # Quality assurance
|
||
--persona-security
|
||
/scan --validate --deps # Security validation
|
||
```
|
||
|
||
## 🎭 Professional Personas
|
||
|
||
| Persona | Expertise | Primary Tools | Best For |
|
||
|---------|-----------|---------------|----------|
|
||
| **architect** | System design, scalability | Sequential, Context7 | Architecture decisions |
|
||
| **frontend** | UX, accessibility, performance | Magic, Puppeteer, Context7 | User interfaces |
|
||
| **backend** | APIs, databases, reliability | Context7, Sequential | Server architecture |
|
||
| **security** | Threat modeling, compliance | Sequential, Context7 | Security audits |
|
||
| **analyzer** | Root cause, evidence-based | All MCP tools | Complex debugging |
|
||
| **qa** | Testing, edge cases, quality | Puppeteer, Context7 | Quality assurance |
|
||
| **performance** | Optimization, profiling | Puppeteer, Sequential | Performance tuning |
|
||
| **refactorer** | Code quality, maintainability | Sequential, Context7 | Code improvement |
|
||
| **mentor** | Learning, documentation | Context7, Sequential | Knowledge transfer |
|
||
|
||
## 🛠️ Advanced Configuration
|
||
|
||
### Thinking Depth Control
|
||
```bash
|
||
# Standard analysis
|
||
/analyze --think "multi-file context"
|
||
|
||
# Architecture-level depth
|
||
/design --think-hard "comprehensive system analysis"
|
||
|
||
# Maximum analysis power
|
||
/troubleshoot --ultrathink "critical system debugging"
|
||
```
|
||
|
||
### Token Optimization Modes
|
||
```bash
|
||
# Standard mode for complex operations
|
||
/build --react --magic
|
||
|
||
# UltraCompressed for large projects
|
||
/analyze --architecture --uc
|
||
|
||
# Force native tools only
|
||
/scan --security --no-mcp
|
||
```
|
||
|
||
### Evidence-Based Standards
|
||
SuperClaude enforces professional standards:
|
||
- **Performance claims** require benchmarks and metrics
|
||
- **Library usage** requires official documentation (Context7)
|
||
- **Security assertions** need validation scans
|
||
- **Quality improvements** need test coverage evidence
|
||
- **Architecture decisions** need scalability analysis
|
||
|
||
## 📋 Complete Command Reference
|
||
|
||
### Development (3 Commands)
|
||
- `/build` - Universal project builder with stack templates
|
||
- `/dev-setup` - Professional development environment
|
||
- `/test` - Comprehensive testing framework
|
||
|
||
### Analysis & Improvement (4 Commands)
|
||
- `/analyze` - Multi-dimensional code and system analysis
|
||
- `/troubleshoot` - Professional debugging and issue resolution
|
||
- `/improve` - Evidence-based enhancement and optimization
|
||
- `/explain` - Technical documentation and knowledge transfer
|
||
|
||
### Operations (6 Commands)
|
||
- `/deploy` - Safe application deployment with rollback
|
||
- `/migrate` - Database and code migration management
|
||
- `/scan` - Security audits and validation
|
||
- `/estimate` - Project complexity and time estimation
|
||
- `/cleanup` - Professional project maintenance
|
||
- `/git` - Git workflow with checkpoint management
|
||
|
||
### Design & Workflow (5 Commands)
|
||
- `/design` - System architecture and API design
|
||
- `/spawn` - Parallel specialized agents
|
||
- `/document` - Professional documentation creation
|
||
- `/load` - Project context loading and analysis
|
||
|
||
## 🔧 Technical Architecture
|
||
|
||
SuperClaude implements professional development practices through:
|
||
|
||
**Configuration Framework**
|
||
- **CLAUDE.md** – Core behavioral configuration
|
||
- **RULES.md** – Engineering standards and practices
|
||
- **PERSONAS.md** – Cognitive behavioral profiles
|
||
- **MCP.md** – Tool orchestration and integration
|
||
|
||
**Command System**
|
||
- **18 Specialized Commands** – Complete development lifecycle
|
||
- **Flag Inheritance System** – Consistent interface patterns
|
||
- **@include Templates** – Token-efficient configuration
|
||
- **Validation Framework** – Reference integrity checking
|
||
|
||
**Quality Assurance**
|
||
- **Evidence-Based Standards** – Metrics and documentation required
|
||
- **Research-First Methodology** – Official sources for libraries
|
||
- **Error Recovery Patterns** – Graceful failure handling
|
||
- **Professional Documentation** – Structured output locations
|
||
|
||
## 📊 Professional Advantages
|
||
|
||
| Capability | Standard Claude Code | SuperClaude Framework |
|
||
|------------|---------------------|----------------------|
|
||
| **Expertise** | Generic responses | 9 specialized cognitive personas |
|
||
| **Commands** | Manual instruction | 18 professional workflow commands |
|
||
| **Context** | Lost on errors | Git checkpoint preservation |
|
||
| **Tokens** | Standard verbosity | 70% reduction with same information |
|
||
| **Standards** | Hope for the best | Evidence-based methodology |
|
||
| **Documentation** | "I think this works" | Official source requirements |
|
||
| **Quality** | Ad-hoc suggestions | Professional validation patterns |
|
||
| **Integration** | Basic tool usage | Advanced MCP orchestration |
|
||
|
||
## 🔮 Professional Use Cases
|
||
|
||
**Enterprise Development Teams**
|
||
- Consistent expertise across different technical domains
|
||
- Standardized development workflows and quality gates
|
||
- Evidence-based technical decision making
|
||
- Professional documentation and knowledge transfer
|
||
|
||
**Technical Leaders**
|
||
- Architecture review and system design validation
|
||
- Performance optimization and security auditing
|
||
- Code quality improvement and refactoring
|
||
- Team mentoring and best practice enforcement
|
||
|
||
**Production Operations**
|
||
- Safe deployment and migration procedures
|
||
- Systematic debugging and issue resolution
|
||
- Security compliance and vulnerability management
|
||
- Professional maintenance and cleanup procedures
|
||
|
||
## 🎯 Is SuperClaude Right for Your Team?
|
||
|
||
**Ideal for teams that need:**
|
||
- ✅ Consistent AI expertise across technical domains
|
||
- ✅ Professional development workflows and standards
|
||
- ✅ Evidence-based technical decisions
|
||
- ✅ Token-efficient long-running projects
|
||
- ✅ Specialized cognitive modes for different tasks
|
||
|
||
**Not suitable if you prefer:**
|
||
- ❌ Completely manual AI interaction
|
||
- ❌ Generic, non-specialized responses
|
||
- ❌ Ad-hoc development practices
|
||
- ❌ Minimal configuration frameworks
|
||
|
||
## 🚦 Professional Setup
|
||
|
||
1. **Install SuperClaude**
|
||
```bash
|
||
git clone https://github.com/NomenAK/SuperClaude.git && cd SuperClaude && ./install.sh
|
||
```
|
||
|
||
2. **Validate Installation**
|
||
```bash
|
||
/load # Load project context
|
||
/analyze --code --think # Test analysis capabilities
|
||
--persona-architect # Try cognitive switching
|
||
```
|
||
|
||
3. **Professional Workflows**
|
||
```bash
|
||
/design --api --ddd # Architecture design
|
||
/build --feature --tdd # Implementation
|
||
/test --coverage --e2e # Quality assurance
|
||
/deploy --env staging --plan # Safe deployment
|
||
```
|
||
|
||
## 🛟 Professional Support
|
||
|
||
- **Installation Issues**: Run `./install.sh --help` for configuration options
|
||
- **Command Reference**: Check `~/.claude/commands/` for detailed documentation
|
||
- **Professional Services**: See [CONTRIBUTING.md](CONTRIBUTING.md) for consulting
|
||
- **Issue Tracking**: [GitHub Issues](https://github.com/NomenAK/SuperClaude/issues)
|
||
|
||
## 🤝 Professional Community
|
||
|
||
SuperClaude is maintained by professional developers for professional teams. We welcome:
|
||
- **Enterprise Personas** for specialized industry workflows
|
||
- **Professional Commands** for domain-specific operations
|
||
- **Quality Patterns** for better development practices
|
||
- **Integration Improvements** for team productivity
|
||
|
||
Join our professional development community: [Discussions](https://github.com/NomenAK/SuperClaude/discussions)
|
||
|
||
## 📈 Framework Metrics
|
||
|
||
**Token Efficiency**: 70% average reduction with same information density
|
||
**Command Coverage**: 18 commands across complete development lifecycle
|
||
**Cognitive Diversity**: 9 specialized personas with distinct expertise
|
||
**Integration Depth**: 4 MCP servers with advanced orchestration
|
||
**Quality Standards**: Evidence-based methodology with validation patterns
|
||
**Professional Adoption**: Used by development teams for production systems
|
||
|
||
## 🎉 Transform Your Development Workflow
|
||
|
||
SuperClaude isn't just a configuration – it's a professional development methodology. Every command refined, every persona specialized, every pattern validated by professional development teams.
|
||
|
||
**Ready to elevate your development practices?**
|
||
|
||
---
|
||
|
||
*SuperClaude v4.0.0 – Professional development framework for Claude Code*
|
||
|
||
[⭐ Star us on GitHub](https://github.com/NomenAK/SuperClaude) | [💬 Professional Discussions](https://github.com/NomenAK/SuperClaude/discussions) | [🐛 Report Issues](https://github.com/NomenAK/SuperClaude/issues) |