## π― **Overview**
SuperClaude is a **meta-programming configuration framework** that transforms Claude Code into a structured development platform through behavioral instruction injection and component orchestration. It provides systematic workflow automation with powerful tools and intelligent agents.
## Disclaimer
This project is not affiliated with or endorsed by Anthropic.
Claude Code is a product built and maintained by [Anthropic](https://www.anthropic.com/).
## π **For Developers & Contributors**
**Essential documentation for working with SuperClaude Framework:**
| Document | Purpose | When to Read |
|----------|---------|--------------|
| **[PLANNING.md](PLANNING.md)** | Architecture, design principles, absolute rules | Session start, before implementation |
| **[TASK.md](TASK.md)** | Current tasks, priorities, backlog | Daily, before starting work |
| **[KNOWLEDGE.md](KNOWLEDGE.md)** | Accumulated insights, best practices, troubleshooting | When encountering issues, learning patterns |
| **[CONTRIBUTING.md](CONTRIBUTING.md)** | Contribution guidelines, workflow | Before submitting PRs |
> **π‘ Pro Tip**: Claude Code reads these files at session start to ensure consistent, high-quality development aligned with project standards.
## β‘ **Quick Installation**
### **One-Command Plugin Installation**
SuperClaude v2.0+ uses **TypeScript plugins** with automated installer:
```bash
# Clone repository
git clone https://github.com/SuperClaude-Org/SuperClaude_Framework.git
cd SuperClaude_Framework
# Install plugin (one command)
make install-plugin
```
**That's it!** Restart Claude Code and the plugin auto-activates.
**Plugin Management Commands**:
```bash
make install-plugin # Install plugin to ~/.claude/plugins/
make uninstall-plugin # Remove plugin
make reinstall-plugin # Update existing installation
```
**Key Features**:
- β **One-Command Install**: No manual configuration needed
- β **Hot Reload**: Edit TypeScript β Save β Instant reflection (no restart)
- β **Auto-Activation**: PM Agent starts automatically on session start
- β **Zero Configuration**: Works out of the box after `make install-plugin`
### **Enhanced Performance (Optional MCPs)**
For **2-3x faster** execution and **30-50% fewer tokens**, optionally install MCP servers:
```bash
# Recommended MCP servers (via airis-mcp-gateway):
# - Mindbase: Cross-session memory (automatic)
# - Serena: Session persistence (2-3x faster)
# - Sequential: Token-efficient reasoning (30-50% fewer tokens)
# - Tavily: Web search for Deep Research
# - Context7: Official documentation lookup
# Install via: https://github.com/airis-mcp-gateway
```
**Performance Comparison:**
- **Without MCPs**: Fully functional, standard performance β
- **With MCPs**: 2-3x faster, 30-50% fewer tokens β‘
β οΈ IMPORTANT: Upgrading from SuperClaude V1.x (Slash Commands)
**V2.0 introduces breaking changes - migration from slash commands to TypeScript plugins:**
```bash
# 1. Remove old slash commands (if installed)
rm -rf ~/.claude/commands/sc/
# 2. Install new plugin (one command)
cd SuperClaude_Framework
make install-plugin
```
**What's New in V2.0:**
- β TypeScript plugins (hot reload support)
- β One-command installation (no manual config)
- β Auto-activation via SessionStart hook
- β 3 core plugins: PM Agent, Research, Index
- β Confidence-driven workflow (β₯90% threshold, Precision/Recall 1.0)
**Migration Notes:**
- Old: `/sc:pm`, `/sc:research`, `/sc:index-repo` (27 commands)
- New: `/pm`, `/research`, `/index-repo` (3 plugin commands)
- Functionality improved with hot reload and auto-activation
- Installation: Manual file copying β `make install-plugin`
π‘ Installation Troubleshooting
**Plugin installation failed?**
```bash
# Check if Claude Code is installed
which claude
# Verify plugin directory exists
ls ~/.claude/plugins/
# Reinstall plugin
make reinstall-plugin
# Check installation
ls ~/.claude/plugins/pm-agent/
```
**Plugin not loading?**
- Restart Claude Code completely
- Run `/plugin` in Claude Code to verify installation
- Check that `.claude-plugin/plugin.json` exists in repository
**Development mode (for contributors):**
```bash
# Install Python package for testing
make dev
make verify
uv run pytest
```
---
## π **Support the Project**
> Hey, let's be real - maintaining SuperClaude takes time and resources.
>
> *The Claude Max subscription alone runs $100/month for testing, and that's before counting the hours spent on documentation, bug fixes, and feature development.*
> *If you're finding value in SuperClaude for your daily work, consider supporting the project.*
> *Even a few dollars helps cover the basics and keeps development active.*
>
> Every contributor matters, whether through code, feedback, or support. Thanks for being part of this community! π
### **Your Support Enables:**
| Item | Cost/Impact |
|------|-------------|
| π¬ **Claude Max Testing** | $100/month for validation & testing |
| β‘ **Feature Development** | New capabilities & improvements |
| π **Documentation** | Comprehensive guides & examples |
| π€ **Community Support** | Quick issue responses & help |
| π§ **MCP Integration** | Testing new server connections |
| π **Infrastructure** | Hosting & deployment costs |
> **Note:** No pressure though - the framework stays open source regardless. Just knowing people use and appreciate it is motivating. Contributing code, documentation, or spreading the word helps too! π
---
## π **What's New in V2.0**
> *Version 2.0 brings architectural transformation: migration from 27 slash commands to 3 TypeScript plugins with hot reload and auto-activation.*
### π€ **Smarter Agent System**
**16 specialized agents** with domain expertise:
- PM Agent ensures continuous learning through systematic documentation
- Deep Research agent for autonomous web research
- Security engineer catches real vulnerabilities
- Frontend architect understands UI patterns
- Automatic coordination based on context
- Domain-specific expertise on demand
### π₯ **TypeScript Plugins**
**3 core plugins** with hot reload:
- **PM Agent**: Confidence-driven orchestration (β₯90% threshold)
- **Research**: Deep web search with adaptive planning
- **Index**: 94% token reduction (58K β 3K)
- Auto-activation via SessionStart hook
- Edit β Save β Instant reflection (no restart)
### β‘ **Optimized Performance**
**Smaller framework, bigger projects:**
- Reduced framework footprint
- More context for your code
- Longer conversations possible
- Complex operations enabled
### π **Documentation Overhaul**
**Complete rewrite** for developers:
- Real examples & use cases
- Common pitfalls documented
- Practical workflows included
- Better navigation structure
---
## π¬ **Deep Research Capabilities**
### **Autonomous Web Research Aligned with DR Agent Architecture**
SuperClaude v4.2 introduces comprehensive Deep Research capabilities, enabling autonomous, adaptive, and intelligent web research.
### π― **Adaptive Planning**
**Three intelligent strategies:**
- **Planning-Only**: Direct execution for clear queries
- **Intent-Planning**: Clarification for ambiguous requests
- **Unified**: Collaborative plan refinement (default)