200 lines
7.8 KiB
Markdown
Raw Normal View History

# SuperClaude Quick Start Guide
📚 Major documentation cleanup: Fix CLI confusion and streamline content ## Critical Fixes ✅ - **CLI Command Syntax**: Fixed all ambiguous `SuperClaude --version` → `python3 -m SuperClaude --version` - **Architecture Clarity**: Verified dual architecture documentation (Python CLI + Context Framework) - **External Dependencies**: Marked unverified APIs as experimental (TWENTYFIRST_API_KEY, MORPH_API_KEY) - **Installation Instructions**: Clarified NPM package names with verification warnings ## Content Optimization 🗑️ - **Removed unnecessary files**: - optimization-guide.md (inappropriate for context files) - quick-start-practices.md (duplicate content) - Various outdated socratic learning components - **Updated cross-references**: Fixed all broken links to point to existing, relevant content - **Consolidated navigation**: Streamlined Reference/README.md documentation matrix ## Technical Accuracy 🎯 - **Command References**: All commands now specify exact usage context (terminal vs Claude Code) - **Framework Nature**: Consistently explains SuperClaude as context framework, not executable software - **Installation Verification**: Updated diagnostic scripts with correct Python CLI commands - **MCP Configuration**: Marked experimental services appropriately ## Impact Summary 📊 - **Files Modified**: 15+ documentation files for accuracy and consistency - **Files Removed**: 5+ unnecessary/duplicate files - **Broken Links**: 0 (all cross-references updated) - **User Clarity**: Significantly improved understanding of dual architecture Result: Professional documentation that accurately represents SuperClaude's sophisticated dual architecture (Python CLI installation system + Claude Code context framework). 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-21 19:03:25 +02:00
> **Context Framework Guide**: SuperClaude enhances Claude Code through behavioral context injection, NOT CLI commands. `/sc:` patterns are conversation triggers that activate installed behavioral instructions.
📚 Major documentation cleanup: Fix CLI confusion and streamline content ## Critical Fixes ✅ - **CLI Command Syntax**: Fixed all ambiguous `SuperClaude --version` → `python3 -m SuperClaude --version` - **Architecture Clarity**: Verified dual architecture documentation (Python CLI + Context Framework) - **External Dependencies**: Marked unverified APIs as experimental (TWENTYFIRST_API_KEY, MORPH_API_KEY) - **Installation Instructions**: Clarified NPM package names with verification warnings ## Content Optimization 🗑️ - **Removed unnecessary files**: - optimization-guide.md (inappropriate for context files) - quick-start-practices.md (duplicate content) - Various outdated socratic learning components - **Updated cross-references**: Fixed all broken links to point to existing, relevant content - **Consolidated navigation**: Streamlined Reference/README.md documentation matrix ## Technical Accuracy 🎯 - **Command References**: All commands now specify exact usage context (terminal vs Claude Code) - **Framework Nature**: Consistently explains SuperClaude as context framework, not executable software - **Installation Verification**: Updated diagnostic scripts with correct Python CLI commands - **MCP Configuration**: Marked experimental services appropriately ## Impact Summary 📊 - **Files Modified**: 15+ documentation files for accuracy and consistency - **Files Removed**: 5+ unnecessary/duplicate files - **Broken Links**: 0 (all cross-references updated) - **User Clarity**: Significantly improved understanding of dual architecture Result: Professional documentation that accurately represents SuperClaude's sophisticated dual architecture (Python CLI installation system + Claude Code context framework). 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-21 19:03:25 +02:00
## How SuperClaude Really Works
📚 Major documentation cleanup: Fix CLI confusion and streamline content ## Critical Fixes ✅ - **CLI Command Syntax**: Fixed all ambiguous `SuperClaude --version` → `python3 -m SuperClaude --version` - **Architecture Clarity**: Verified dual architecture documentation (Python CLI + Context Framework) - **External Dependencies**: Marked unverified APIs as experimental (TWENTYFIRST_API_KEY, MORPH_API_KEY) - **Installation Instructions**: Clarified NPM package names with verification warnings ## Content Optimization 🗑️ - **Removed unnecessary files**: - optimization-guide.md (inappropriate for context files) - quick-start-practices.md (duplicate content) - Various outdated socratic learning components - **Updated cross-references**: Fixed all broken links to point to existing, relevant content - **Consolidated navigation**: Streamlined Reference/README.md documentation matrix ## Technical Accuracy 🎯 - **Command References**: All commands now specify exact usage context (terminal vs Claude Code) - **Framework Nature**: Consistently explains SuperClaude as context framework, not executable software - **Installation Verification**: Updated diagnostic scripts with correct Python CLI commands - **MCP Configuration**: Marked experimental services appropriately ## Impact Summary 📊 - **Files Modified**: 15+ documentation files for accuracy and consistency - **Files Removed**: 5+ unnecessary/duplicate files - **Broken Links**: 0 (all cross-references updated) - **User Clarity**: Significantly improved understanding of dual architecture Result: Professional documentation that accurately represents SuperClaude's sophisticated dual architecture (Python CLI installation system + Claude Code context framework). 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-21 19:03:25 +02:00
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.
📚 Major documentation cleanup: Fix CLI confusion and streamline content ## Critical Fixes ✅ - **CLI Command Syntax**: Fixed all ambiguous `SuperClaude --version` → `python3 -m SuperClaude --version` - **Architecture Clarity**: Verified dual architecture documentation (Python CLI + Context Framework) - **External Dependencies**: Marked unverified APIs as experimental (TWENTYFIRST_API_KEY, MORPH_API_KEY) - **Installation Instructions**: Clarified NPM package names with verification warnings ## Content Optimization 🗑️ - **Removed unnecessary files**: - optimization-guide.md (inappropriate for context files) - quick-start-practices.md (duplicate content) - Various outdated socratic learning components - **Updated cross-references**: Fixed all broken links to point to existing, relevant content - **Consolidated navigation**: Streamlined Reference/README.md documentation matrix ## Technical Accuracy 🎯 - **Command References**: All commands now specify exact usage context (terminal vs Claude Code) - **Framework Nature**: Consistently explains SuperClaude as context framework, not executable software - **Installation Verification**: Updated diagnostic scripts with correct Python CLI commands - **MCP Configuration**: Marked experimental services appropriately ## Impact Summary 📊 - **Files Modified**: 15+ documentation files for accuracy and consistency - **Files Removed**: 5+ unnecessary/duplicate files - **Broken Links**: 0 (all cross-references updated) - **User Clarity**: Significantly improved understanding of dual architecture Result: Professional documentation that accurately represents SuperClaude's sophisticated dual architecture (Python CLI installation system + Claude Code context framework). 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-21 19:03:25 +02:00
**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"
📚 Major documentation cleanup: Fix CLI confusion and streamline content ## Critical Fixes ✅ - **CLI Command Syntax**: Fixed all ambiguous `SuperClaude --version` → `python3 -m SuperClaude --version` - **Architecture Clarity**: Verified dual architecture documentation (Python CLI + Context Framework) - **External Dependencies**: Marked unverified APIs as experimental (TWENTYFIRST_API_KEY, MORPH_API_KEY) - **Installation Instructions**: Clarified NPM package names with verification warnings ## Content Optimization 🗑️ - **Removed unnecessary files**: - optimization-guide.md (inappropriate for context files) - quick-start-practices.md (duplicate content) - Various outdated socratic learning components - **Updated cross-references**: Fixed all broken links to point to existing, relevant content - **Consolidated navigation**: Streamlined Reference/README.md documentation matrix ## Technical Accuracy 🎯 - **Command References**: All commands now specify exact usage context (terminal vs Claude Code) - **Framework Nature**: Consistently explains SuperClaude as context framework, not executable software - **Installation Verification**: Updated diagnostic scripts with correct Python CLI commands - **MCP Configuration**: Marked experimental services appropriately ## Impact Summary 📊 - **Files Modified**: 15+ documentation files for accuracy and consistency - **Files Removed**: 5+ unnecessary/duplicate files - **Broken Links**: 0 (all cross-references updated) - **User Clarity**: Significantly improved understanding of dual architecture Result: Professional documentation that accurately represents SuperClaude's sophisticated dual architecture (Python CLI installation system + Claude Code context framework). 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-21 19:03:25 +02:00
# Analyze existing code
/sc:analyze src/
# Generate implementation plan
/sc:workflow "add user authentication"
📚 Major documentation cleanup: Fix CLI confusion and streamline content ## Critical Fixes ✅ - **CLI Command Syntax**: Fixed all ambiguous `SuperClaude --version` → `python3 -m SuperClaude --version` - **Architecture Clarity**: Verified dual architecture documentation (Python CLI + Context Framework) - **External Dependencies**: Marked unverified APIs as experimental (TWENTYFIRST_API_KEY, MORPH_API_KEY) - **Installation Instructions**: Clarified NPM package names with verification warnings ## Content Optimization 🗑️ - **Removed unnecessary files**: - optimization-guide.md (inappropriate for context files) - quick-start-practices.md (duplicate content) - Various outdated socratic learning components - **Updated cross-references**: Fixed all broken links to point to existing, relevant content - **Consolidated navigation**: Streamlined Reference/README.md documentation matrix ## Technical Accuracy 🎯 - **Command References**: All commands now specify exact usage context (terminal vs Claude Code) - **Framework Nature**: Consistently explains SuperClaude as context framework, not executable software - **Installation Verification**: Updated diagnostic scripts with correct Python CLI commands - **MCP Configuration**: Marked experimental services appropriately ## Impact Summary 📊 - **Files Modified**: 15+ documentation files for accuracy and consistency - **Files Removed**: 5+ unnecessary/duplicate files - **Broken Links**: 0 (all cross-references updated) - **User Clarity**: Significantly improved understanding of dual architecture Result: Professional documentation that accurately represents SuperClaude's sophisticated dual architecture (Python CLI installation system + Claude Code context framework). 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-21 19:03:25 +02:00
# Invoke specialist persona
🔧 Standardize agent invocation syntax: @agents- → @agent- ## Changes Made - **Agent Syntax Standardization**: Updated all agent invocations from `@agents-` to `@agent-` - **Consistency**: Applied change across all 14 documentation files and 1 source file - **Examples Updated**: All agent invocation examples now use singular `@agent-` format - **Pattern Recognition**: Updated references to trigger pattern documentation ## Files Updated (14 total) ### Documentation - Docs/User-Guide/commands.md - Core command reference - Docs/User-Guide/agents.md - Agent guide with all examples - Docs/README.md - Quick reference updated - Docs/Getting-Started/installation.md & quick-start.md - Setup instructions - Docs/Developer-Guide/ - Technical architecture and testing docs - Docs/Reference/ - All example files and troubleshooting ### Source Files - SuperClaude/Agents/security-engineer.md - Agent context file ## Impact ✅ **Consistent Syntax**: All agent invocations now use `@agent-[name]` format ✅ **User Clarity**: Clear distinction from previous `@agents-` plural form ✅ **Documentation Alignment**: All examples and references updated consistently ✅ **Framework Standards**: Aligns with SuperClaude naming conventions Examples now correctly show: - `@agent-security "review authentication"` - `@agent-python-expert "optimize code"` - `@agent-frontend-architect "design components"` Total replacements: 80+ instances across entire documentation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-21 19:05:51 +02:00
@agent-security "review authentication implementation"
```
📚 Major documentation cleanup: Fix CLI confusion and streamline content ## Critical Fixes ✅ - **CLI Command Syntax**: Fixed all ambiguous `SuperClaude --version` → `python3 -m SuperClaude --version` - **Architecture Clarity**: Verified dual architecture documentation (Python CLI + Context Framework) - **External Dependencies**: Marked unverified APIs as experimental (TWENTYFIRST_API_KEY, MORPH_API_KEY) - **Installation Instructions**: Clarified NPM package names with verification warnings ## Content Optimization 🗑️ - **Removed unnecessary files**: - optimization-guide.md (inappropriate for context files) - quick-start-practices.md (duplicate content) - Various outdated socratic learning components - **Updated cross-references**: Fixed all broken links to point to existing, relevant content - **Consolidated navigation**: Streamlined Reference/README.md documentation matrix ## Technical Accuracy 🎯 - **Command References**: All commands now specify exact usage context (terminal vs Claude Code) - **Framework Nature**: Consistently explains SuperClaude as context framework, not executable software - **Installation Verification**: Updated diagnostic scripts with correct Python CLI commands - **MCP Configuration**: Marked experimental services appropriately ## Impact Summary 📊 - **Files Modified**: 15+ documentation files for accuracy and consistency - **Files Removed**: 5+ unnecessary/duplicate files - **Broken Links**: 0 (all cross-references updated) - **User Clarity**: Significantly improved understanding of dual architecture Result: Professional documentation that accurately represents SuperClaude's sophisticated dual architecture (Python CLI installation system + Claude Code context framework). 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-21 19:03:25 +02:00
**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?
📚 Major documentation cleanup: Fix CLI confusion and streamline content ## Critical Fixes ✅ - **CLI Command Syntax**: Fixed all ambiguous `SuperClaude --version` → `python3 -m SuperClaude --version` - **Architecture Clarity**: Verified dual architecture documentation (Python CLI + Context Framework) - **External Dependencies**: Marked unverified APIs as experimental (TWENTYFIRST_API_KEY, MORPH_API_KEY) - **Installation Instructions**: Clarified NPM package names with verification warnings ## Content Optimization 🗑️ - **Removed unnecessary files**: - optimization-guide.md (inappropriate for context files) - quick-start-practices.md (duplicate content) - Various outdated socratic learning components - **Updated cross-references**: Fixed all broken links to point to existing, relevant content - **Consolidated navigation**: Streamlined Reference/README.md documentation matrix ## Technical Accuracy 🎯 - **Command References**: All commands now specify exact usage context (terminal vs Claude Code) - **Framework Nature**: Consistently explains SuperClaude as context framework, not executable software - **Installation Verification**: Updated diagnostic scripts with correct Python CLI commands - **MCP Configuration**: Marked experimental services appropriately ## Impact Summary 📊 - **Files Modified**: 15+ documentation files for accuracy and consistency - **Files Removed**: 5+ unnecessary/duplicate files - **Broken Links**: 0 (all cross-references updated) - **User Clarity**: Significantly improved understanding of dual architecture Result: Professional documentation that accurately represents SuperClaude's sophisticated dual architecture (Python CLI installation system + Claude Code context framework). 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-21 19:03:25 +02:00
### 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)
📚 Major documentation cleanup: Fix CLI confusion and streamline content ## Critical Fixes ✅ - **CLI Command Syntax**: Fixed all ambiguous `SuperClaude --version` → `python3 -m SuperClaude --version` - **Architecture Clarity**: Verified dual architecture documentation (Python CLI + Context Framework) - **External Dependencies**: Marked unverified APIs as experimental (TWENTYFIRST_API_KEY, MORPH_API_KEY) - **Installation Instructions**: Clarified NPM package names with verification warnings ## Content Optimization 🗑️ - **Removed unnecessary files**: - optimization-guide.md (inappropriate for context files) - quick-start-practices.md (duplicate content) - Various outdated socratic learning components - **Updated cross-references**: Fixed all broken links to point to existing, relevant content - **Consolidated navigation**: Streamlined Reference/README.md documentation matrix ## Technical Accuracy 🎯 - **Command References**: All commands now specify exact usage context (terminal vs Claude Code) - **Framework Nature**: Consistently explains SuperClaude as context framework, not executable software - **Installation Verification**: Updated diagnostic scripts with correct Python CLI commands - **MCP Configuration**: Marked experimental services appropriately ## Impact Summary 📊 - **Files Modified**: 15+ documentation files for accuracy and consistency - **Files Removed**: 5+ unnecessary/duplicate files - **Broken Links**: 0 (all cross-references updated) - **User Clarity**: Significantly improved understanding of dual architecture Result: Professional documentation that accurately represents SuperClaude's sophisticated dual architecture (Python CLI installation system + Claude Code context framework). 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-21 19:03:25 +02:00
**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
📚 Major documentation cleanup: Fix CLI confusion and streamline content ## Critical Fixes ✅ - **CLI Command Syntax**: Fixed all ambiguous `SuperClaude --version` → `python3 -m SuperClaude --version` - **Architecture Clarity**: Verified dual architecture documentation (Python CLI + Context Framework) - **External Dependencies**: Marked unverified APIs as experimental (TWENTYFIRST_API_KEY, MORPH_API_KEY) - **Installation Instructions**: Clarified NPM package names with verification warnings ## Content Optimization 🗑️ - **Removed unnecessary files**: - optimization-guide.md (inappropriate for context files) - quick-start-practices.md (duplicate content) - Various outdated socratic learning components - **Updated cross-references**: Fixed all broken links to point to existing, relevant content - **Consolidated navigation**: Streamlined Reference/README.md documentation matrix ## Technical Accuracy 🎯 - **Command References**: All commands now specify exact usage context (terminal vs Claude Code) - **Framework Nature**: Consistently explains SuperClaude as context framework, not executable software - **Installation Verification**: Updated diagnostic scripts with correct Python CLI commands - **MCP Configuration**: Marked experimental services appropriately ## Impact Summary 📊 - **Files Modified**: 15+ documentation files for accuracy and consistency - **Files Removed**: 5+ unnecessary/duplicate files - **Broken Links**: 0 (all cross-references updated) - **User Clarity**: Significantly improved understanding of dual architecture Result: Professional documentation that accurately represents SuperClaude's sophisticated dual architecture (Python CLI installation system + Claude Code context framework). 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-21 19:03:25 +02:00
**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.
📚 Major documentation cleanup: Fix CLI confusion and streamline content ## Critical Fixes ✅ - **CLI Command Syntax**: Fixed all ambiguous `SuperClaude --version` → `python3 -m SuperClaude --version` - **Architecture Clarity**: Verified dual architecture documentation (Python CLI + Context Framework) - **External Dependencies**: Marked unverified APIs as experimental (TWENTYFIRST_API_KEY, MORPH_API_KEY) - **Installation Instructions**: Clarified NPM package names with verification warnings ## Content Optimization 🗑️ - **Removed unnecessary files**: - optimization-guide.md (inappropriate for context files) - quick-start-practices.md (duplicate content) - Various outdated socratic learning components - **Updated cross-references**: Fixed all broken links to point to existing, relevant content - **Consolidated navigation**: Streamlined Reference/README.md documentation matrix ## Technical Accuracy 🎯 - **Command References**: All commands now specify exact usage context (terminal vs Claude Code) - **Framework Nature**: Consistently explains SuperClaude as context framework, not executable software - **Installation Verification**: Updated diagnostic scripts with correct Python CLI commands - **MCP Configuration**: Marked experimental services appropriately ## Impact Summary 📊 - **Files Modified**: 15+ documentation files for accuracy and consistency - **Files Removed**: 5+ unnecessary/duplicate files - **Broken Links**: 0 (all cross-references updated) - **User Clarity**: Significantly improved understanding of dual architecture Result: Professional documentation that accurately represents SuperClaude's sophisticated dual architecture (Python CLI installation system + Claude Code context framework). 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-21 19:03:25 +02:00
**Technical Architecture:**
1. **Context Loading** (Claude Code imports behavioral .md files via CLAUDE.md)
🔧 Standardize agent invocation syntax: @agents- → @agent- ## Changes Made - **Agent Syntax Standardization**: Updated all agent invocations from `@agents-` to `@agent-` - **Consistency**: Applied change across all 14 documentation files and 1 source file - **Examples Updated**: All agent invocation examples now use singular `@agent-` format - **Pattern Recognition**: Updated references to trigger pattern documentation ## Files Updated (14 total) ### Documentation - Docs/User-Guide/commands.md - Core command reference - Docs/User-Guide/agents.md - Agent guide with all examples - Docs/README.md - Quick reference updated - Docs/Getting-Started/installation.md & quick-start.md - Setup instructions - Docs/Developer-Guide/ - Technical architecture and testing docs - Docs/Reference/ - All example files and troubleshooting ### Source Files - SuperClaude/Agents/security-engineer.md - Agent context file ## Impact ✅ **Consistent Syntax**: All agent invocations now use `@agent-[name]` format ✅ **User Clarity**: Clear distinction from previous `@agents-` plural form ✅ **Documentation Alignment**: All examples and references updated consistently ✅ **Framework Standards**: Aligns with SuperClaude naming conventions Examples now correctly show: - `@agent-security "review authentication"` - `@agent-python-expert "optimize code"` - `@agent-frontend-architect "design components"` Total replacements: 80+ instances across entire documentation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-21 19:05:51 +02:00
2. **Pattern Recognition** (Recognizes /sc: and @agent- trigger patterns)
📚 Major documentation cleanup: Fix CLI confusion and streamline content ## Critical Fixes ✅ - **CLI Command Syntax**: Fixed all ambiguous `SuperClaude --version` → `python3 -m SuperClaude --version` - **Architecture Clarity**: Verified dual architecture documentation (Python CLI + Context Framework) - **External Dependencies**: Marked unverified APIs as experimental (TWENTYFIRST_API_KEY, MORPH_API_KEY) - **Installation Instructions**: Clarified NPM package names with verification warnings ## Content Optimization 🗑️ - **Removed unnecessary files**: - optimization-guide.md (inappropriate for context files) - quick-start-practices.md (duplicate content) - Various outdated socratic learning components - **Updated cross-references**: Fixed all broken links to point to existing, relevant content - **Consolidated navigation**: Streamlined Reference/README.md documentation matrix ## Technical Accuracy 🎯 - **Command References**: All commands now specify exact usage context (terminal vs Claude Code) - **Framework Nature**: Consistently explains SuperClaude as context framework, not executable software - **Installation Verification**: Updated diagnostic scripts with correct Python CLI commands - **MCP Configuration**: Marked experimental services appropriately ## Impact Summary 📊 - **Files Modified**: 15+ documentation files for accuracy and consistency - **Files Removed**: 5+ unnecessary/duplicate files - **Broken Links**: 0 (all cross-references updated) - **User Clarity**: Significantly improved understanding of dual architecture Result: Professional documentation that accurately represents SuperClaude's sophisticated dual architecture (Python CLI installation system + Claude Code context framework). 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-21 19:03:25 +02:00
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
📚 Major documentation cleanup: Fix CLI confusion and streamline content ## Critical Fixes ✅ - **CLI Command Syntax**: Fixed all ambiguous `SuperClaude --version` → `python3 -m SuperClaude --version` - **Architecture Clarity**: Verified dual architecture documentation (Python CLI + Context Framework) - **External Dependencies**: Marked unverified APIs as experimental (TWENTYFIRST_API_KEY, MORPH_API_KEY) - **Installation Instructions**: Clarified NPM package names with verification warnings ## Content Optimization 🗑️ - **Removed unnecessary files**: - optimization-guide.md (inappropriate for context files) - quick-start-practices.md (duplicate content) - Various outdated socratic learning components - **Updated cross-references**: Fixed all broken links to point to existing, relevant content - **Consolidated navigation**: Streamlined Reference/README.md documentation matrix ## Technical Accuracy 🎯 - **Command References**: All commands now specify exact usage context (terminal vs Claude Code) - **Framework Nature**: Consistently explains SuperClaude as context framework, not executable software - **Installation Verification**: Updated diagnostic scripts with correct Python CLI commands - **MCP Configuration**: Marked experimental services appropriately ## Impact Summary 📊 - **Files Modified**: 15+ documentation files for accuracy and consistency - **Files Removed**: 5+ unnecessary/duplicate files - **Broken Links**: 0 (all cross-references updated) - **User Clarity**: Significantly improved understanding of dual architecture Result: Professional documentation that accurately represents SuperClaude's sophisticated dual architecture (Python CLI installation system + Claude Code context framework). 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-21 19:03:25 +02:00
**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
🔧 Standardize agent invocation syntax: @agents- → @agent- ## Changes Made - **Agent Syntax Standardization**: Updated all agent invocations from `@agents-` to `@agent-` - **Consistency**: Applied change across all 14 documentation files and 1 source file - **Examples Updated**: All agent invocation examples now use singular `@agent-` format - **Pattern Recognition**: Updated references to trigger pattern documentation ## Files Updated (14 total) ### Documentation - Docs/User-Guide/commands.md - Core command reference - Docs/User-Guide/agents.md - Agent guide with all examples - Docs/README.md - Quick reference updated - Docs/Getting-Started/installation.md & quick-start.md - Setup instructions - Docs/Developer-Guide/ - Technical architecture and testing docs - Docs/Reference/ - All example files and troubleshooting ### Source Files - SuperClaude/Agents/security-engineer.md - Agent context file ## Impact ✅ **Consistent Syntax**: All agent invocations now use `@agent-[name]` format ✅ **User Clarity**: Clear distinction from previous `@agents-` plural form ✅ **Documentation Alignment**: All examples and references updated consistently ✅ **Framework Standards**: Aligns with SuperClaude naming conventions Examples now correctly show: - `@agent-security "review authentication"` - `@agent-python-expert "optimize code"` - `@agent-frontend-architect "design components"` Total replacements: 80+ instances across entire documentation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-21 19:05:51 +02:00
- 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
📚 Major documentation cleanup: Fix CLI confusion and streamline content ## Critical Fixes ✅ - **CLI Command Syntax**: Fixed all ambiguous `SuperClaude --version` → `python3 -m SuperClaude --version` - **Architecture Clarity**: Verified dual architecture documentation (Python CLI + Context Framework) - **External Dependencies**: Marked unverified APIs as experimental (TWENTYFIRST_API_KEY, MORPH_API_KEY) - **Installation Instructions**: Clarified NPM package names with verification warnings ## Content Optimization 🗑️ - **Removed unnecessary files**: - optimization-guide.md (inappropriate for context files) - quick-start-practices.md (duplicate content) - Various outdated socratic learning components - **Updated cross-references**: Fixed all broken links to point to existing, relevant content - **Consolidated navigation**: Streamlined Reference/README.md documentation matrix ## Technical Accuracy 🎯 - **Command References**: All commands now specify exact usage context (terminal vs Claude Code) - **Framework Nature**: Consistently explains SuperClaude as context framework, not executable software - **Installation Verification**: Updated diagnostic scripts with correct Python CLI commands - **MCP Configuration**: Marked experimental services appropriately ## Impact Summary 📊 - **Files Modified**: 15+ documentation files for accuracy and consistency - **Files Removed**: 5+ unnecessary/duplicate files - **Broken Links**: 0 (all cross-references updated) - **User Clarity**: Significantly improved understanding of dual architecture Result: Professional documentation that accurately represents SuperClaude's sophisticated dual architecture (Python CLI installation system + Claude Code context framework). 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-21 19:03:25 +02:00
**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
📚 Major documentation cleanup: Fix CLI confusion and streamline content ## Critical Fixes ✅ - **CLI Command Syntax**: Fixed all ambiguous `SuperClaude --version` → `python3 -m SuperClaude --version` - **Architecture Clarity**: Verified dual architecture documentation (Python CLI + Context Framework) - **External Dependencies**: Marked unverified APIs as experimental (TWENTYFIRST_API_KEY, MORPH_API_KEY) - **Installation Instructions**: Clarified NPM package names with verification warnings ## Content Optimization 🗑️ - **Removed unnecessary files**: - optimization-guide.md (inappropriate for context files) - quick-start-practices.md (duplicate content) - Various outdated socratic learning components - **Updated cross-references**: Fixed all broken links to point to existing, relevant content - **Consolidated navigation**: Streamlined Reference/README.md documentation matrix ## Technical Accuracy 🎯 - **Command References**: All commands now specify exact usage context (terminal vs Claude Code) - **Framework Nature**: Consistently explains SuperClaude as context framework, not executable software - **Installation Verification**: Updated diagnostic scripts with correct Python CLI commands - **MCP Configuration**: Marked experimental services appropriately ## Impact Summary 📊 - **Files Modified**: 15+ documentation files for accuracy and consistency - **Files Removed**: 5+ unnecessary/duplicate files - **Broken Links**: 0 (all cross-references updated) - **User Clarity**: Significantly improved understanding of dual architecture Result: Professional documentation that accurately represents SuperClaude's sophisticated dual architecture (Python CLI installation system + Claude Code context framework). 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-21 19:03:25 +02:00
- [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