mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
1eab5e3bc4
## Command Syntax Standardization - Fix lowercase "superclaude" → "SuperClaude" in installation.md - Distinguish between terminal commands (SuperClaude install) and Claude Code commands (/sc:*) - Add clear command context headers to all major documentation files ## Documentation Improvements - Add command reference tables to key guides - Create visual distinction markers (🖥️ Terminal vs 💬 Claude Code) - Update verification sections with proper command separation - Fix content duplications in Developer-Guide and Getting-Started files ## Cross-Reference Updates - Standardize all documentation links to use Docs/ prefix structure - Replace invalid email addresses with anton.knoery@gmail.com - Remove non-existent team references from security documentation ## Files Enhanced - Getting-Started: installation.md, quick-start.md with command clarity - User-Guide: commands.md with comprehensive command context - Reference: troubleshooting.md, common-issues.md with mixed command support - Root files: README.md, CONTRIBUTING.md, SECURITY.md link updates This resolves command confusion between installation (terminal) and development (/sc:) commands. 🤖 Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
174 lines
6.0 KiB
Markdown
174 lines
6.0 KiB
Markdown
# SuperClaude Quick Start Guide
|
|
|
|
> **Command Context**: This guide uses both **Terminal Commands** (for installation) and **Claude Code Commands** (`/sc:` for development). See sections below for where to run each type.
|
|
|
|
## The Simple Truth
|
|
|
|
SuperClaude transforms Claude Code into a structured development framework with just one installation command. Behind the simple interface, intelligent routing automatically selects the right tools, activates domain experts, and coordinates complex workflows.
|
|
|
|
**5-Minute Start**: Install → Try `/sc:brainstorm` → Watch the magic happen.
|
|
|
|
## Just Start Here
|
|
|
|
### 🖥️ Installation (2 minutes) - Run in Terminal
|
|
```bash
|
|
pip install SuperClaude && SuperClaude install
|
|
```
|
|
|
|
### 💬 First Commands (3 minutes) - Type in Claude Code
|
|
```
|
|
# Interactive project discovery
|
|
/sc:brainstorm "web app for task management"
|
|
|
|
# Analyze existing code
|
|
/sc:analyze src/
|
|
|
|
# Generate implementation plan
|
|
/sc:workflow "add user authentication"
|
|
```
|
|
|
|
**What Happens Automatically:**
|
|
- Domain experts activate based on context (frontend, backend, security)
|
|
- MCP servers connect for enhanced capabilities
|
|
- Behavioral modes adapt to task complexity
|
|
- Progress tracking and session management
|
|
|
|
---
|
|
|
|
## What is SuperClaude Really?
|
|
|
|
SuperClaude is a meta-programming framework that enhances Claude Code with:
|
|
|
|
**21 Slash Commands** for workflow automation (/sc:brainstorm, /sc:implement, /sc:analyze)
|
|
**13 AI Specialists** with domain expertise (architect, security, frontend, backend)
|
|
**6 Behavioral Modes** for different contexts (brainstorming, introspection, orchestration)
|
|
**6 MCP Servers** for enhanced capabilities (Context7, Sequential, Magic, Playwright)
|
|
|
|
**Version 4.0** delivers production-ready workflow orchestration with intelligent agent coordination and session persistence.
|
|
|
|
## How It Works
|
|
|
|
**User Experience:**
|
|
You type `/sc:implement "user login"` → SuperClaude analyzes requirements → activates security specialist → connects to Context7 for authentication patterns → generates complete implementation with tests.
|
|
|
|
**Technical Workflow:**
|
|
1. **Command Parser** analyzes intent and complexity
|
|
2. **Agent Router** selects appropriate domain specialists
|
|
3. **MCP Coordinator** activates relevant servers (Context7, Sequential, etc.)
|
|
4. **Session Manager** tracks progress and maintains context
|
|
5. **Quality Gates** ensure completeness and validation
|
|
|
|
---
|
|
|
|
## First Steps Workflow
|
|
|
|
**First Session Pattern:**
|
|
```bash
|
|
# 1. Project Discovery
|
|
/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 (security, performance, etc.)
|
|
|
|
**Use Standard Claude Code When:**
|
|
- Simple questions or explanations
|
|
- One-off coding tasks
|
|
- Learning programming concepts
|
|
- Quick prototypes or experiments
|
|
|
|
**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
|
|
- [Best Practices](../Reference/quick-start-practices.md) - Optimization strategies
|
|
- [Technical Architecture](../Developer-Guide/technical-architecture.md) - Deep understanding
|
|
|
|
**🚑 Support**
|
|
- [Troubleshooting](../Reference/troubleshooting.md) - Problem solving
|
|
- [Contributing](../Developer-Guide/contributing-code.md) - Join development |