External/SuperClaude
1
0
Fork 0
mirror of https://github.com/SuperClaude-Org/SuperClaude_Framework.git synced 2025-12-26 06:07:30 +00:00
Code Issues Packages Projects Releases Wiki Activity
SuperClaude/docs/Reference/README.md
kazuki nakai 050d5ea2ab
refactor: PEP8 compliance - directory rename and code formatting (#425) 
* fix(orchestration): add WebFetch auto-trigger for infrastructure configuration

Problem: Infrastructure configuration changes (e.g., Traefik port settings)
were being made based on assumptions without consulting official documentation,
violating the 'Evidence > assumptions' principle in PRINCIPLES.md.

Solution:
- Added Infrastructure Configuration Validation section to MODE_Orchestration.md
- Auto-triggers WebFetch for infrastructure tools (Traefik, nginx, Docker, etc.)
- Enforces MODE_DeepResearch activation for investigation
- BLOCKS assumption-based configuration changes

Testing: Verified WebFetch successfully retrieves Traefik official docs (port 80 default)

This prevents production outages from infrastructure misconfiguration by ensuring
all technical recommendations are backed by official documentation.

* feat: Add PM Agent (Project Manager Agent) for seamless orchestration

Introduces PM Agent as the default orchestration layer that coordinates
all sub-agents and manages workflows automatically.

Key Features:
- Default orchestration: All user interactions handled by PM Agent
- Auto-delegation: Intelligent sub-agent selection based on task analysis
- Docker Gateway integration: Zero-token baseline with dynamic MCP loading
- Self-improvement loop: Automatic documentation of patterns and mistakes
- Optional override: Users can specify sub-agents explicitly if desired

Architecture:
- Agent spec: SuperClaude/Agents/pm-agent.md
- Command: SuperClaude/Commands/pm.md
- Updated docs: README.md (15→16 agents), agents.md (new Orchestration category)

User Experience:
- Default: PM Agent handles everything (seamless, no manual routing)
- Optional: Explicit --agent flag for direct sub-agent access
- Both modes available simultaneously (no user downside)

Implementation Status:
- ✅ Specification complete
- ✅ Documentation complete
- ⏳ Prototype implementation needed
- ⏳ Docker Gateway integration needed
- ⏳ Testing and validation needed

Refs: kazukinakai/docker-mcp-gateway (IRIS MCP Gateway integration)

* feat: Add Agent Orchestration rules for PM Agent default activation

Implements PM Agent as the default orchestration layer in RULES.md.

Key Changes:
- New 'Agent Orchestration' section (CRITICAL priority)
- PM Agent receives ALL user requests by default
- Manual override with @agent-[name] bypasses PM Agent
- Agent Selection Priority clearly defined:
  1. Manual override → Direct routing
  2. Default → PM Agent → Auto-delegation
  3. Delegation based on keywords, file types, complexity, context

User Experience:
- Default: PM Agent handles everything (seamless)
- Override: @agent-[name] for direct specialist access
- Transparent: PM Agent reports delegation decisions

This establishes PM Agent as the orchestration layer while
respecting existing auto-activation patterns and manual overrides.

Next Steps:
- Local testing in agiletec project
- Iteration based on actual behavior
- Documentation updates as needed

* refactor(pm-agent): redesign as self-improvement meta-layer

Problem Resolution:
PM Agent's initial design competed with existing auto-activation for task routing,
creating confusion about orchestration responsibilities and adding unnecessary complexity.

Design Change:
Redefined PM Agent as a meta-layer agent that operates AFTER specialist agents
complete tasks, focusing on:
- Post-implementation documentation and pattern recording
- Immediate mistake analysis with prevention checklists
- Monthly documentation maintenance and noise reduction
- Pattern extraction and knowledge synthesis

Two-Layer Orchestration System:
1. Task Execution Layer: Existing auto-activation handles task routing (unchanged)
2. Self-Improvement Layer: PM Agent meta-layer handles documentation (new)

Files Modified:
- SuperClaude/Agents/pm-agent.md: Complete rewrite with meta-layer design
  - Category: orchestration → meta
  - Triggers: All user interactions → Post-implementation, mistakes, monthly
  - Behavioral Mindset: Continuous learning system
  - Self-Improvement Workflow: BEFORE/DURING/AFTER/MISTAKE RECOVERY/MAINTENANCE

- SuperClaude/Core/RULES.md: Agent Orchestration section updated
  - Split into Task Execution Layer + Self-Improvement Layer
  - Added orchestration flow diagram
  - Clarified PM Agent activates AFTER task completion

- README.md: Updated PM Agent description
  - "orchestrates all interactions" → "ensures continuous learning"

- Docs/User-Guide/agents.md: PM Agent section rewritten
  - Section: Orchestration Agent → Meta-Layer Agent
  - Expertise: Project orchestration → Self-improvement workflow executor
  - Examples: Task coordination → Post-implementation documentation

- PR_DOCUMENTATION.md: Comprehensive PR documentation added
  - Summary, motivation, changes, testing, breaking changes
  - Two-layer orchestration system diagram
  - Verification checklist

Integration Validated:
Tested with agiletec project's self-improvement-workflow.md:
✅ PM Agent aligns with existing BEFORE/DURING/AFTER/MISTAKE RECOVERY phases
✅ Complements (not competes with) existing workflow
✅ agiletec workflow defines WHAT, PM Agent defines WHO executes it

Breaking Changes: None
- Existing auto-activation continues unchanged
- Specialist agents unaffected
- User workflows remain the same
- New capability: Automatic documentation and knowledge maintenance

Value Proposition:
Transforms SuperClaude into a continuously learning system that accumulates
knowledge, prevents recurring mistakes, and maintains fresh documentation
without manual intervention.

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

Co-Authored-By: Claude <noreply@anthropic.com>

* docs: add Claude Code conversation history management research

Research covering .jsonl file structure, performance impact, and retention policies.

Content:
- Claude Code .jsonl file format and message types
- Performance issues from GitHub (memory leaks, conversation compaction)
- Retention policies (consumer vs enterprise)
- Rotation recommendations based on actual data
- File history snapshot tracking mechanics

Source: Moved from agiletec project (research applicable to all Claude Code projects)

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

Co-Authored-By: Claude <noreply@anthropic.com>

* feat: add Development documentation structure

Phase 1: Documentation Structure complete

- Add Docs/Development/ directory for development documentation
- Add ARCHITECTURE.md - System architecture with PM Agent meta-layer
- Add ROADMAP.md - 5-phase development plan with checkboxes
- Add TASKS.md - Daily task tracking with progress indicators
- Add PROJECT_STATUS.md - Current status dashboard and metrics
- Add pm-agent-integration.md - Implementation guide for PM Agent mode

This establishes comprehensive documentation foundation for:
- System architecture understanding
- Development planning and tracking
- Implementation guidance
- Progress visibility

Related: #pm-agent-mode #documentation #phase-1

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

Co-Authored-By: Claude <noreply@anthropic.com>

* feat: PM Agent session lifecycle and PDCA implementation

Phase 2: PM Agent Mode Integration (Design Phase)

Commands/pm.md updates:
- Add "Always-Active Foundation Layer" concept
- Add Session Lifecycle (Session Start/During Work/Session End)
- Add PDCA Cycle (Plan/Do/Check/Act) automation
- Add Serena MCP Memory Integration (list/read/write_memory)
- Document auto-activation triggers

Agents/pm-agent.md updates:
- Add Session Start Protocol (MANDATORY auto-activation)
- Add During Work PDCA Cycle with example workflows
- Add Session End Protocol with state preservation
- Add PDCA Self-Evaluation Pattern
- Add Documentation Strategy (temp → patterns/mistakes)
- Add Memory Operations Reference

Key Features:
- Session start auto-activation for context restoration
- 30-minute checkpoint saves during work
- Self-evaluation with think_about_* operations
- Systematic documentation lifecycle
- Knowledge evolution to CLAUDE.md

Implementation Status:
- ✅ Design complete (Commands/pm.md, Agents/pm-agent.md)
- ⏳ Implementation pending (Core components)
- ⏳ Serena MCP integration pending

Salvaged from mistaken development in ~/.claude directory

Related: #pm-agent-mode #session-lifecycle #pdca-cycle #phase-2

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

Co-Authored-By: Claude <noreply@anthropic.com>

* fix: disable Serena MCP auto-browser launch

Disable web dashboard and GUI log window auto-launch in Serena MCP server
to prevent intrusive browser popups on startup. Users can still manually
access the dashboard at http://localhost:24282/dashboard/ if needed.

Changes:
- Add CLI flags to Serena run command:
  - --enable-web-dashboard false
  - --enable-gui-log-window false
- Ensures Git-tracked configuration (no reliance on ~/.serena/serena_config.yml)
- Aligns with AIRIS MCP Gateway integration approach

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

Co-Authored-By: Claude <noreply@anthropic.com>

* refactor: rename directories to lowercase for PEP8 compliance

- Rename superclaude/Agents -> superclaude/agents
- Rename superclaude/Commands -> superclaude/commands
- Rename superclaude/Core -> superclaude/core
- Rename superclaude/Examples -> superclaude/examples
- Rename superclaude/MCP -> superclaude/mcp
- Rename superclaude/Modes -> superclaude/modes

This change follows Python PEP8 naming conventions for package directories.

* style: fix PEP8 violations and update package name to lowercase

Changes:
- Format all Python files with black (43 files reformatted)
- Update package name from 'SuperClaude' to 'superclaude' in pyproject.toml
- Fix import statements to use lowercase package name
- Add missing imports (timedelta, __version__)
- Remove old SuperClaude.egg-info directory

PEP8 violations reduced from 2672 to 701 (mostly E501 line length due to black's 88 char vs flake8's 79 char limit).

* docs: add PM Agent development documentation

Add comprehensive PM Agent development documentation:
- PM Agent ideal workflow (7-phase autonomous cycle)
- Project structure understanding (Git vs installed environment)
- Installation flow understanding (CommandsComponent behavior)
- Task management system (current-tasks.md)

Purpose: Eliminate repeated explanations and enable autonomous PDCA cycles

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

Co-Authored-By: Claude <noreply@anthropic.com>

* feat(pm-agent): add self-correcting execution and warning investigation culture

## Changes

### superclaude/commands/pm.md
- Add "Self-Correcting Execution" section with root cause analysis protocol
- Add "Warning/Error Investigation Culture" section enforcing zero-tolerance for dismissal
- Define error detection protocol: STOP → Investigate → Hypothesis → Different Solution → Execute
- Document anti-patterns (retry without understanding) and correct patterns (research-first)

### docs/Development/hypothesis-pm-autonomous-enhancement-2025-10-14.md
- Add PDCA workflow hypothesis document for PM Agent autonomous enhancement

## Rationale

PM Agent must never retry failed operations without understanding root causes.
All warnings and errors require investigation via context7/WebFetch/documentation
to ensure production-quality code and prevent technical debt accumulation.

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

Co-Authored-By: Claude <noreply@anthropic.com>

* feat(installer): add airis-mcp-gateway MCP server option

## Changes

- Add airis-mcp-gateway to MCP server options in installer
- Configuration: GitHub-based installation via uvx
- Repository: https://github.com/oraios/airis-mcp-gateway
- Purpose: Dynamic MCP Gateway for zero-token baseline and on-demand tool loading

## Implementation

Added to setup/components/mcp.py self.mcp_servers dictionary with:
- install_method: github
- install_command: uvx test installation
- run_command: uvx runtime execution
- required: False (optional server)

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

Co-Authored-By: Claude <noreply@anthropic.com>

---------

Co-authored-by: kazuki <kazuki@kazukinoMacBook-Air.local>
Co-authored-by: Claude <noreply@anthropic.com>
2025-10-14 08:47:09 +05:30

249 lines
11 KiB
Markdown
Raw Blame History

# SuperClaude Framework Reference Documentation
**Navigation Hub**: Structured learning paths and technical references for all skill levels.
**Documentation Status**: ✅ **Status: Current** - All content verified for accuracy and completeness.
## How to Use This Reference Library
This documentation is organized for **progressive learning** with multiple entry points:
- **📱 Quick Reference**: Jump to specific solutions for immediate needs
- **📚 Learning Paths**: Structured progression from beginner to expert
- **🔍 Problem-Solving**: Targeted troubleshooting and diagnostic guidance
- **⚡ Performance**: Optimization patterns and advanced techniques
**Verification Standards**: All examples tested, commands validated, patterns proven in real-world usage.
---
## Documentation Navigation Matrix
| Document | Purpose | Target Audience | Complexity | |
|----------|---------|-----------------|------------|-----------------|
| **[basic-examples.md](./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** | |
| **[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** | |
---
## Recommended Learning Paths
### New Users (Week 1 Foundation)
**Goal**: Establish confident SuperClaude usage with essential workflows
```
Day 1-2: ../Getting-Started/quick-start.md
↓ Foundation building and first commands
Day 3-4: basic-examples.md
↓ Practical application and pattern recognition
Day 5-7: common-issues.md
↓ Problem resolution and confidence building
```
**Success Metrics**: Can execute basic commands, manage sessions, resolve common issues independently.
### Intermediate Users (Week 2-3 Enhancement)
**Goal**: Master coordination patterns and technical depth
```
Week 2: advanced-patterns.md
↓ Multi-agent coordination and orchestration mastery
Week 3: mcp-server-guide.md + advanced-workflows.md
↓ Performance excellence and technical configuration
```
**Success Metrics**: Can orchestrate complex workflows, optimize performance, configure MCP servers.
### Expert Users (Advanced Mastery)
**Goal**: Complete framework mastery and complex system integration
```
Phase 1: advanced-workflows.md
↓ Complex orchestration and enterprise patterns
Phase 2: integration-patterns.md
↓ Framework integration and architectural mastery
Phase 3: diagnostic-reference.md
↓ Advanced debugging and system analysis
```
**Success Metrics**: Can design custom workflows, integrate with any framework, diagnose complex issues.
### Problem-Solving Path (As Needed)
**Goal**: Immediate issue resolution and diagnostic guidance
```
Quick Issues: common-issues.md
↓ Common problems and immediate solutions
Complex Debugging: troubleshooting.md
↓ Comprehensive diagnostic approach
Advanced Analysis: diagnostic-reference.md
↓ Expert-level debugging and analysis
```
---
## Command Quick Reference
### Essential SuperClaude Commands
| Command Pattern | Purpose | Example |
|----------------|---------|---------|
| `/sc:load` | Restore session context | `/sc:load project_name` |
| `/sc:save` | Preserve session state | `/sc:save "milestone checkpoint"` |
| `--think` | Enable structured analysis | `--think analyze performance bottlenecks` |
| `--brainstorm` | Collaborative requirement discovery | `--brainstorm new authentication system` |
| `--task-manage` | Multi-step operation orchestration | `--task-manage refactor user module` |
### Performance & Efficiency Flags
| Flag | Purpose | Best For |
|------|---------|----------|
| `--uc` / `--ultracompressed` | Token-efficient communication | Large operations, context pressure |
| `--orchestrate` | Optimize tool selection | Multi-tool operations, performance needs |
| `--loop` | Iterative improvement cycles | Code refinement, quality enhancement |
| `--validate` | Pre-execution risk assessment | Production environments, critical operations |
### MCP Server Activation
| Flag | Server | Best For |
|------|---------|----------|
| `--c7` / `--context7` | Context7 | Official documentation, framework patterns |
| `--seq` / `--sequential` | Sequential | Complex analysis, debugging, system design |
| `--magic` | Magic | UI components, design systems, frontend work |
| `--morph` / `--morphllm` | Morphllm | Bulk transformations, pattern-based edits |
| `--serena` | Serena | Symbol operations, project memory, large codebases |
| `--play` / `--playwright` | Playwright | Browser testing, E2E scenarios, visual validation |
---
## Framework Integration Quick Start
### React/Next.js Projects
```bash
# Initialize with React patterns
--c7 --magic "implement Next.js authentication with TypeScript"
# Component development workflow
--magic --think "create responsive dashboard component"
```
### Node.js/Express Backend
```bash
# API development with best practices
--c7 --seq "design RESTful API with Express and MongoDB"
# Performance optimization
--think --orchestrate "optimize database queries and caching"
```
### Full-Stack Development
```bash
# Complete application workflow
--task-manage --all-mcp "build full-stack e-commerce platform"
# Integration testing
--play --seq "implement end-to-end testing strategy"
```
---
## Problem-Solving Quick Reference
### Immediate Issues
- **Command not working**: Check [common-issues.md](./common-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
- **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
- **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 [advanced-patterns.md](./advanced-patterns.md) → Custom Orchestration
---
## Documentation Health & Verification
### Quality Assurance
- ✅ **Commands Tested**: All examples tested and functional
- ✅ **Patterns Proven**: Real-world usage validation in production environments
- ✅ **Cross-References**: Internal links verified and maintained
- ✅ **Regular Updates**: Documentation synchronized with framework evolution
### Accuracy Standards
- **Command Syntax**: Verified against latest SuperClaude implementation
- **Flag Behavior**: Tested in multiple scenarios and environments
- **MCP Integration**: Confirmed compatibility with current MCP server versions
- **Performance Claims**: Benchmarked and measured in realistic conditions
### Reporting Issues
Found outdated information or broken examples?
1. **Quick Fixes**: Check [common-issues.md](./common-issues.md) first
2. **Documentation Bugs**: Report via project issues with specific file and line
3. **Missing Patterns**: Suggest additions with use case description
4. **Verification Requests**: Request re-testing of specific examples
---
## Expert Tips for Maximum Productivity
### Daily Workflow Optimization
1. **Session Management**: Always start with `/sc:load`, end with `/sc:save`
2. **Flag Combinations**: Combine complementary flags: `--think --c7` for documented analysis
3. **Progressive Complexity**: Start simple, add sophistication incrementally
4. **Tool Specialization**: Match tools to tasks: Magic for UI, Sequential for analysis
### Learning Acceleration
1. **Follow the Paths**: Use recommended learning sequences for structured growth
2. **Practice Patterns**: Repeat common workflows until they become intuitive
3. **Experiment Safely**: Use feature branches and checkpoints for exploration
4. **Community Learning**: Share discoveries and learn from others' approaches
### Troubleshooting Mastery
1. **Systematic Approach**: Always start with [common-issues.md](./common-issues.md)
2. **Evidence Gathering**: Use `--think` for complex problem analysis
3. **Root Cause Focus**: Address underlying issues, not just symptoms
4. **Documentation First**: Check official docs before experimental solutions
---
## Advanced Resources & Integration
### Framework-Specific Guides
- **React/Next.js**: See [integration-patterns.md](./integration-patterns.md) → React Integration
- **Vue/Nuxt**: See [integration-patterns.md](./integration-patterns.md) → Vue Ecosystem
- **Node.js/Express**: See [integration-patterns.md](./integration-patterns.md) → Backend Patterns
- **Python/Django**: See [integration-patterns.md](./integration-patterns.md) → Python Workflows
### Specialized Workflows
- **DevOps Integration**: [advanced-workflows.md](./advanced-workflows.md) → CI/CD Patterns
- **Testing Strategies**: [advanced-patterns.md](./advanced-patterns.md) → Testing Orchestration
- **Performance Engineering**: [Advanced Patterns](./advanced-patterns.md) → Complex Coordination
- **Security Implementation**: [integration-patterns.md](./integration-patterns.md) → Security Patterns
### Community & Support
- **Best Practices**: Continuously updated based on community feedback
- **Pattern Library**: Growing collection of proven workflow patterns
- **Expert Network**: Connect with experienced SuperClaude practitioners
- **Regular Updates**: Documentation evolves with framework capabilities
---
**Start Your Journey**: New to SuperClaude? Begin with [Quick Start Guide](../Getting-Started/quick-start.md) for immediate productivity gains.
**Need Answers Now**: Jump to [basic-examples.md](./basic-examples.md) for copy-paste solutions.
**Ready for Advanced**: Explore [advanced-patterns.md](./advanced-patterns.md) for expert-level orchestration.
Reference in New Issue View Git Blame Copy Permalink