SuperClaude/Docs/Getting-Started/installation.md

SuperClaude Installation Guide 📦

SuperClaude installs behavioral context files that Claude Code reads to enhance its capabilities with 21 commands, 14 agents, and 5 modes.

Quick Start 🚀

pipx (Recommended for Linux/macOS):

pipx install SuperClaude
SuperClaude install

pip (Traditional):

pip install SuperClaude
SuperClaude install

NPM (Cross-platform):

npm install -g @bifrost_inc/superclaude
SuperClaude install

Development:

git clone https://github.com/SuperClaude-Org/SuperClaude_Framework.git
cd SuperClaude_Framework
pip install -e ".[dev]"
SuperClaude install --dry-run

If you encounter PEP 668 errors:

# Option 1: Use pipx (recommended)
pipx install SuperClaude

# Option 2: Use pip with --user flag
pip install --user SuperClaude

# Option 3: Force installation (use with caution)
pip install --break-system-packages SuperClaude

Command Types

Type	Where Used	Format	Example
Installation	Terminal	SuperClaude [command]	SuperClaude install
Slash Commands	Claude Code	/sc:[command]	/sc:brainstorm "idea"
Agents	Claude Code	@agent-[type]	@agent-security "review"

Requirements

Required:

• Python 3.8+ with pip
• Claude Code installed and working
• 50MB free space

Optional:

• Node.js 16+ (for MCP servers)
• Git (for version control integration)

Quick Check

python3 --version    # Should be 3.8+
claude --version     # Verify Claude Code
node --version       # Optional: for MCP servers

Installation Options 🎛️

Interactive Installation (Default):

SuperClaude install

With Options:

SuperClaude install --components core mcp modes  # Specific components
SuperClaude install --dry-run                    # Preview only
SuperClaude install --force --yes                # Skip confirmations

Getting SuperClaude 📥

Choose Your Preferred Method:

Python Users:

pip install SuperClaude

JavaScript/Node.js Users:

npm install -g @bifrost_inc/superclaude

Development/Contributors:

git clone https://github.com/SuperClaude-Org/SuperClaude_Framework.git
cd SuperClaude_Framework
pip install -e ".[dev]"

Running the Installer 🎬

Interactive Installation (Default):

SuperClaude install

The installer will:

1. Validate system requirements
2. Show available components
3. Install selected components to ~/.claude/
4. Configure MCP servers if selected
5. Update CLAUDE.md with framework imports

After Installation ✅

Verify Installation:

python3 -m SuperClaude --version    # Should show 4.0.4
SuperClaude install --list-components

Test Commands:

# In Claude Code, try:
/sc:brainstorm "test project"    # Should ask discovery questions
/sc:analyze README.md           # Should provide analysis

What's Installed:

• Framework files in ~/.claude/
• 21 slash commands (/sc:*)
• 14 agents (@agent-*)
• 5 behavioral modes
• MCP server configurations (if selected)

Managing Your Installation 🛠️

Update:

pip install --upgrade SuperClaude
SuperClaude update

Backup & Restore:

SuperClaude backup --create
SuperClaude backup --restore ~/.claude.backup.YYYYMMDD_HHMMSS

Uninstall:

SuperClaude uninstall
pip uninstall SuperClaude

Troubleshooting 🔧

Common Issues:

• Command not found: Verify installation with python3 -m SuperClaude --version
• Permission denied: Use pip install --user SuperClaude
• Claude Code not found: Install from https://claude.ai/code

Get Help:

• Troubleshooting Guide
• GitHub Issues

Next Steps 🚀

• Quick Start Guide - First commands and workflows
• Commands Reference - All 21 commands
• Examples Cookbook - Real-world usage

Prerequisites Setup 🛠️

Missing Python?

# Linux: sudo apt install python3 python3-pip
# macOS: brew install python3
# Windows: Download from python.org

Missing Claude Code?

• Download from https://claude.ai/code
• Verify with: claude --version

What's Next? 🚀

1. Quick Start Guide - Essential workflows
2. Commands Reference - All 21 commands
3. Examples Cookbook - Real-world usage

---

Final Notes 📝

Installation Summary:

• Space: 50MB for full installation
• Requirements: Python 3.8+, Claude Code, 1GB RAM recommended
• Platform: Linux, macOS, Windows supported
• Usage: Immediate access to 21 commands and 5 behavioral modes

What's Next: Your Claude Code now has enhanced capabilities. Try /sc:brainstorm for your first SuperClaude experience!

---

Related Guides

Documentation Roadmap:

Beginner (🌱 Start Here)

• Quick Start Guide - quick setup guide
• Commands Reference - Basic usage

Intermediate (🌿 Growing)

• Behavioral Modes - Context optimization
• MCP Servers - Enhanced capabilities
• Examples Cookbook - Practical patterns

Advanced (🌲 Expert)

• Technical Architecture - System design
• Contributing Code - Development
• Quick Start Guide - Essential workflows

---

Installation Complete! You now have access to 21 commands, 14 agents, and 5 behavioral modes. Try /sc:brainstorm in Claude Code to get started.