Files
SuperClaude/ARCHITECTURE_OVERVIEW.md
NomenAK 8ab6e9ebbe docs: Comprehensive documentation update for SuperClaude V4 Beta
Updated all root documentation to reflect V4 Beta capabilities:

Root Documentation:
- VERSION: Updated to 4.0.0-beta.1
- README.md: Complete rewrite with V4 features (21 commands, 13 agents, 6 MCP servers)
- ARCHITECTURE_OVERVIEW.md: Updated for V4 Beta with correct counts and new features
- CHANGELOG.md: Added comprehensive V4.0.0-beta.1 release section
- ROADMAP.md: Added V4 Beta current status and updated future vision
- CONTRIBUTING.md: Updated architecture, testing, and contribution guidelines
- SECURITY.md: Added V4 security features and version support table
- MANIFEST.in: Updated to include new V4 directories
- pyproject.toml: Updated URLs and description for V4 Beta

User Documentation:
- commands-guide.md: Updated to 21 commands with new V4 commands
- superclaude-user-guide.md: Comprehensive V4 Beta features documentation
- flags-guide.md: Updated with new V4 flags and agent system
- installation-guide.md: V4 Beta installation including hooks system
- agents-guide.md: NEW - Complete guide for 13 specialized agents
- personas-guide.md: Renamed to personas-guide-v3-legacy.md

Key V4 Beta Features Documented:
- 21 specialized commands (added: brainstorm, reflect, save, select-tool)
- 13 domain expert agents replacing persona system
- 6 MCP servers (added Morphllm and Serena)
- 4 Behavioral Modes (Brainstorming, Introspection, Task Management, Token Efficiency)
- Session Lifecycle with cross-session persistence
- Redesigned Hooks System with Python integration
- SuperClaude-Lite minimal implementation
- Comprehensive Templates system

All documentation maintains friendly, accessible tone while accurately reflecting V4 Beta's advanced capabilities.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-05 14:44:37 +02:00

399 lines
17 KiB
Markdown

# SuperClaude Architecture Overview
## Introduction
SuperClaude V4 Beta is a comprehensive framework that extends Claude Code with specialized commands, intelligent routing, and MCP server integration for advanced development workflows. The framework has evolved from a Python-based implementation to a markdown-driven orchestration system that emphasizes configuration over code, now featuring a production-ready hooks system and comprehensive session lifecycle management.
## Core Philosophy
SuperClaude operates as an orchestration layer that:
- Enhances Claude Code with 21 specialized slash commands for common development tasks
- Integrates 6 MCP servers for extended capabilities (Context7, Sequential, Magic, Playwright, Morphllm, Serena)
- Provides intelligent routing and persona-based task execution
- Enables sophisticated development workflows through declarative configuration
## Architecture Layers
### 1. Framework Core (`SuperClaude/Core/`)
The framework core consists of markdown documents installed to `~/.claude/` that guide Claude's behavior:
- **CLAUDE.md**: Entry point that references all framework components
- **FLAGS.md**: Behavior modification flags (--think, --delegate, --uc, etc.)
- **PRINCIPLES.md**: Core development principles and philosophy
- **RULES.md**: Actionable rules for framework operation
- **ORCHESTRATOR.md**: Intelligent routing system for tool and persona selection
- **SESSION_LIFECYCLE.md**: Session management patterns with Serena MCP integration
### 2. Commands Layer (`SuperClaude/Commands/`)
21 slash commands organized by category:
#### Utility Commands (Basic Complexity)
- `/sc:analyze` - Code analysis and insights
- `/sc:build` - Project building and packaging
- `/sc:design` - Technical design generation
- `/sc:document` - Documentation creation
- `/sc:git` - Git operations and workflows
- `/sc:test` - Test execution and analysis
- `/sc:troubleshoot` - Problem diagnosis
#### Workflow Commands (Standard Complexity)
- `/sc:cleanup` - Code cleanup and optimization
- `/sc:estimate` - Effort estimation
- `/sc:explain` - Code explanation
- `/sc:implement` - Feature implementation
- `/sc:improve` - Code enhancement
- `/sc:index` - Project indexing
#### Orchestration Commands (Advanced Complexity)
- `/sc:brainstorm` - Interactive requirements discovery
- `/sc:task` - Multi-session task management
- `/sc:workflow` - Complex workflow orchestration
#### Special Commands (High Complexity)
- `/sc:spawn` - Meta-orchestration for complex operations
- `/sc:select-tool` - Intelligent tool selection
#### Session Commands (Cross-Session)
- `/sc:load` - Project context loading with Serena
- `/sc:save` - Session persistence and checkpointing
- `/sc:reflect` - Task reflection and validation
### 3. MCP Server Integration (`SuperClaude/MCP/`)
Six specialized MCP servers provide extended capabilities:
1. **Context7**: Official library documentation and patterns
2. **Sequential**: Multi-step problem solving and analysis
3. **Magic**: UI component generation and design systems
4. **Playwright**: Browser automation and E2E testing
5. **Morphllm**: Intelligent file editing with Fast Apply
6. **Serena**: Semantic code analysis and memory management
### 4. Behavioral Modes (`SuperClaude/Modes/`)
Four behavioral modes that modify Claude's operational approach:
1. **Brainstorming Mode**: Interactive requirements discovery
2. **Introspection Mode**: Meta-cognitive analysis
3. **Task Management Mode**: Multi-layer task orchestration
4. **Token Efficiency Mode**: Intelligent compression (30-50% reduction)
### 5. Agent System (`SuperClaude/Agents/`)
13 specialized agents organized by domain:
#### Analysis Agents
- `security-auditor`: Security vulnerability detection
- `root-cause-analyzer`: Systematic issue investigation
- `performance-optimizer`: Performance bottleneck resolution
#### Design Agents
- `system-architect`: System design and architecture
- `backend-engineer`: Backend development expertise
- `frontend-specialist`: Frontend and UI development
#### Quality Agents
- `qa-specialist`: Testing strategy and execution
- `code-refactorer`: Code quality improvement
#### Education Agents
- `technical-writer`: Documentation creation
- `code-educator`: Programming education
#### Infrastructure Agents
- `devops-engineer`: Infrastructure and deployment
#### Special Agents
- `brainstorm-PRD`: Requirements to PRD transformation
- `python-ultimate-expert`: Advanced Python development and architecture
### 6. Hooks System (`SuperClaude/Hooks/`)
Production-ready Python-based hooks system providing comprehensive framework integration:
#### Core Hook Categories
- **session_lifecycle**: Complete session management with automatic checkpointing, state persistence, and cross-session continuity
- **performance_monitor**: Real-time performance tracking with PRD target validation (<200ms memory ops, <500ms loading)
- **quality_gates**: 8-step validation cycle with automated enforcement and quality preservation
- **framework_coordinator**: Intelligent framework component coordination and orchestration
#### Implementation Features
- **Zero-config Installation**: Automatic detection and integration with existing Claude Code installations
- **Performance Monitoring**: Real-time tracking against PRD targets with automatic optimization suggestions
- **Session Persistence**: Automatic checkpointing with intelligent trigger detection (30min/task completion/risk level)
- **Quality Enforcement**: Automated quality gate validation with comprehensive reporting
- **Error Recovery**: Robust error handling with automatic fallback and recovery mechanisms
#### Hook Architecture
- **Modular Design**: Independent hook modules with clear separation of concerns
- **Event-Driven**: React to Claude Code lifecycle events and user interactions
- **Configuration-Driven**: YAML-based configuration with intelligent defaults
- **Extension Points**: Plugin architecture for custom hook development
## Key Integration Patterns
### 1. Command-MCP Integration
Commands declare MCP server requirements in metadata:
```yaml
mcp-integration:
servers: [serena, morphllm]
personas: [backend-engineer]
wave-enabled: true
```
### 2. Mode-Command Coordination
Modes provide behavioral frameworks, commands provide execution:
- Brainstorming Mode detects ambiguous requests
- `/sc:brainstorm` command executes discovery dialogue
- Mode patterns applied throughout execution
### 3. Intelligent Routing
The ORCHESTRATOR.md provides routing logic:
```yaml
pattern_matching:
ui_component → Magic + frontend persona
deep_analysis → Sequential + think modes
symbol_operations → Serena + LSP precision
pattern_edits → Morphllm + token optimization
```
### 4. Session Lifecycle Pattern
The Session Lifecycle Pattern enables continuous learning and context preservation:
```
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ /sc:load │────▶│ WORK │────▶│ /sc:save │────▶│ NEXT │
│ (INIT) │ │ (ACTIVE) │ │ (CHECKPOINT)│ │ SESSION │
└─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘
│ │ │ │
└────────────────────┴────────────────────┴─ Enhanced Context ┘
```
#### Session States & Transitions
**INITIALIZING** (`/sc:load`)
- Activate project via Serena's `activate_project`
- Load existing memories and context via `list_memories`
- Build comprehensive project understanding
- Initialize session metadata and tracking structures
- Performance target: <500ms
**ACTIVE** (Working Session)
- Full project context available for all operations
- Automatic checkpoint triggers: 30min intervals, task completion, risk operations
- Decision logging and pattern recognition
- Context accumulation and learning
**CHECKPOINTED** (`/sc:save`)
- Session analysis via Serena's `think_about_collected_information`
- Persist discoveries to structured memory system
- Create checkpoint with comprehensive metadata
- Generate summaries and insights
- Performance target: <2000ms
**RESUMED** (Next Session)
- Load latest checkpoint and restore context
- Display resumption summary with work completed
- Restore decision context and active tasks
- Continue from preserved state with enhanced understanding
#### Memory Organization Strategy
```
memories/
├── session/{timestamp} # Session records with metadata
├── checkpoints/{timestamp} # Checkpoint snapshots
├── summaries/daily/{date} # Daily work summaries
├── project_state/context_enhanced # Accumulated learning
└── decisions_log/ # Architecture decisions
```
#### Automatic Checkpoint Triggers
- **Time-based**: Every 30 minutes of active work
- **Task-based**: Major task completion (priority="high")
- **Risk-based**: Before high-risk operations (>50 files, architecture changes)
- **Error Recovery**: After recovering from errors or failures
## SuperClaude-Lite Implementation
SuperClaude V4 Beta introduces SuperClaude-Lite, a streamlined implementation designed for rapid deployment and essential functionality:
### Core Design Philosophy
- **Minimal Footprint**: Essential commands and features only, optimized for quick setup
- **Zero Dependencies**: No MCP servers or Python hooks required for basic operation
- **Progressive Enhancement**: Full SuperClaude features available when needed
- **Universal Compatibility**: Works across all Claude Code installations without configuration
### Lite Architecture Components
#### Essential Commands (8 Core Commands)
- `/sc:analyze` - Basic code analysis without MCP dependencies
- `/sc:build` - Simplified build orchestration
- `/sc:document` - Documentation generation with built-in patterns
- `/sc:explain` - Code explanation using native Claude capabilities
- `/sc:implement` - Feature implementation with intelligent routing
- `/sc:improve` - Code enhancement without external dependencies
- `/sc:test` - Testing workflows with standard tooling
- `/sc:troubleshoot` - Problem diagnosis using native analysis
#### Streamlined Core Framework
- **CLAUDE_LITE.md**: Lightweight entry point with essential configurations
- **FLAGS_LITE.md**: Core behavior flags (--think, --plan, --validate)
- **RULES_LITE.md**: Essential operational rules and patterns
- **ORCHESTRATOR_LITE.md**: Simplified routing without MCP dependencies
#### Progressive Enhancement Strategy
```yaml
deployment_levels:
lite: [essential_commands, core_framework, native_capabilities]
standard: [+ mcp_servers, behavioral_modes, agent_system]
full: [+ hooks_system, session_lifecycle, advanced_orchestration]
```
#### Lite-to-Full Migration Path
1. **Start with Lite**: Deploy core commands and framework in minutes
2. **Add MCP Servers**: Enable specific capabilities (Context7, Serena, etc.)
3. **Enable Modes**: Activate behavioral modes for enhanced workflows
4. **Install Hooks**: Add Python hooks for session lifecycle and monitoring
5. **Full Framework**: Complete SuperClaude experience with all features
### Performance Benefits
- **Installation Time**: <2 minutes vs 10-15 minutes for full framework
- **Memory Footprint**: ~500KB vs ~2MB for full framework
- **Boot Time**: <100ms vs <500ms for full framework initialization
- **Learning Curve**: Essential commands learnable in <1 hour
### Use Cases for SuperClaude-Lite
- **Quick Prototyping**: Rapid development workflows without setup overhead
- **Team Onboarding**: Introduce SuperClaude concepts gradually
- **Resource-Constrained Environments**: Minimal resource usage requirements
- **Legacy Compatibility**: Works with older Claude Code versions
- **Emergency Access**: Backup framework when full version unavailable
### Migration and Compatibility
- **Bidirectional Compatibility**: Lite commands work in full framework
- **Incremental Enhancement**: Add features without breaking existing workflows
- **Configuration Inheritance**: Lite settings automatically upgraded
- **Data Preservation**: Session data preserved during upgrade process
## Performance Architecture
### Target Metrics
- Memory operations: <200ms
- Project loading: <500ms
- Tool selection: <100ms
- Session save: <2000ms
- Checkpoint creation: <1000ms
### Optimization Strategies
- MCP server caching and coordination
- Token efficiency mode for large operations
- Parallel execution with wave orchestration
- Intelligent tool selection based on complexity
## Quality Assurance
### 8-Step Quality Cycle
1. Syntax Validation
2. Type Analysis
3. Lint Rules
4. Security Assessment
5. E2E Testing
6. Performance Analysis
7. Documentation Patterns
8. Integration Testing
### Quality Gates Integration
- Commands integrate at steps 2.5 and 7.5
- MCP servers provide specialized validation
- Hooks enforce quality standards
## Installation and Configuration
### Directory Structure
```
~/.claude/
├── CLAUDE.md (entry point)
├── Core framework files
├── MCP server configurations
├── Mode definitions
└── Session data
SuperClaude/
├── Core/ # Framework documents
├── Commands/ # Command definitions
├── Agents/ # Agent specifications
├── MCP/ # MCP server configs
├── Modes/ # Behavioral modes
└── Hooks/ # Python hooks
```
### Installation Process
1. Framework files copied to `~/.claude/`
2. Python hooks installed and configured
3. MCP servers configured in Claude Code
4. Session lifecycle initialized
## Evolution and Future
SuperClaude has evolved through multiple generations to become a production-ready orchestration framework:
### Framework Evolution
- **v1-v2**: Python-based with complex implementation and manual configuration
- **v3**: Markdown-driven orchestration framework with intelligent routing
- **V4 Beta**: Production-ready system with hooks, session lifecycle, and SuperClaude-Lite
### V4 Beta Achievements
- **Production Hooks System**: Zero-config Python hooks with automatic detection and integration
- **Session Lifecycle Management**: Complete session persistence with Serena MCP integration
- **SuperClaude-Lite**: Streamlined implementation for rapid deployment and progressive enhancement
- **Enhanced Agent System**: 13 specialized agents including python-ultimate-expert
- **Advanced Performance Monitoring**: Real-time PRD target validation and optimization
- **Comprehensive Quality Gates**: 8-step validation cycle with automated enforcement
- **GitHub Organization Migration**: Moved from NomenAK to SuperClaude-Org for better organization
### Current Capabilities (V4 Beta)
- **21 Commands**: Complete command set covering all development workflows
- **6 MCP Servers**: Full integration with Context7, Sequential, Magic, Playwright, Morphllm, Serena
- **13 Specialized Agents**: Domain-specific expertise with intelligent routing
- **4 Behavioral Modes**: Advanced workflow modification and optimization
- **Production Hooks**: Real-time performance monitoring and quality enforcement
- **Session Continuity**: Cross-session learning and context preservation
### Future Roadmap
- **V4 Stable**: Performance optimization, stability improvements, comprehensive testing
- **V5 Planning**: Enhanced AI coordination, collaborative workflows, advanced analytics
- **Enterprise Features**: Team management, organizational policies, audit trails
- **Integration Expansion**: Additional MCP servers, IDE plugins, CI/CD integration
The framework continues to evolve with focus on:
- **Reliability**: Production-grade stability and error recovery
- **Performance**: Sub-200ms operations and intelligent optimization
- **Accessibility**: SuperClaude-Lite for rapid onboarding and deployment
- **Intelligence**: Advanced AI coordination and decision-making capabilities
## Summary
SuperClaude V4 Beta represents a production-ready orchestration framework that extends Claude Code through:
- **21 specialized commands** covering all development workflows
- **6 MCP servers** providing extended capabilities and intelligence
- **13 specialized agents** with domain expertise and intelligent routing
- **4 behavioral modes** for advanced workflow modification
- **Production hooks system** with zero-config installation and real-time monitoring
- **Session lifecycle management** with cross-session learning and context preservation
- **SuperClaude-Lite** for rapid deployment and progressive enhancement
- **Comprehensive quality gates** with 8-step validation cycles
The architecture emphasizes **reliability**, **performance**, and **accessibility** while maintaining sophisticated capabilities through intelligent orchestration. V4 Beta delivers production-grade stability with sub-200ms operation targets, comprehensive error recovery, and seamless integration across the entire Claude Code ecosystem.
### Key Differentiators
- **Zero-config deployment** with intelligent defaults and automatic detection
- **Progressive enhancement** from Lite to Full framework capabilities
- **Real-time performance monitoring** against PRD targets with optimization suggestions
- **Cross-session continuity** preserving context and learning across work sessions
- **Comprehensive integration** with MCP servers, behavioral modes, and quality enforcement