Back to Superclaude Framework

๐Ÿš€ SuperClaude Quick Start Guide

docs/getting-started/quick-start.md

4.3.010.5 KB
Original Source
<div align="center">

๐Ÿš€ SuperClaude Quick Start Guide

Context Engineering Framework for Claude Code

<p align="center"> </p>

๐Ÿ’ก Key Insight: SuperClaude doesn't replace Claude Code - it configures and enhances it through behavioral context injection

<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

CommandsAI AgentsBehavioral ModesMCP Servers
302078
/sc: triggersDomain specialistsContext adaptationTool 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">
bash
# Quick install with pipx
pipx install SuperClaude && SuperClaude install

# Or traditional pip
pip install SuperClaude && SuperClaude install

# Or via npm
npm install -g @bifrost_inc/superclaude && superclaude install
</td> <td valign="top">
text
# Interactive discovery
/sc:brainstorm "web app for task management"

# Analyze existing code
/sc:analyze src/

# Generate implementation
/sc:implement "user authentication"

# Activate specialist
@agent-security "review auth flow"
</td> </tr> </table> <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>

๐Ÿ”ง Core Components

<div align="center">

Four Pillars of SuperClaude

<table> <tr> <td align="center" width="25%">

๐Ÿ“ Commands

<h2>21</h2>

Slash Commands

/sc:brainstorm
/sc:implement
/sc:analyze
/sc:workflow

Workflow automation

</td> <td align="center" width="25%">

๐Ÿค– Agents

<h2>14</h2>

AI Specialists

@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>

๐Ÿ“š Workflow Patterns

<div align="center">

Complete Development Lifecycle

</div>

๐ŸŒŸ First Project Session

<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>

๐ŸŽจ Domain-Specific Workflows

<div align="center">
DomainTriggerSpecialist ActivationMCP Server
FrontendUI component request@agent-frontendMagic
BackendAPI endpoint creation@agent-backendSequential
SecurityAuth implementation@agent-securityContext7
TestingE2E test scenarios@agent-qaPlaywright
DevOpsDeployment setup@agent-devopsMorphllm
</div>

๐ŸŽฏ When to Use

<div align="center">

SuperClaude vs Standard Claude Code

<table> <tr> <th width="50%">โœ… Use SuperClaude</th> <th width="50%">๐Ÿ’ญ Use Standard Claude</th> </tr> <tr> <td valign="top">

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

Examples:

  • "Build a full-stack application"
  • "Implement secure authentication"
  • "Refactor legacy codebase"
  • "Create comprehensive test suite"
</td> <td valign="top">

Better for:

  • ๐Ÿ’ก Simple questions or explanations
  • โšก One-off coding tasks
  • ๐Ÿ“š Learning programming concepts
  • ๐Ÿงช Quick prototypes or experiments
  • ๐Ÿ” Code snippet generation
  • โ“ General programming help

Examples:

  • "Explain how async/await works"
  • "Write a sorting function"
  • "Debug this error message"
  • "Convert this loop to functional"
</td> </tr> </table> </div>

๐ŸŽ“ Learning Path

<div align="center">

Your 4-Week Journey to Mastery

<table> <tr> <th>Week</th> <th>Focus</th> <th>Skills</th> <th>Milestone</th> </tr> <tr> <td align="center"><b>1</b> ๐ŸŒฑ</td> <td><b>Core Commands</b></td> <td> โ€ข <code>/sc:brainstorm</code>

โ€ข <code>/sc:analyze</code>

โ€ข <code>/sc:implement</code>

</td> <td>Complete first project</td> </tr> <tr> <td align="center"><b>2</b> ๐ŸŒฟ</td> <td><b>Behavioral Modes</b></td> <td> โ€ข Mode combinations

โ€ข Flag usage

โ€ข Context optimization

</td> <td>Optimize workflows</td> </tr> <tr> <td align="center"><b>3</b> ๐ŸŒฟ</td> <td><b>MCP Servers</b></td> <td> โ€ข Server configuration

โ€ข Tool integration

โ€ข Enhanced capabilities

</td> <td>Full tool utilization</td> </tr> <tr> <td align="center"><b>4</b> ๐ŸŒฒ</td> <td><b>Advanced Patterns</b></td> <td> โ€ข Custom workflows

โ€ข Session management

โ€ข Team patterns

</td> <td>Framework mastery</td> </tr> </table> </div>

๐Ÿ’ก 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:

Start with /sc:brainstorm

</td> <td valign="top">

Growing Skills:

Explore mode combinations

</td> <td valign="top">

Expert Usage:

Create custom workflows

</td> </tr> </table> <p align="center"> <a href="../user-guide/commands.md"> </a> <a href="../reference/examples-cookbook.md"> </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.3.0 - Context Engineering for Claude Code</sub> </p> </div>