mirror of https://github.com/SuperClaude-Org/SuperClaude_Framework.git synced 2025-12-18 02:06:36 +00:00

NomenAK 41761f405c 📚 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.5 KiB

Raw Blame History

SuperClaude Installation Guide 📦

SuperClaude installs behavioral context files that Claude Code reads to enhance its capabilities with 21 commands, 15 agents, and 6 modes. Installation takes 2-5 minutes.

Quick Start 🚀

Python (Recommended):

pip install SuperClaude
SuperClaude install

NPM:

npm install -g superclaude  # ⚠️ Verify package name exists
SuperClaude install

Development:

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

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	`@agents-[type]`	`@agents-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 superclaude  # ⚠️ Verify exact package name

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:

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

After Installation ✅

Verify Installation:

python3 -m SuperClaude --version    # Should show 4.0.0
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:*)
15 agents (@agents-*)
6 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:

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

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

Final Notes 📝

Installation Summary:

Time: 2-5 minutes typical installation
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 6 behavioral modes

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

Documentation Roadmap:

Beginner (🌱 Start Here)

Quick Start Guide - 5-minute setup
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, 15 agents, and 6 behavioral modes. Try /sc:brainstorm in Claude Code to get started.

5.5 KiB Raw Blame History