mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-18 02:06:36 +00:00
bdfa09af32
- Added pipx as recommended installation method across all docs - Updated troubleshooting guides with PEP 668 error solutions - Added multiple installation options with clear hierarchy - Enhanced error handling instructions with fallback options - Consistent installation instructions throughout documentation
200 lines
7.8 KiB
Markdown
200 lines
7.8 KiB
Markdown
# SuperClaude Quick Start Guide
|
|
|
|
> **Context Framework Guide**: SuperClaude enhances Claude Code through behavioral context injection, NOT CLI commands. `/sc:` patterns are conversation triggers that activate installed behavioral instructions.
|
|
|
|
## How SuperClaude Really Works
|
|
|
|
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.
|
|
|
|
**5-Minute Start**: Install context framework → Try `/sc:brainstorm` in Claude conversation → Experience enhanced behaviors.
|
|
|
|
## Just Start Here
|
|
|
|
### 🖥️ Installation - Run in Terminal
|
|
```bash
|
|
# Recommended for Linux/macOS
|
|
pipx install SuperClaude && SuperClaude install
|
|
|
|
# Traditional method
|
|
pip install SuperClaude && SuperClaude install
|
|
|
|
# Cross-platform via NPM
|
|
npm install -g @bifrost_inc/superclaude && superclaude install
|
|
```
|
|
|
|
### 💬 First Context Triggers - Type in Claude Code Conversation
|
|
```
|
|
# Interactive project discovery
|
|
/sc:brainstorm "web app for task management"
|
|
|
|
# Analyze existing code
|
|
/sc:analyze src/
|
|
|
|
# Generate implementation plan
|
|
/sc:workflow "add user authentication"
|
|
|
|
# Invoke specialist persona
|
|
@agent-security "review authentication implementation"
|
|
```
|
|
|
|
**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
|
|
|
|
**Key Understanding**: These are conversation patterns with Claude Code, not executable commands. The framework provides Claude with behavioral context to respond more expertly.
|
|
|
|
---
|
|
|
|
## What is SuperClaude Really?
|
|
|
|
### Framework Philosophy
|
|
|
|
**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.
|
|
|
|
### Core Components
|
|
|
|
SuperClaude enhances Claude Code with:
|
|
|
|
**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)
|
|
|
|
**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.
|
|
|
|
**Version 4.0** delivers workflow orchestration capabilities with intelligent agent coordination and session persistence.
|
|
|
|
## How It Works
|
|
|
|
**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.
|
|
|
|
**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.
|
|
|
|
**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)
|
|
|
|
---
|
|
|
|
## First Steps Workflow
|
|
|
|
**First Context Session Pattern:**
|
|
```
|
|
# 1. Project Discovery (context trigger)
|
|
/sc:brainstorm "e-commerce mobile app"
|
|
|
|
# 2. Load Context (existing projects)
|
|
/sc:load src/
|
|
|
|
# 3. Analyze Current State
|
|
/sc:analyze --focus architecture
|
|
|
|
# 4. Plan Implementation
|
|
/sc:workflow "add payment integration"
|
|
|
|
# 5. Implement Features
|
|
/sc:implement "Stripe payment flow"
|
|
|
|
# 6. Validate Quality
|
|
/sc:test --coverage
|
|
|
|
# 7. Save Session
|
|
/sc:save "payment-integration-complete"
|
|
```
|
|
|
|
**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
|
|
|
|
---
|
|
|
|
## Key Takeaways
|
|
|
|
### SuperClaude's Core Value
|
|
|
|
SuperClaude transforms Claude Code from a general-purpose AI assistant into a **specialized development framework** with:
|
|
|
|
- **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
|
|
|
|
### The Power is in the Coordination
|
|
|
|
**Intelligent Coordination Benefits:**
|
|
|
|
- **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
|
|
|
|
### Start Simple, Scale Intelligently
|
|
|
|
**Learning Path:**
|
|
|
|
**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
|
|
|
|
**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
|
|
|
|
---
|
|
|
|
## Next Steps
|
|
|
|
**Learning Progression:**
|
|
|
|
**🌱 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
|
|
|
|
**🌿 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
|
|
|
|
**🌲 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
|
|
|
|
**🚑 Support**
|
|
- [Troubleshooting](../Reference/troubleshooting.md) - Problem solving
|
|
- [Contributing](../Developer-Guide/contributing-code.md) - Join development |