* refactor(docs): rename directories to lowercase for PEP8 compliance - Developer-Guide → developer-guide - Getting-Started → getting-started - Reference → reference - Templates → templates - User-Guide → user-guide - User-Guide-jp → user-guide-jp - User-Guide-kr → user-guide-kr - User-Guide-zh → user-guide-zh This change aligns with Python PEP8 package naming conventions. All 43 files affected. * refactor: rename root documentation files to lowercase - CHANGELOG.md → changelog.md - CODE_OF_CONDUCT.md → code_of_conduct.md - CONTRIBUTING.md → contributing.md - SECURITY.md → security.md Aligns with Python package naming conventions (PEP8). README files remain uppercase as per convention. * refactor: move documentation files to docs/ for cleaner root Moved OSS standard files to docs/: - CHANGELOG.md → docs/CHANGELOG.md - CODE_OF_CONDUCT.md → docs/CODE_OF_CONDUCT.md - CONTRIBUTING.md → docs/CONTRIBUTING.md - SECURITY.md → docs/SECURITY.md Root now contains only essential files: ✓ README files (表紙: en, ja, kr, zh) ✓ LICENSE (法的要件) ✓ Build configs (pyproject.toml, setup.py, MANIFEST.in) ✓ VERSION Rationale: Cleaner root structure following modern Python project conventions. All detailed documentation consolidated in docs/ directory. * refactor: update documentation links after restructure Auto-updated internal documentation links to reflect new structure: - docs/ subdirectories now lowercase (PEP8) - Root files moved to docs/ - All cross-references updated This commit includes linter-generated link updates. * chore(docs): keep OSS-standard uppercase root files (CHANGELOG, CODE_OF_CONDUCT, CONTRIBUTING, SECURITY) * chore(docs): remove duplicated PR docs from repo root (moved under docs) * docs: rename pm-agent-implementation-status.md -> PM_AGENT.md for clarity * docs: update links to PM_AGENT.md after rename --------- Co-authored-by: kazuki <kazuki@kazukinoMacBook-Air.local>
10 KiB
🚀 SuperClaude Quick Start Guide
Context Engineering Framework for Claude Code
💡 Key Insight: SuperClaude doesn't replace Claude Code - it configures and enhances it through behavioral context injection
How It Works • Instant Start • Components • Workflows • When to Use
📊 Framework Capabilities
| Commands | AI Agents | Behavioral Modes | MCP Servers |
|---|---|---|---|
| 21 | 14 | 6 | 6 |
/sc: triggers |
Domain specialists | Context adaptation | Tool integration |
🎯 How It Works
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
⚡ Instant Start
5-Minute Journey from Installation to First Command
| 📦 Step 1: Install (Terminal) | 💬 Step 2: Use (Claude Code) |
|---|---|
|
|
🎥 What Happens Behind the Scenes
- Context Loading: Claude Code imports behavioral
.mdfiles viaCLAUDE.md - Pattern Recognition: Recognizes
/sc:and@agent-trigger patterns - Behavioral Activation: Applies corresponding instructions from context files
- MCP Integration: Uses configured external tools when available
- Response Enhancement: Follows framework patterns for comprehensive responses
🔧 Core Components
Four Pillars of SuperClaude
📝 Commands21Slash Commands
Workflow automation |
🤖 Agents14AI Specialists
Domain expertise |
🎯 Modes6Behavioral Modes Brainstorming Context adaptation |
🔌 MCP6Server Integration Context7 (docs) Enhanced tools |
📚 Workflow Patterns
Complete Development Lifecycle
🌟 First Project Session
| Step | Command | What Happens |
|---|---|---|
| 1. Discovery | /sc:brainstorm "e-commerce app" |
Interactive requirements exploration |
| 2. Load Context | /sc:load src/ |
Import existing project structure |
| 3. Analysis | /sc:analyze --focus architecture |
Deep architectural review |
| 4. Planning | /sc:workflow "payment integration" |
Generate implementation roadmap |
| 5. Implementation | /sc:implement "Stripe checkout" |
Build with best practices |
| 6. Validation | /sc:test --coverage |
Comprehensive testing |
| 7. Save Session | /sc:save "payment-complete" |
Persist for next session |
🎨 Domain-Specific Workflows
| 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 |
🎯 When to Use
SuperClaude vs Standard Claude Code
| ✅ Use SuperClaude | 💭 Use Standard Claude |
|---|---|
|
Perfect for:
Examples:
|
Better for:
Examples:
|
🎓 Learning Path
Your 4-Week Journey to Mastery
| Week | Focus | Skills | Milestone |
|---|---|---|---|
| 1 🌱 |
Core Commands |
• /sc:brainstorm• /sc:analyze• /sc:implement
|
Complete first project |
| 2 🌿 |
Behavioral Modes |
• Mode combinations • Flag usage • Context optimization |
Optimize workflows |
| 3 🌿 |
MCP Servers |
• Server configuration • Tool integration • Enhanced capabilities |
Full tool utilization |
| 4 🌲 |
Advanced Patterns |
• Custom workflows • Session management • Team patterns |
Framework mastery |
💡 Key Insights
Understanding SuperClaude's Value
🧠 Not SoftwareIt's a Framework SuperClaude is behavioral configuration, not standalone software. Everything runs through Claude Code. |
🔄 SystematicNot Ad-hoc Transforms random requests into structured workflows with quality gates and validation. |
🚀 ProgressiveNot Complex Start simple with basic commands. Complexity emerges naturally as needed. |
📖 Next Steps
Continue Your Learning Journey
| 🌱 Beginner | 🌿 Intermediate | 🌲 Advanced |
|---|---|---|
|
First Week: Start with |
Growing Skills: Explore mode combinations |
Expert Usage: Create custom workflows |
🎉 Ready to Transform Your Development Workflow?
Start now with /sc:brainstorm in Claude Code!
SuperClaude v4.1.5 - Context Engineering for Claude Code