mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-17 17:56:46 +00:00
🚀 Merge SuperClaude V4 to Master - Complete Framework Overhaul (#289)
* ✨ Enhance documentation with advanced markdown formatting Major improvements to documentation presentation and usability: README.md: - Added centered hero section with framework statistics dashboard - Created visual support section with donation cards - Enhanced What's New section with feature grid layout - Reorganized documentation links into categorized table - Added professional badges and visual separators installation.md: - Centered title with platform badges and quick navigation - Consolidated 4 installation methods into unified table - Created visual requirement cards (Required vs Optional) - Added collapsible troubleshooting sections - Removed 3 duplicate "What's Next" sections - Enhanced learning journey with progression tables quick-start.md: - Added visual framework architecture flow diagram - Created component statistics dashboard (21|14|6|6) - Built comparison table for SuperClaude vs Standard Claude - Added 4-week learning timeline with milestones - Enhanced workflow patterns with step-by-step tables - Created key insights cards explaining framework philosophy All documents now feature consistent styling with centered titles, organized tables, emojis for visual scanning, and improved navigation. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * 🔥 Remove outdated publishing and release instruction files Cleaned up repository by removing: - PUBLISHING.md: Outdated publishing guidelines - RELEASE_INSTRUCTIONS.md: Old release process documentation These files are no longer needed as the project has evolved and the processes have been streamlined or moved elsewhere. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> --------- Signed-off-by: NomenAK <39598727+NomenAK@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
NomenAK
GitHub
parent
f1b01644be
commit
3c819e1162
@ -1,232 +1,514 @@
|
||||
# SuperClaude Installation Guide 📦
|
||||
<div align="center">
|
||||
|
||||
SuperClaude installs behavioral context files that Claude Code reads to enhance its capabilities with 21 commands, 14 agents, and 5 modes.
|
||||
# 📦 SuperClaude Installation Guide
|
||||
|
||||
## Quick Start 🚀
|
||||
### **Transform Claude Code with 21 Commands, 14 Agents & 6 MCP Servers**
|
||||
|
||||
<p align="center">
|
||||
<img src="https://img.shields.io/badge/version-4.0.4-blue?style=for-the-badge" alt="Version">
|
||||
<img src="https://img.shields.io/badge/Python-3.8+-green?style=for-the-badge" alt="Python">
|
||||
<img src="https://img.shields.io/badge/Platform-Linux%20|%20macOS%20|%20Windows-orange?style=for-the-badge" alt="Platform">
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="#-quick-installation">Quick Install</a> •
|
||||
<a href="#-requirements">Requirements</a> •
|
||||
<a href="#-installation-methods">Methods</a> •
|
||||
<a href="#-verification">Verify</a> •
|
||||
<a href="#-troubleshooting">Troubleshoot</a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## ⚡ **Quick Installation**
|
||||
|
||||
<div align="center">
|
||||
|
||||
### **Choose Your Preferred Method**
|
||||
|
||||
| Method | Command | Platform | Best For |
|
||||
|:------:|---------|:--------:|----------|
|
||||
| **🐍 pipx** | `pipx install SuperClaude && SuperClaude install` | Linux/macOS | **✅ Recommended** - Isolated environment |
|
||||
| **📦 pip** | `pip install SuperClaude && SuperClaude install` | All | Traditional Python setups |
|
||||
| **🌐 npm** | `npm install -g @bifrost_inc/superclaude && superclaude install` | All | Node.js developers |
|
||||
| **🔧 Dev** | `git clone ... && pip install -e ".[dev]"` | All | Contributors & developers |
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## 📋 **Requirements**
|
||||
|
||||
<div align="center">
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" width="50%">
|
||||
|
||||
### ✅ **Required**
|
||||
|
||||
| Component | Version | Check Command |
|
||||
|-----------|---------|---------------|
|
||||
| **Python** | 3.8+ | `python3 --version` |
|
||||
| **pip** | Latest | `pip --version` |
|
||||
| **Claude Code** | Latest | `claude --version` |
|
||||
| **Disk Space** | 50MB | `df -h` |
|
||||
|
||||
</td>
|
||||
<td align="center" width="50%">
|
||||
|
||||
### 💡 **Optional**
|
||||
|
||||
| Component | Purpose | Check Command |
|
||||
|-----------|---------|---------------|
|
||||
| **Node.js** | MCP Servers | `node --version` |
|
||||
| **Git** | Version Control | `git --version` |
|
||||
| **pipx** | Isolated Install | `pipx --version` |
|
||||
| **RAM** | Performance | 1GB recommended |
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
<details>
|
||||
<summary><b>🔍 Quick System Check</b></summary>
|
||||
|
||||
**pipx (Recommended for Linux/macOS):**
|
||||
```bash
|
||||
# Run this to check all requirements at once
|
||||
python3 --version && echo "✅ Python OK" || echo "❌ Python missing"
|
||||
claude --version && echo "✅ Claude Code OK" || echo "❌ Claude Code missing"
|
||||
node --version 2>/dev/null && echo "✅ Node.js OK (optional)" || echo "⚠️ Node.js missing (optional)"
|
||||
git --version 2>/dev/null && echo "✅ Git OK (optional)" || echo "⚠️ Git missing (optional)"
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
## 🚀 **Installation Methods**
|
||||
|
||||
<div align="center">
|
||||
|
||||
### **Detailed Installation Instructions**
|
||||
|
||||
</div>
|
||||
|
||||
### **Method 1: pipx (Recommended)**
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="60%">
|
||||
|
||||
```bash
|
||||
# Install pipx if not present
|
||||
python3 -m pip install --user pipx
|
||||
python3 -m pipx ensurepath
|
||||
|
||||
# Install SuperClaude
|
||||
pipx install SuperClaude
|
||||
|
||||
# Run the installer
|
||||
SuperClaude install
|
||||
```
|
||||
|
||||
**pip (Traditional):**
|
||||
</td>
|
||||
<td width="40%">
|
||||
|
||||
**✅ Advantages:**
|
||||
- Isolated environment
|
||||
- No dependency conflicts
|
||||
- Clean uninstall
|
||||
- Automatic PATH setup
|
||||
|
||||
**📍 Best for:**
|
||||
- Linux/macOS users
|
||||
- Clean system installs
|
||||
- Multiple Python projects
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
### **Method 2: pip (Traditional)**
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="60%">
|
||||
|
||||
```bash
|
||||
# Standard installation
|
||||
pip install SuperClaude
|
||||
|
||||
# Or user installation
|
||||
pip install --user SuperClaude
|
||||
|
||||
# Run the installer
|
||||
SuperClaude install
|
||||
```
|
||||
|
||||
**NPM (Cross-platform):**
|
||||
</td>
|
||||
<td width="40%">
|
||||
|
||||
**✅ Advantages:**
|
||||
- Works everywhere
|
||||
- Familiar to Python users
|
||||
- Direct installation
|
||||
|
||||
**📍 Best for:**
|
||||
- Windows users
|
||||
- Virtual environments
|
||||
- Quick setup
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
### **Method 3: npm (Cross-platform)**
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="60%">
|
||||
|
||||
```bash
|
||||
# Global installation
|
||||
npm install -g @bifrost_inc/superclaude
|
||||
SuperClaude install
|
||||
|
||||
# Run the installer
|
||||
superclaude install
|
||||
```
|
||||
|
||||
**Development:**
|
||||
</td>
|
||||
<td width="40%">
|
||||
|
||||
**✅ Advantages:**
|
||||
- Cross-platform
|
||||
- NPM ecosystem
|
||||
- JavaScript familiar
|
||||
|
||||
**📍 Best for:**
|
||||
- Node.js developers
|
||||
- NPM users
|
||||
- Cross-platform needs
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
### **Method 4: Development Installation**
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="60%">
|
||||
|
||||
```bash
|
||||
# Clone repository
|
||||
git clone https://github.com/SuperClaude-Org/SuperClaude_Framework.git
|
||||
cd SuperClaude_Framework
|
||||
|
||||
# Install in development mode
|
||||
pip install -e ".[dev]"
|
||||
|
||||
# Test installation
|
||||
SuperClaude install --dry-run
|
||||
```
|
||||
|
||||
**If you encounter PEP 668 errors:**
|
||||
</td>
|
||||
<td width="40%">
|
||||
|
||||
**✅ Advantages:**
|
||||
- Latest features
|
||||
- Contribute to project
|
||||
- Full source access
|
||||
|
||||
**📍 Best for:**
|
||||
- Contributors
|
||||
- Custom modifications
|
||||
- Testing new features
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
---
|
||||
|
||||
## 🎛️ **Installation Options**
|
||||
|
||||
<div align="center">
|
||||
|
||||
### **Customize Your Installation**
|
||||
|
||||
| Option | Command | Description |
|
||||
|--------|---------|-------------|
|
||||
| **Interactive** | `SuperClaude install` | Guided setup with prompts |
|
||||
| **Specific Components** | `SuperClaude install --components core mcp modes` | Install only what you need |
|
||||
| **Preview Mode** | `SuperClaude install --dry-run` | See what will be installed |
|
||||
| **Force Install** | `SuperClaude install --force --yes` | Skip all confirmations |
|
||||
| **List Components** | `SuperClaude install --list-components` | View available components |
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## ✅ **Verification**
|
||||
|
||||
<div align="center">
|
||||
|
||||
### **Confirm Successful Installation**
|
||||
|
||||
</div>
|
||||
|
||||
### **Step 1: Check Installation**
|
||||
|
||||
```bash
|
||||
# Option 1: Use pipx (recommended)
|
||||
pipx install SuperClaude
|
||||
# Verify SuperClaude version
|
||||
python3 -m SuperClaude --version
|
||||
# Expected: SuperClaude 4.0.4
|
||||
|
||||
# Option 2: Use pip with --user flag
|
||||
pip install --user SuperClaude
|
||||
|
||||
# Option 3: Force installation (use with caution)
|
||||
pip install --break-system-packages SuperClaude
|
||||
```
|
||||
|
||||
## Command Types
|
||||
|
||||
| Type | Where Used | Format | Example |
|
||||
|------|------------|--------|----------|
|
||||
| **Installation** | Terminal | `SuperClaude [command]` | `SuperClaude install` |
|
||||
| **Slash Commands** | Claude Code | `/sc:[command]` | `/sc:brainstorm "idea"` |
|
||||
| **Agents** | Claude Code | `@agent-[type]` | `@agent-security "review"` |
|
||||
|
||||
## Requirements
|
||||
|
||||
**Required:**
|
||||
- Python 3.8+ with pip
|
||||
- Claude Code installed and working
|
||||
- 50MB free space
|
||||
|
||||
**Optional:**
|
||||
- Node.js 16+ (for MCP servers)
|
||||
- Git (for version control integration)
|
||||
|
||||
## Quick Check
|
||||
```bash
|
||||
python3 --version # Should be 3.8+
|
||||
claude --version # Verify Claude Code
|
||||
node --version # Optional: for MCP servers
|
||||
```
|
||||
|
||||
## Installation Options 🎛️
|
||||
|
||||
**Interactive Installation (Default):**
|
||||
```bash
|
||||
SuperClaude install
|
||||
```
|
||||
|
||||
**With Options:**
|
||||
```bash
|
||||
SuperClaude install --components core mcp modes # Specific components
|
||||
SuperClaude install --dry-run # Preview only
|
||||
SuperClaude install --force --yes # Skip confirmations
|
||||
```
|
||||
|
||||
### Getting SuperClaude 📥
|
||||
|
||||
**Choose Your Preferred Method:**
|
||||
|
||||
**Python Users:**
|
||||
```bash
|
||||
pip install SuperClaude
|
||||
```
|
||||
|
||||
**JavaScript/Node.js Users:**
|
||||
```bash
|
||||
npm install -g @bifrost_inc/superclaude
|
||||
```
|
||||
|
||||
**Development/Contributors:**
|
||||
```bash
|
||||
git clone https://github.com/SuperClaude-Org/SuperClaude_Framework.git
|
||||
cd SuperClaude_Framework
|
||||
pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
### Running the Installer 🎬
|
||||
|
||||
**Interactive Installation (Default):**
|
||||
```bash
|
||||
SuperClaude install
|
||||
```
|
||||
The installer will:
|
||||
1. Validate system requirements
|
||||
2. Show available components
|
||||
3. Install selected components to `~/.claude/`
|
||||
4. Configure MCP servers if selected
|
||||
5. Update CLAUDE.md with framework imports
|
||||
|
||||
## After Installation ✅
|
||||
|
||||
**Verify Installation:**
|
||||
```bash
|
||||
python3 -m SuperClaude --version # Should show 4.0.4
|
||||
# List installed components
|
||||
SuperClaude install --list-components
|
||||
# Expected: List of available components
|
||||
```
|
||||
|
||||
**Test Commands:**
|
||||
### **Step 2: Test in Claude Code**
|
||||
|
||||
```bash
|
||||
# In Claude Code, try:
|
||||
/sc:brainstorm "test project" # Should ask discovery questions
|
||||
/sc:analyze README.md # Should provide analysis
|
||||
# Open Claude Code and try these commands:
|
||||
/sc:brainstorm "test project" # Should trigger discovery questions
|
||||
/sc:analyze README.md # Should provide structured analysis
|
||||
@agent-security "review code" # Should activate security specialist
|
||||
```
|
||||
|
||||
**What's Installed:**
|
||||
- Framework files in `~/.claude/`
|
||||
- 21 slash commands (`/sc:*`)
|
||||
- 14 agents (`@agent-*`)
|
||||
- 5 behavioral modes
|
||||
- MCP server configurations (if selected)
|
||||
### **Step 3: What's Installed**
|
||||
|
||||
## Managing Your Installation 🛠️
|
||||
<div align="center">
|
||||
|
||||
| Location | Contents | Size |
|
||||
|----------|----------|------|
|
||||
| `~/.claude/` | Framework files | ~50MB |
|
||||
| `~/.claude/CLAUDE.md` | Main entry point | ~2KB |
|
||||
| `~/.claude/*.md` | Behavioral instructions | ~200KB |
|
||||
| `~/.claude/claude-code-settings.json` | MCP configurations | ~5KB |
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ **Management**
|
||||
|
||||
<div align="center">
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>📦 Update</th>
|
||||
<th>💾 Backup</th>
|
||||
<th>🗑️ Uninstall</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
**Update:**
|
||||
```bash
|
||||
# Update to latest
|
||||
pip install --upgrade SuperClaude
|
||||
SuperClaude update
|
||||
```
|
||||
|
||||
**Backup & Restore:**
|
||||
</td>
|
||||
<td>
|
||||
|
||||
```bash
|
||||
# Create backup
|
||||
SuperClaude backup --create
|
||||
SuperClaude backup --restore ~/.claude.backup.YYYYMMDD_HHMMSS
|
||||
|
||||
# Restore backup
|
||||
SuperClaude backup --restore [file]
|
||||
```
|
||||
|
||||
**Uninstall:**
|
||||
</td>
|
||||
<td>
|
||||
|
||||
```bash
|
||||
# Remove framework
|
||||
SuperClaude uninstall
|
||||
|
||||
# Uninstall package
|
||||
pip uninstall SuperClaude
|
||||
```
|
||||
|
||||
## Troubleshooting 🔧
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
**Common Issues:**
|
||||
- **Command not found**: Verify installation with `python3 -m SuperClaude --version`
|
||||
- **Permission denied**: Use `pip install --user SuperClaude`
|
||||
- **Claude Code not found**: Install from https://claude.ai/code
|
||||
</div>
|
||||
|
||||
**Get Help:**
|
||||
- [Troubleshooting Guide](../Reference/troubleshooting.md)
|
||||
- [GitHub Issues](https://github.com/SuperClaude-Org/SuperClaude_Framework/issues)
|
||||
---
|
||||
|
||||
## Next Steps 🚀
|
||||
## 🔧 **Troubleshooting**
|
||||
|
||||
- [Quick Start Guide](quick-start.md) - First commands and workflows
|
||||
- [Commands Reference](../User-Guide/commands.md) - All 21 commands
|
||||
- [Examples Cookbook](../Reference/examples-cookbook.md) - Real-world usage
|
||||
<details>
|
||||
<summary><b>❌ PEP 668 Error (Python Package Management)</b></summary>
|
||||
|
||||
## Prerequisites Setup 🛠️
|
||||
This error occurs on systems with externally managed Python environments.
|
||||
|
||||
**Solutions (in order of preference):**
|
||||
|
||||
**Missing Python?**
|
||||
```bash
|
||||
# Linux: sudo apt install python3 python3-pip
|
||||
# macOS: brew install python3
|
||||
# Windows: Download from python.org
|
||||
# Option 1: Use pipx (Recommended)
|
||||
pipx install SuperClaude
|
||||
|
||||
# Option 2: User installation
|
||||
pip install --user SuperClaude
|
||||
|
||||
# Option 3: Virtual environment
|
||||
python3 -m venv superclaude-env
|
||||
source superclaude-env/bin/activate # Linux/macOS
|
||||
# or
|
||||
superclaude-env\Scripts\activate # Windows
|
||||
pip install SuperClaude
|
||||
|
||||
# Option 4: Force (use with caution)
|
||||
pip install --break-system-packages SuperClaude
|
||||
```
|
||||
|
||||
**Missing Claude Code?**
|
||||
- Download from https://claude.ai/code
|
||||
- Verify with: `claude --version`
|
||||
</details>
|
||||
|
||||
## What's Next? 🚀
|
||||
<details>
|
||||
<summary><b>❌ Command Not Found</b></summary>
|
||||
|
||||
1. [Quick Start Guide](quick-start.md) - Essential workflows
|
||||
2. [Commands Reference](../User-Guide/commands.md) - All 21 commands
|
||||
3. [Examples Cookbook](../Reference/examples-cookbook.md) - Real-world usage
|
||||
If `SuperClaude` command is not found after installation:
|
||||
|
||||
```bash
|
||||
# Check if package is installed
|
||||
python3 -m pip show SuperClaude
|
||||
|
||||
# Run using Python module
|
||||
python3 -m SuperClaude install
|
||||
|
||||
# Add to PATH (if using --user)
|
||||
export PATH="$HOME/.local/bin:$PATH"
|
||||
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc # Linux
|
||||
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc # macOS
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>❌ Claude Code Not Found</b></summary>
|
||||
|
||||
If Claude Code is not installed or not in PATH:
|
||||
|
||||
1. Download from [https://claude.ai/code](https://claude.ai/code)
|
||||
2. Install following platform instructions
|
||||
3. Verify with: `claude --version`
|
||||
4. Restart terminal after installation
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>❌ Permission Denied</b></summary>
|
||||
|
||||
For permission errors during installation:
|
||||
|
||||
```bash
|
||||
# Use user installation
|
||||
pip install --user SuperClaude
|
||||
|
||||
# Or use sudo (not recommended)
|
||||
sudo pip install SuperClaude
|
||||
|
||||
# Better: use pipx
|
||||
pipx install SuperClaude
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>❌ Missing Python or pip</b></summary>
|
||||
|
||||
**Linux (Ubuntu/Debian):**
|
||||
```bash
|
||||
sudo apt update
|
||||
sudo apt install python3 python3-pip python3-venv
|
||||
```
|
||||
|
||||
**macOS:**
|
||||
```bash
|
||||
# Install Homebrew first if needed
|
||||
brew install python3
|
||||
```
|
||||
|
||||
**Windows:**
|
||||
- Download from [python.org](https://python.org)
|
||||
- Check "Add Python to PATH" during installation
|
||||
- Restart terminal after installation
|
||||
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
## Final Notes 📝
|
||||
## 📚 **Next Steps**
|
||||
|
||||
**Installation Summary:**
|
||||
<div align="center">
|
||||
|
||||
- **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 5 behavioral modes
|
||||
### **Your Learning Journey**
|
||||
|
||||
**What's Next**: Your Claude Code now has enhanced capabilities. Try `/sc:brainstorm` for your first SuperClaude experience!
|
||||
<table>
|
||||
<tr>
|
||||
<th>🌱 Start Here</th>
|
||||
<th>🌿 Expand Skills</th>
|
||||
<th>🌲 Master Framework</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">
|
||||
|
||||
**First Week:**
|
||||
- [Quick Start Guide](quick-start.md)
|
||||
- [Commands Reference](../User-Guide/commands.md)
|
||||
- Try `/sc:brainstorm`
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
**Week 2-3:**
|
||||
- [Behavioral Modes](../User-Guide/modes.md)
|
||||
- [Agents Guide](../User-Guide/agents.md)
|
||||
- [Examples Cookbook](../Reference/examples-cookbook.md)
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
**Advanced:**
|
||||
- [MCP Servers](../User-Guide/mcp-servers.md)
|
||||
- [Technical Architecture](../Developer-Guide/technical-architecture.md)
|
||||
- [Contributing Code](../Developer-Guide/contributing-code.md)
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## Related Guides
|
||||
<div align="center">
|
||||
|
||||
**Documentation Roadmap:**
|
||||
### **🎉 Installation Complete!**
|
||||
|
||||
**Beginner** (🌱 Start Here)
|
||||
- [Quick Start Guide](quick-start.md) - quick setup guide
|
||||
- [Commands Reference](../User-Guide/commands.md) - Basic usage
|
||||
You now have access to:
|
||||
|
||||
**Intermediate** (🌿 Growing)
|
||||
- [Behavioral Modes](../User-Guide/modes.md) - Context optimization
|
||||
- [MCP Servers](../User-Guide/mcp-servers.md) - Enhanced capabilities
|
||||
- [Examples Cookbook](../Reference/examples-cookbook.md) - Practical patterns
|
||||
<p align="center">
|
||||
<b>21 Commands</b> • <b>14 AI Agents</b> • <b>6 Behavioral Modes</b> • <b>6 MCP Servers</b>
|
||||
</p>
|
||||
|
||||
**Advanced** (🌲 Expert)
|
||||
- [Technical Architecture](../Developer-Guide/technical-architecture.md) - System design
|
||||
- [Contributing Code](../Developer-Guide/contributing-code.md) - Development
|
||||
- [Quick Start Guide](quick-start.md) - Essential workflows
|
||||
**Ready to start?** Try `/sc:brainstorm` in Claude Code for your first SuperClaude experience!
|
||||
|
||||
---
|
||||
<p align="center">
|
||||
<a href="quick-start.md">
|
||||
<img src="https://img.shields.io/badge/📖_Continue_to-Quick_Start_Guide-blue?style=for-the-badge" alt="Quick Start">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
**Installation Complete!** You now have access to 21 commands, 14 agents, and 5 behavioral modes. Try `/sc:brainstorm` in Claude Code to get started.
|
||||
</div>
|
||||
@ -1,200 +1,492 @@
|
||||
# SuperClaude Quick Start Guide
|
||||
<div align="center">
|
||||
|
||||
> **Context Framework Guide**: SuperClaude enhances Claude Code through behavioral context injection, NOT CLI commands. `/sc:` patterns are conversation triggers that activate installed behavioral instructions.
|
||||
# 🚀 SuperClaude Quick Start Guide
|
||||
|
||||
## How SuperClaude Really Works
|
||||
### **Context Engineering Framework for Claude Code**
|
||||
|
||||
SuperClaude is a **Context Engineering Framework** that enhances Claude Code by installing behavioral `.md` files that Claude reads during conversations. When you type `/sc:brainstorm`, you're not running a command - you're triggering context patterns that guide Claude's responses.
|
||||
<p align="center">
|
||||
<img src="https://img.shields.io/badge/Framework-Context_Engineering-purple?style=for-the-badge" alt="Framework">
|
||||
<img src="https://img.shields.io/badge/Version-4.0.4-blue?style=for-the-badge" alt="Version">
|
||||
<img src="https://img.shields.io/badge/Time_to_Start-5_Minutes-green?style=for-the-badge" alt="Quick Start">
|
||||
</p>
|
||||
|
||||
**5-Minute Start**: Install context framework → Try `/sc:brainstorm` in Claude conversation → Experience enhanced behaviors.
|
||||
> **💡 Key Insight**: SuperClaude doesn't replace Claude Code - it **configures and enhances** it through behavioral context injection
|
||||
|
||||
## Just Start Here
|
||||
<p align="center">
|
||||
<a href="#-how-it-works">How It Works</a> •
|
||||
<a href="#-instant-start">Instant Start</a> •
|
||||
<a href="#-core-components">Components</a> •
|
||||
<a href="#-workflow-patterns">Workflows</a> •
|
||||
<a href="#-when-to-use">When to Use</a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 📊 **Framework Capabilities**
|
||||
|
||||
| **Commands** | **AI Agents** | **Behavioral Modes** | **MCP Servers** |
|
||||
|:------------:|:-------------:|:-------------------:|:---------------:|
|
||||
| **21** | **14** | **6** | **6** |
|
||||
| `/sc:` triggers | Domain specialists | Context adaptation | Tool integration |
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## 🎯 **How It Works**
|
||||
|
||||
<div align="center">
|
||||
|
||||
### **Framework Architecture Flow**
|
||||
|
||||
```
|
||||
┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
|
||||
│ User Input │────>│ Claude Code │────>│ Context Files │
|
||||
│ /sc:command │ │ Reads Context │ │ (.md behaviors)│
|
||||
└─────────────────┘ └──────────────────┘ └─────────────────┘
|
||||
│ │
|
||||
▼ ▼
|
||||
┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
|
||||
│ Enhanced │<─────│ Behavioral │<────│ MCP Servers │
|
||||
│ Response │ │ Activation │ │ (if configured) │
|
||||
└─────────────────┘ └──────────────────┘ └─────────────────┘
|
||||
```
|
||||
|
||||
**The Magic**: When you type `/sc:brainstorm`, Claude reads behavioral instructions from installed `.md` files and responds with enhanced capabilities
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## ⚡ **Instant Start**
|
||||
|
||||
<div align="center">
|
||||
|
||||
### **5-Minute Journey from Installation to First Command**
|
||||
|
||||
</div>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th width="50%">📦 Step 1: Install (Terminal)</th>
|
||||
<th width="50%">💬 Step 2: Use (Claude Code)</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">
|
||||
|
||||
### 🖥️ Installation - Run in Terminal
|
||||
```bash
|
||||
# Recommended for Linux/macOS
|
||||
# Quick install with pipx
|
||||
pipx install SuperClaude && SuperClaude install
|
||||
|
||||
# Traditional method
|
||||
# Or traditional pip
|
||||
pip install SuperClaude && SuperClaude install
|
||||
|
||||
# Cross-platform via NPM
|
||||
# Or via npm
|
||||
npm install -g @bifrost_inc/superclaude && superclaude install
|
||||
```
|
||||
|
||||
### 💬 First Context Triggers - Type in Claude Code Conversation
|
||||
```
|
||||
# Interactive project discovery
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
```text
|
||||
# Interactive discovery
|
||||
/sc:brainstorm "web app for task management"
|
||||
|
||||
# Analyze existing code
|
||||
/sc:analyze src/
|
||||
|
||||
# Generate implementation plan
|
||||
/sc:workflow "add user authentication"
|
||||
# Generate implementation
|
||||
/sc:implement "user authentication"
|
||||
|
||||
# Invoke specialist persona
|
||||
@agent-security "review authentication implementation"
|
||||
# Activate specialist
|
||||
@agent-security "review auth flow"
|
||||
```
|
||||
|
||||
**What Happens with Context Framework:**
|
||||
- Claude reads behavioral instructions from installed .md files
|
||||
- Specialist personas activate based on trigger patterns (security, frontend, backend)
|
||||
- MCP servers provide enhanced tool capabilities when configured
|
||||
- Behavioral modes guide conversation structure and depth
|
||||
- Session memory maintains context across interactions
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
**Key Understanding**: These are conversation patterns with Claude Code, not executable commands. The framework provides Claude with behavioral context to respond more expertly.
|
||||
<details>
|
||||
<summary><b>🎥 What Happens Behind the Scenes</b></summary>
|
||||
|
||||
1. **Context Loading**: Claude Code imports behavioral `.md` files via `CLAUDE.md`
|
||||
2. **Pattern Recognition**: Recognizes `/sc:` and `@agent-` trigger patterns
|
||||
3. **Behavioral Activation**: Applies corresponding instructions from context files
|
||||
4. **MCP Integration**: Uses configured external tools when available
|
||||
5. **Response Enhancement**: Follows framework patterns for comprehensive responses
|
||||
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
## What is SuperClaude Really?
|
||||
## 🔧 **Core Components**
|
||||
|
||||
### Framework Philosophy
|
||||
<div align="center">
|
||||
|
||||
**SuperClaude is NOT standalone software** - it's a **Context Oriented Configuration Framework** for Claude Code. Think of it as a sophisticated prompt engineering system that configures Claude Code's behavior through structured context files. Everything runs through Claude Code - SuperClaude provides the behavioral context, commands, and coordination.
|
||||
### **Four Pillars of SuperClaude**
|
||||
|
||||
### Core Components
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" width="25%">
|
||||
|
||||
SuperClaude enhances Claude Code with:
|
||||
### 📝 **Commands**
|
||||
<h2>21</h2>
|
||||
|
||||
**21 Slash Commands** for workflow automation (/sc:brainstorm, /sc:implement, /sc:analyze)
|
||||
**14 AI Specialists** with domain expertise (@agent-architect, @agent-security, @agent-frontend)
|
||||
**5 Behavioral Modes** for different contexts (brainstorming, introspection, orchestration)
|
||||
**6 MCP Servers** for enhanced capabilities (Context7, Sequential, Magic, Playwright)
|
||||
**Slash Commands**
|
||||
|
||||
**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.
|
||||
`/sc:brainstorm`
|
||||
`/sc:implement`
|
||||
`/sc:analyze`
|
||||
`/sc:workflow`
|
||||
|
||||
**Version 4.0** delivers workflow orchestration capabilities with intelligent agent coordination and session persistence.
|
||||
*Workflow automation*
|
||||
|
||||
## How It Works
|
||||
</td>
|
||||
<td align="center" width="25%">
|
||||
|
||||
**Context Framework Architecture:**
|
||||
SuperClaude installs behavioral context files that Claude Code reads during conversations. When you type trigger patterns like `/sc:implement`, Claude accesses the corresponding behavioral instructions and responds accordingly.
|
||||
### 🤖 **Agents**
|
||||
<h2>14</h2>
|
||||
|
||||
**User Experience Flow:**
|
||||
You type `/sc:implement "user login"` → Claude reads context from `implement.md` → activates security specialist behavioral patterns → uses configured MCP servers → generates implementation following framework guidelines.
|
||||
**AI Specialists**
|
||||
|
||||
**Technical Architecture:**
|
||||
1. **Context Loading** (Claude Code imports behavioral .md files via CLAUDE.md)
|
||||
2. **Pattern Recognition** (Recognizes /sc: and @agent- trigger patterns)
|
||||
3. **Behavioral Activation** (Applies corresponding behavioral instructions from context files)
|
||||
4. **MCP Integration** (Uses configured external tools when available)
|
||||
5. **Response Enhancement** (Follows framework patterns for comprehensive responses)
|
||||
`@agent-architect`
|
||||
`@agent-security`
|
||||
`@agent-frontend`
|
||||
`@agent-backend`
|
||||
|
||||
*Domain expertise*
|
||||
|
||||
</td>
|
||||
<td align="center" width="25%">
|
||||
|
||||
### 🎯 **Modes**
|
||||
<h2>6</h2>
|
||||
|
||||
**Behavioral Modes**
|
||||
|
||||
Brainstorming
|
||||
Introspection
|
||||
Orchestration
|
||||
Task Management
|
||||
|
||||
*Context adaptation*
|
||||
|
||||
</td>
|
||||
<td align="center" width="25%">
|
||||
|
||||
### 🔌 **MCP**
|
||||
<h2>6</h2>
|
||||
|
||||
**Server Integration**
|
||||
|
||||
Context7 (docs)
|
||||
Sequential (analysis)
|
||||
Magic (UI)
|
||||
Playwright (testing)
|
||||
|
||||
*Enhanced tools*
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## First Steps Workflow
|
||||
## 📚 **Workflow Patterns**
|
||||
|
||||
**First Context Session Pattern:**
|
||||
```
|
||||
# 1. Project Discovery (context trigger)
|
||||
/sc:brainstorm "e-commerce mobile app"
|
||||
<div align="center">
|
||||
|
||||
# 2. Load Context (existing projects)
|
||||
/sc:load src/
|
||||
### **Complete Development Lifecycle**
|
||||
|
||||
# 3. Analyze Current State
|
||||
/sc:analyze --focus architecture
|
||||
</div>
|
||||
|
||||
# 4. Plan Implementation
|
||||
/sc:workflow "add payment integration"
|
||||
### **🌟 First Project Session**
|
||||
|
||||
# 5. Implement Features
|
||||
/sc:implement "Stripe payment flow"
|
||||
<table>
|
||||
<tr>
|
||||
<th>Step</th>
|
||||
<th>Command</th>
|
||||
<th>What Happens</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><b>1. Discovery</b></td>
|
||||
<td><code>/sc:brainstorm "e-commerce app"</code></td>
|
||||
<td>Interactive requirements exploration</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><b>2. Load Context</b></td>
|
||||
<td><code>/sc:load src/</code></td>
|
||||
<td>Import existing project structure</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><b>3. Analysis</b></td>
|
||||
<td><code>/sc:analyze --focus architecture</code></td>
|
||||
<td>Deep architectural review</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><b>4. Planning</b></td>
|
||||
<td><code>/sc:workflow "payment integration"</code></td>
|
||||
<td>Generate implementation roadmap</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><b>5. Implementation</b></td>
|
||||
<td><code>/sc:implement "Stripe checkout"</code></td>
|
||||
<td>Build with best practices</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><b>6. Validation</b></td>
|
||||
<td><code>/sc:test --coverage</code></td>
|
||||
<td>Comprehensive testing</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><b>7. Save Session</b></td>
|
||||
<td><code>/sc:save "payment-complete"</code></td>
|
||||
<td>Persist for next session</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
# 6. Validate Quality
|
||||
/sc:test --coverage
|
||||
### **🎨 Domain-Specific Workflows**
|
||||
|
||||
# 7. Save Session
|
||||
/sc:save "payment-integration-complete"
|
||||
```
|
||||
<div align="center">
|
||||
|
||||
**Domain-Specific Workflows:**
|
||||
- **Frontend**: Magic MCP activates for UI components
|
||||
- **Backend**: Security specialist ensures proper validation
|
||||
- **DevOps**: Infrastructure specialist handles deployment
|
||||
- **Testing**: QA specialist creates comprehensive test suites
|
||||
| Domain | Trigger | Specialist Activation | MCP Server |
|
||||
|--------|---------|----------------------|------------|
|
||||
| **Frontend** | UI component request | `@agent-frontend` | Magic |
|
||||
| **Backend** | API endpoint creation | `@agent-backend` | Sequential |
|
||||
| **Security** | Auth implementation | `@agent-security` | Context7 |
|
||||
| **Testing** | E2E test scenarios | `@agent-qa` | Playwright |
|
||||
| **DevOps** | Deployment setup | `@agent-devops` | Morphllm |
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## Key Takeaways
|
||||
## 🎯 **When to Use**
|
||||
|
||||
### SuperClaude's Core Value
|
||||
<div align="center">
|
||||
|
||||
SuperClaude transforms Claude Code from a general-purpose AI assistant into a **specialized development framework** with:
|
||||
### **SuperClaude vs Standard Claude Code**
|
||||
|
||||
- **Systematic Workflows** instead of ad-hoc requests
|
||||
- **Domain Expertise** through specialized agents
|
||||
- **Tool Coordination** with MCP server integration
|
||||
- **Session Persistence** for long-term project continuity
|
||||
- **Quality Assurance** through built-in validation gates
|
||||
<table>
|
||||
<tr>
|
||||
<th width="50%">✅ Use SuperClaude</th>
|
||||
<th width="50%">💭 Use Standard Claude</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">
|
||||
|
||||
### The Power is in the Coordination
|
||||
**Perfect for:**
|
||||
- 🏗️ Building complete software projects
|
||||
- 📊 Systematic workflows with quality gates
|
||||
- 🔄 Complex, multi-component systems
|
||||
- 💾 Long-term projects needing persistence
|
||||
- 👥 Team collaboration with standards
|
||||
- 🎯 Domain-specific expertise needs
|
||||
|
||||
**Intelligent Coordination Benefits:**
|
||||
**Examples:**
|
||||
- "Build a full-stack application"
|
||||
- "Implement secure authentication"
|
||||
- "Refactor legacy codebase"
|
||||
- "Create comprehensive test suite"
|
||||
|
||||
- **Auto-activation**: Right tools for the right tasks
|
||||
- **Multi-agent Workflows**: Frontend + Backend + Security working together
|
||||
- **Context Preservation**: No losing track of complex projects
|
||||
- **Parallel Processing**: Multiple operations running simultaneously
|
||||
- **Progressive Enhancement**: Simple tasks stay simple, complex tasks get expert attention
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
### Start Simple, Scale Intelligently
|
||||
**Better for:**
|
||||
- 💡 Simple questions or explanations
|
||||
- ⚡ One-off coding tasks
|
||||
- 📚 Learning programming concepts
|
||||
- 🧪 Quick prototypes or experiments
|
||||
- 🔍 Code snippet generation
|
||||
- ❓ General programming help
|
||||
|
||||
**Learning Path:**
|
||||
**Examples:**
|
||||
- "Explain how async/await works"
|
||||
- "Write a sorting function"
|
||||
- "Debug this error message"
|
||||
- "Convert this loop to functional"
|
||||
|
||||
**Week 1**: Master core commands (`/sc:brainstorm`, `/sc:analyze`, `/sc:implement`)
|
||||
**Week 2**: Explore behavioral modes and flag combinations
|
||||
**Week 3**: Configure MCP servers for enhanced capabilities
|
||||
**Week 4**: Create custom workflows and session management patterns
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
**Usage Recommendations:**
|
||||
- Start with simple commands and let complexity emerge naturally
|
||||
- Use `/sc:index` to discover relevant commands for your context
|
||||
- Enable MCP servers gradually as you understand their benefits
|
||||
- Save successful patterns with `/sc:save` for reuse
|
||||
|
||||
### When to Use SuperClaude
|
||||
|
||||
**Use SuperClaude When:**
|
||||
- Building software projects (any language/framework)
|
||||
- Need systematic workflows and quality gates
|
||||
- Working on complex, multi-component systems
|
||||
- Require session persistence across development cycles
|
||||
- Want specialized domain expertise (invoke with @agent-[specialist] or auto-activation)
|
||||
|
||||
**Use Standard Claude Code When:**
|
||||
- Simple questions or explanations
|
||||
- One-off coding tasks
|
||||
- Learning programming concepts
|
||||
- Quick prototypes or experiments
|
||||
|
||||
**Key Distinction**: SuperClaude doesn't replace Claude Code - it configures and enhances it through context. All execution happens within Claude Code itself.
|
||||
|
||||
**SuperClaude Excellence**: Multi-step development workflows with quality requirements
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
## 🎓 **Learning Path**
|
||||
|
||||
**Learning Progression:**
|
||||
<div align="center">
|
||||
|
||||
**🌱 Beginner (First Week)**
|
||||
- [Installation Guide](installation.md) - Get set up
|
||||
- [Commands Reference](../User-Guide/commands.md) - Learn core commands
|
||||
- [Examples Cookbook](../Reference/examples-cookbook.md) - Try practical examples
|
||||
### **Your 4-Week Journey to Mastery**
|
||||
|
||||
**🌿 Intermediate (Growing Skills)**
|
||||
- [Behavioral Modes](../User-Guide/modes.md) - Optimize for context
|
||||
- [Agents Guide](../User-Guide/agents.md) - Understand specialists
|
||||
- [Session Management](../User-Guide/session-management.md) - Long-term projects
|
||||
<table>
|
||||
<tr>
|
||||
<th>Week</th>
|
||||
<th>Focus</th>
|
||||
<th>Skills</th>
|
||||
<th>Milestone</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center"><b>1</b><br/>🌱</td>
|
||||
<td><b>Core Commands</b></td>
|
||||
<td>
|
||||
• <code>/sc:brainstorm</code><br/>
|
||||
• <code>/sc:analyze</code><br/>
|
||||
• <code>/sc:implement</code>
|
||||
</td>
|
||||
<td>Complete first project</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center"><b>2</b><br/>🌿</td>
|
||||
<td><b>Behavioral Modes</b></td>
|
||||
<td>
|
||||
• Mode combinations<br/>
|
||||
• Flag usage<br/>
|
||||
• Context optimization
|
||||
</td>
|
||||
<td>Optimize workflows</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center"><b>3</b><br/>🌿</td>
|
||||
<td><b>MCP Servers</b></td>
|
||||
<td>
|
||||
• Server configuration<br/>
|
||||
• Tool integration<br/>
|
||||
• Enhanced capabilities
|
||||
</td>
|
||||
<td>Full tool utilization</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center"><b>4</b><br/>🌲</td>
|
||||
<td><b>Advanced Patterns</b></td>
|
||||
<td>
|
||||
• Custom workflows<br/>
|
||||
• Session management<br/>
|
||||
• Team patterns
|
||||
</td>
|
||||
<td>Framework mastery</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
**🌲 Advanced (Expert Usage)**
|
||||
- [MCP Servers](../User-Guide/mcp-servers.md) - Enhanced capabilities
|
||||
- [Commands Reference](../User-Guide/commands.md) - All commands and workflows
|
||||
- [Technical Architecture](../Developer-Guide/technical-architecture.md) - Deep understanding
|
||||
</div>
|
||||
|
||||
**🚑 Support**
|
||||
- [Troubleshooting](../Reference/troubleshooting.md) - Problem solving
|
||||
- [Contributing](../Developer-Guide/contributing-code.md) - Join development
|
||||
---
|
||||
|
||||
## 💡 **Key Insights**
|
||||
|
||||
<div align="center">
|
||||
|
||||
### **Understanding SuperClaude's Value**
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="33%" align="center">
|
||||
|
||||
### 🧠 **Not Software**
|
||||
**It's a Framework**
|
||||
|
||||
SuperClaude is behavioral configuration, not standalone software. Everything runs through Claude Code.
|
||||
|
||||
</td>
|
||||
<td width="33%" align="center">
|
||||
|
||||
### 🔄 **Systematic**
|
||||
**Not Ad-hoc**
|
||||
|
||||
Transforms random requests into structured workflows with quality gates and validation.
|
||||
|
||||
</td>
|
||||
<td width="33%" align="center">
|
||||
|
||||
### 🚀 **Progressive**
|
||||
**Not Complex**
|
||||
|
||||
Start simple with basic commands. Complexity emerges naturally as needed.
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## 📖 **Next Steps**
|
||||
|
||||
<div align="center">
|
||||
|
||||
### **Continue Your Learning Journey**
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>🌱 Beginner</th>
|
||||
<th>🌿 Intermediate</th>
|
||||
<th>🌲 Advanced</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">
|
||||
|
||||
**First Week:**
|
||||
- [Installation Guide](installation.md)
|
||||
- [Commands Reference](../User-Guide/commands.md)
|
||||
- [Examples Cookbook](../Reference/examples-cookbook.md)
|
||||
|
||||
Start with `/sc:brainstorm`
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
**Growing Skills:**
|
||||
- [Behavioral Modes](../User-Guide/modes.md)
|
||||
- [Agents Guide](../User-Guide/agents.md)
|
||||
- [Session Management](../User-Guide/session-management.md)
|
||||
|
||||
Explore mode combinations
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
**Expert Usage:**
|
||||
- [MCP Servers](../User-Guide/mcp-servers.md)
|
||||
- [Technical Architecture](../Developer-Guide/technical-architecture.md)
|
||||
- [Contributing](../Developer-Guide/contributing-code.md)
|
||||
|
||||
Create custom workflows
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<p align="center">
|
||||
<a href="../User-Guide/commands.md">
|
||||
<img src="https://img.shields.io/badge/📚_Explore-All_21_Commands-blue?style=for-the-badge" alt="Commands">
|
||||
</a>
|
||||
<a href="../Reference/examples-cookbook.md">
|
||||
<img src="https://img.shields.io/badge/🍳_Try-Real_Examples-green?style=for-the-badge" alt="Examples">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
### **🎉 Ready to Transform Your Development Workflow?**
|
||||
|
||||
<p align="center">
|
||||
<b>Start now with</b> <code>/sc:brainstorm</code> <b>in Claude Code!</b>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<sub>SuperClaude v4.0.4 - Context Engineering for Claude Code</sub>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
420
README.md
420
README.md
@ -1,134 +1,366 @@
|
||||
# SuperClaude v4.0.4 🚀
|
||||
[](https://superclaude-org.github.io/SuperClaude_Website/)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
[](https://pypi.org/project/SuperClaude/)
|
||||
[](https://www.npmjs.com/package/@bifrost_inc/superclaude)
|
||||
[](https://github.com/SuperClaude-Org/SuperClaude_Framework)
|
||||
[](https://github.com/SuperClaude-Org/SuperClaude_Framework/issues)
|
||||
[](https://github.com/SuperClaude-Org/SuperClaude_Framework/blob/master/CONTRIBUTING.md)
|
||||
[](https://github.com/SuperClaude-Org/SuperClaude_Framework/graphs/contributors)
|
||||
[](https://superclaude-org.github.io/SuperClaude_Website/)
|
||||
<div align="center">
|
||||
|
||||
SuperClaude is a meta-programming configuration framework that transforms Claude Code into a structured development platform through behavioral instruction injection and component orchestration. It enhances Claude Code with 21 slash commands, 14 specialized agents, 5 behavioral modes, and 6 MCP server integrations for systematic workflow automation.
|
||||
# 🚀 SuperClaude Framework
|
||||
|
||||
## Quick Start
|
||||
### **Transform Claude Code into a Structured Development Platform**
|
||||
|
||||
<p align="center">
|
||||
<img src="https://img.shields.io/badge/version-4.0.4-blue?style=for-the-badge" alt="Version">
|
||||
<img src="https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge" alt="License">
|
||||
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge" alt="PRs Welcome">
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://superclaude-org.github.io/SuperClaude_Website/">
|
||||
<img src="https://img.shields.io/badge/🌐_Visit_Website-blue?style=for-the-badge" alt="Website">
|
||||
</a>
|
||||
<a href="https://pypi.org/project/SuperClaude/">
|
||||
<img src="https://img.shields.io/pypi/v/SuperClaude.svg?style=for-the-badge&label=PyPI" alt="PyPI">
|
||||
</a>
|
||||
<a href="https://www.npmjs.com/package/@bifrost_inc/superclaude">
|
||||
<img src="https://img.shields.io/npm/v/@bifrost_inc/superclaude.svg?style=for-the-badge&label=npm" alt="npm">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="#-quick-installation">Quick Start</a> •
|
||||
<a href="#-support-the-project">Support</a> •
|
||||
<a href="#-whats-new-in-v4">Features</a> •
|
||||
<a href="#-documentation">Docs</a> •
|
||||
<a href="#-contributing">Contributing</a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 📊 **Framework Statistics**
|
||||
|
||||
| **Commands** | **Agents** | **Modes** | **MCP Servers** |
|
||||
|:------------:|:----------:|:---------:|:---------------:|
|
||||
| **21** | **14** | **6** | **6** |
|
||||
| Slash Commands | Specialized AI | Behavioral | Integrations |
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## 🎯 **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.
|
||||
|
||||
## ⚡ **Quick Installation**
|
||||
|
||||
<div align="center">
|
||||
|
||||
### **Choose Your Installation Method**
|
||||
|
||||
| Method | Command | Best For |
|
||||
|:------:|---------|----------|
|
||||
| **🐍 pipx** | `pipx install SuperClaude && SuperClaude install` | **✅ Recommended** - Linux/macOS |
|
||||
| **📦 pip** | `pip install SuperClaude && SuperClaude install` | Traditional Python environments |
|
||||
| **🌐 npm** | `npm install -g @bifrost_inc/superclaude && superclaude install` | Cross-platform, Node.js users |
|
||||
|
||||
</div>
|
||||
|
||||
<details>
|
||||
<summary><b>💡 Troubleshooting PEP 668 Errors</b></summary>
|
||||
|
||||
```bash
|
||||
# Via pipx (recommended for Linux/macOS)
|
||||
pipx install SuperClaude && SuperClaude install
|
||||
# Option 1: Use pipx (Recommended)
|
||||
pipx install SuperClaude
|
||||
|
||||
# Via pip (traditional)
|
||||
pip install SuperClaude && SuperClaude install
|
||||
# Option 2: User installation
|
||||
pip install --user SuperClaude
|
||||
|
||||
# Via NPM (cross-platform)
|
||||
npm install -g @bifrost_inc/superclaude && superclaude install
|
||||
|
||||
# If you get PEP 668 errors, use one of these:
|
||||
pipx install SuperClaude # Recommended
|
||||
pip install --user SuperClaude # User install
|
||||
pip install --break-system-packages SuperClaude # Force (use with caution)
|
||||
# Option 3: Force installation (use with caution)
|
||||
pip install --break-system-packages SuperClaude
|
||||
```
|
||||
</details>
|
||||
|
||||
## 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.
|
||||
<div align="center">
|
||||
|
||||
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.
|
||||
## 💖 **Support the Project**
|
||||
|
||||
[](https://ko-fi.com/superclaude)
|
||||
[](https://patreon.com/superclaude)
|
||||
> *Maintaining SuperClaude takes time and resources. Your support helps keep development active!*
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" width="33%">
|
||||
|
||||
### ☕ **Ko-fi**
|
||||
[](https://ko-fi.com/superclaude)
|
||||
|
||||
*One-time contributions*
|
||||
|
||||
</td>
|
||||
<td align="center" width="33%">
|
||||
|
||||
### 🎯 **Patreon**
|
||||
[](https://patreon.com/superclaude)
|
||||
|
||||
*Monthly support*
|
||||
|
||||
</td>
|
||||
<td align="center" width="33%">
|
||||
|
||||
### 💜 **GitHub**
|
||||
[](https://github.com/sponsors/SuperClaude-Org)
|
||||
|
||||
**What your support covers:**
|
||||
- Claude Max subscription for testing and validation ($100/month)
|
||||
- Development time for new features and bug fixes
|
||||
- Documentation and example creation
|
||||
- Community support and issue responses
|
||||
- MCP server integration testing
|
||||
- Infrastructure and hosting costs
|
||||
*Flexible tiers*
|
||||
|
||||
No pressure though - the framework stays open source regardless. Just knowing people use and appreciate it is motivating. If you can't support financially, contributing code, documentation, or just spreading the word helps too.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Every contributor matters, whether through code, feedback, or support. Thanks for being part of this community! 🙏
|
||||
### **Your Support Enables:**
|
||||
|
||||
## What's New in V4
|
||||
| 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 |
|
||||
|
||||
Version 4 brings significant improvements based on community feedback and real-world usage patterns.
|
||||
> **Note:** The framework stays open source regardless. Contributing code, documentation, or spreading the word helps too! 🙏
|
||||
|
||||
### 🤖 Smarter Agent System
|
||||
We've expanded to 14 specialized agents that actually know their domains. The security engineer catches real vulnerabilities, the frontend architect understands modern UI patterns, and they coordinate automatically based on what you're working on. No more generic advice - you get domain expertise when you need it.
|
||||
</div>
|
||||
|
||||
### 📝 Namespace That Makes Sense
|
||||
All commands now use `/sc:` prefix to avoid stepping on your custom commands. Simple change, but it matters when you're managing multiple command sets. The 21 commands cover the full development lifecycle from brainstorming to deployment.
|
||||
---
|
||||
|
||||
### 🔧 MCP Servers That Actually Help
|
||||
Six integrated MCP servers provide real capabilities:
|
||||
- **Context7** for up-to-date documentation
|
||||
- **Sequential** for complex analysis and problem-solving
|
||||
- **Magic** for UI component generation
|
||||
- **Playwright** for browser testing
|
||||
- **Morphllm** for bulk code transformations
|
||||
- **Serena** for session persistence
|
||||
## 🎉 **What's New in V4**
|
||||
|
||||
These aren't just wrappers; they're properly integrated tools that work together.
|
||||
<div align="center">
|
||||
|
||||
### 🎯 Behavioral Modes for Different Contexts
|
||||
Five modes adjust Claude's approach based on what you're doing. Brainstorming mode asks the right questions, orchestration mode coordinates tools efficiently, token-efficiency mode reduces context usage by 30-50%. It adapts to your workflow, not the other way around.
|
||||
> *Version 4 brings significant improvements based on community feedback and real-world usage patterns.*
|
||||
|
||||
### ⚡ Smaller Framework, Bigger Projects
|
||||
We've cut the framework's footprint significantly. Less framework overhead at Claude Code startup means more context available for your actual work. The entire V4 framework uses fewer tokens to load, leaving you with more room for your codebase, longer conversations, and complex operations. It's simple math - smaller framework = larger available context for what matters.
|
||||
</div>
|
||||
|
||||
### 📚 Complete Documentation Overhaul
|
||||
We've rebuilt the docs from scratch based on what developers actually need. Every guide now includes real examples, common pitfalls, and practical workflows. The whole documentation set got restructured for better navigation - you'll find what you need faster. If something's unclear or missing, let us know. Seriously, we want the docs to be genuinely helpful, not just technically complete.
|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
## Documentation
|
||||
### 🤖 **Smarter Agent System**
|
||||
**14 specialized agents** with domain expertise:
|
||||
- Security engineer catches real vulnerabilities
|
||||
- Frontend architect understands UI patterns
|
||||
- Automatic coordination based on context
|
||||
- Domain-specific expertise on demand
|
||||
|
||||
### Getting Started
|
||||
- [Quick Start Guide](Docs/Getting-Started/quick-start.md)
|
||||
- [Installation Guide](Docs/Getting-Started/installation.md)
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
### User Guides
|
||||
- [Commands Reference](Docs/User-Guide/commands.md)
|
||||
- [Agents Guide](Docs/User-Guide/agents.md)
|
||||
- [Behavioral Modes](Docs/User-Guide/modes.md)
|
||||
- [Flags Guide](Docs/User-Guide/flags.md)
|
||||
- [MCP Servers](Docs/User-Guide/mcp-servers.md)
|
||||
- [Session Management](Docs/User-Guide/session-management.md)
|
||||
### 📝 **Improved Namespace**
|
||||
**`/sc:` prefix** for all commands:
|
||||
- No conflicts with custom commands
|
||||
- 21 commands covering full lifecycle
|
||||
- From brainstorming to deployment
|
||||
- Clean, organized command structure
|
||||
|
||||
### Developer Resources
|
||||
- [Technical Architecture](Docs/Developer-Guide/technical-architecture.md)
|
||||
- [Contributing Code](Docs/Developer-Guide/contributing-code.md)
|
||||
- [Testing & Debugging](Docs/Developer-Guide/testing-debugging.md)
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
### Reference
|
||||
- [Quick Start Practices](Docs/Reference/quick-start-practices.md)
|
||||
- [Examples Cookbook](Docs/Reference/examples-cookbook.md)
|
||||
- [Troubleshooting](Docs/Reference/troubleshooting.md)
|
||||
### 🔧 **MCP Server Integration**
|
||||
**6 powerful servers** working together:
|
||||
- **Context7** → Up-to-date documentation
|
||||
- **Sequential** → Complex analysis
|
||||
- **Magic** → UI component generation
|
||||
- **Playwright** → Browser testing
|
||||
- **Morphllm** → Bulk transformations
|
||||
- **Serena** → Session persistence
|
||||
|
||||
## Contributing
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
**Current Priorities:**
|
||||
- 📝 Documentation improvements and examples
|
||||
- 🔧 MCP server integrations and configurations
|
||||
- 🎯 Command workflow examples and patterns
|
||||
- 🧪 Testing and validation procedures
|
||||
- 🌐 Translation and internationalization
|
||||
### 🎯 **Behavioral Modes**
|
||||
**5 adaptive modes** for different contexts:
|
||||
- **Brainstorming** → Asks right questions
|
||||
- **Orchestration** → Efficient tool coordination
|
||||
- **Token-Efficiency** → 30-50% context savings
|
||||
- **Task Management** → Systematic organization
|
||||
- **Introspection** → Meta-cognitive analysis
|
||||
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed contribution guidelines.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
## License
|
||||
### ⚡ **Optimized Performance**
|
||||
**Smaller framework, bigger projects:**
|
||||
- Reduced framework footprint
|
||||
- More context for your code
|
||||
- Longer conversations possible
|
||||
- Complex operations enabled
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
**Contributors:** [View all contributors](https://github.com/SuperClaude-Org/SuperClaude_Framework/graphs/contributors)
|
||||
### 📚 **Documentation Overhaul**
|
||||
**Complete rewrite** for developers:
|
||||
- Real examples & use cases
|
||||
- Common pitfalls documented
|
||||
- Practical workflows included
|
||||
- Better navigation structure
|
||||
|
||||
## Star History
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
---
|
||||
|
||||
## 📚 **Documentation**
|
||||
|
||||
<div align="center">
|
||||
|
||||
### **Complete Guide to SuperClaude**
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th align="center">🚀 Getting Started</th>
|
||||
<th align="center">📖 User Guides</th>
|
||||
<th align="center">🛠️ Developer Resources</th>
|
||||
<th align="center">📋 Reference</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">
|
||||
|
||||
- 📝 [**Quick Start Guide**](Docs/Getting-Started/quick-start.md)
|
||||
*Get up and running fast*
|
||||
|
||||
- 💾 [**Installation Guide**](Docs/Getting-Started/installation.md)
|
||||
*Detailed setup instructions*
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
- 🎯 [**Commands Reference**](Docs/User-Guide/commands.md)
|
||||
*All 21 slash commands*
|
||||
|
||||
- 🤖 [**Agents Guide**](Docs/User-Guide/agents.md)
|
||||
*14 specialized agents*
|
||||
|
||||
- 🎨 [**Behavioral Modes**](Docs/User-Guide/modes.md)
|
||||
*6 adaptive modes*
|
||||
|
||||
- 🚩 [**Flags Guide**](Docs/User-Guide/flags.md)
|
||||
*Control behaviors*
|
||||
|
||||
- 🔧 [**MCP Servers**](Docs/User-Guide/mcp-servers.md)
|
||||
*6 server integrations*
|
||||
|
||||
- 💼 [**Session Management**](Docs/User-Guide/session-management.md)
|
||||
*Save & restore state*
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
- 🏗️ [**Technical Architecture**](Docs/Developer-Guide/technical-architecture.md)
|
||||
*System design details*
|
||||
|
||||
- 💻 [**Contributing Code**](Docs/Developer-Guide/contributing-code.md)
|
||||
*Development workflow*
|
||||
|
||||
- 🧪 [**Testing & Debugging**](Docs/Developer-Guide/testing-debugging.md)
|
||||
*Quality assurance*
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
- ✨ [**Best Practices**](Docs/Reference/quick-start-practices.md)
|
||||
*Pro tips & patterns*
|
||||
|
||||
- 📓 [**Examples Cookbook**](Docs/Reference/examples-cookbook.md)
|
||||
*Real-world recipes*
|
||||
|
||||
- 🔍 [**Troubleshooting**](Docs/Reference/troubleshooting.md)
|
||||
*Common issues & fixes*
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## 🤝 **Contributing**
|
||||
|
||||
<div align="center">
|
||||
|
||||
### **Join the SuperClaude Community**
|
||||
|
||||
We welcome contributions of all kinds! Here's how you can help:
|
||||
|
||||
| Priority | Area | Description |
|
||||
|:--------:|------|-------------|
|
||||
| 📝 **High** | Documentation | Improve guides, add examples, fix typos |
|
||||
| 🔧 **High** | MCP Integration | Add server configs, test integrations |
|
||||
| 🎯 **Medium** | Workflows | Create command patterns & recipes |
|
||||
| 🧪 **Medium** | Testing | Add tests, validate features |
|
||||
| 🌐 **Low** | i18n | Translate docs to other languages |
|
||||
|
||||
<p align="center">
|
||||
<a href="CONTRIBUTING.md">
|
||||
<img src="https://img.shields.io/badge/📖_Read-Contributing_Guide-blue?style=for-the-badge" alt="Contributing Guide">
|
||||
</a>
|
||||
<a href="https://github.com/SuperClaude-Org/SuperClaude_Framework/graphs/contributors">
|
||||
<img src="https://img.shields.io/badge/👥_View-All_Contributors-green?style=for-the-badge" alt="Contributors">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## ⚖️ **License**
|
||||
|
||||
<div align="center">
|
||||
|
||||
This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
<p align="center">
|
||||
<img src="https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge" alt="MIT License">
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## ⭐ **Star History**
|
||||
|
||||
<div align="center">
|
||||
|
||||
<a href="https://www.star-history.com/#SuperClaude-Org/SuperClaude_Framework&Date">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Date&theme=dark" />
|
||||
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Date" />
|
||||
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Date" />
|
||||
</picture>
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Date&theme=dark" />
|
||||
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Date" />
|
||||
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Date" />
|
||||
</picture>
|
||||
</a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
### **🚀 Built with passion by the SuperClaude community**
|
||||
|
||||
<p align="center">
|
||||
<sub>Made with ❤️ for developers who push boundaries</sub>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="#-superclaude-framework">Back to Top ↑</a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user