mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
fdfb05e981
* The -i flag has been removed from the `_run_command_cross_platform` function in `setup/components/mcp.py`. * fix: Prevent installer from hanging during MCP installation The SuperClaude installer was hanging during the installation of MCP components on non-Windows systems. This was caused by the use of an interactive shell (`-i`) when executing the `claude mcp add` command. The interactive shell would attempt to read from standard input, causing the process to be suspended by the shell. This commit fixes the issue by removing the `-i` flag from the `_run_command_cross_platform` function in `setup/components/mcp.py`. This ensures that the installation process runs non-interactively and completes without hanging. * fix: Add 'cmd /c' for Windows and refactor shell execution This commit resolves an issue with `npx` command execution on Windows by prepending `cmd /c` to the command. It also refactors the shell command execution for non-Windows systems to use the `executable` argument in `subprocess.run` for a cleaner and more robust implementation. * fix: Add 'cmd /c' for Windows and refactor shell execution This commit resolves an issue with `npx` command execution on Windows by prepending `cmd /c` to the command. It also refactors the shell command execution for non-Windows systems to use the `executable` argument in `subprocess.run` for a cleaner and more robust implementation. * docs: Update Chrome DevTools MCP documentation This commit updates the documentation for the Chrome DevTools MCP server to be more comprehensive and consistent with the existing documentation structure. The file `SuperClaude/MCP/MCP_Chrome-DevTools.md` has been updated with detailed information about the server's purpose, triggers, and usage examples. * docs: Update documentation for Chrome DevTools MCP This commit updates the main README.md and the MCP servers user guide to include information about the new Chrome DevTools MCP server. The documentation has been updated to reflect the new server count and provide details about the new server's functionality. * chore: Bump version to 4.1.5 This commit updates the version number from 4.1.4 to 4.1.5 across the entire codebase. This includes updates to: - CHANGELOG.md - Documentation files - Configuration files (package.json, pyproject.toml) - Source code fallbacks - The main VERSION file --------- Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
SuperClaude Documentation
🎯 Essential Understanding
SuperClaude is a Context Framework for Claude Code - it installs behavioral instruction files that Claude Code reads to enhance its capabilities.
How It Works
- Installation: Python CLI installs context files to
~/.claude/ - Commands: Type
/sc:analyze→ Claude Code readsanalyze.mdinstruction file - Behavior: Claude adopts behaviors defined in context files
- Result: Enhanced development workflows through context switching
🚀 Quick Start (5 Minutes)
New Users: Quick Start Guide →
# Recommended for Linux/macOS
pipx install SuperClaude && SuperClaude install
# Traditional method
pip install SuperClaude && SuperClaude install
# Then try: /sc:brainstorm "web app idea" in Claude Code
Having Issues: Quick Fixes → | Troubleshooting →
📚 Documentation Structure
🌱 Start Here (New Users)
| Guide | Purpose |
|---|---|
| Quick Start | Setup and first commands |
| Installation | Detailed setup instructions |
| Commands Guide | All 21 /sc: commands |
🌿 Daily Usage (Regular Users)
| Guide | Purpose | Use For |
|---|---|---|
| Commands Guide | Master all /sc: commands |
Daily development |
| Agents Guide | 14 domain specialists (@agent-*) |
Expert assistance |
| Flags Guide | Command behavior modification | Optimization |
| Modes Guide | 5 behavioral modes | Workflow optimization |
🌲 Reference & Advanced (Power Users)
| Guide | Purpose | Use For |
|---|---|---|
| Troubleshooting | Problem resolution | When things break |
| Examples Cookbook | Practical usage patterns | Learning workflows |
| MCP Servers | 6 enhanced capabilities | Advanced features |
🔧 Development & Contributing
| Guide | Purpose | Audience |
|---|---|---|
| Technical Architecture | System design | Contributors |
| Contributing | Development workflow | Developers |
🔑 Key Concepts
What Gets Installed
- Python CLI Tool - Manages framework installation
- Context Files -
.mdbehavioral instructions in~/.claude/ - MCP Configurations - Optional external tool settings
Framework Components
- 21 Commands (
/sc:*) - Workflow automation patterns - 14 Agents (
@agent-*) - Domain specialists - 5 Modes - Behavioral modification patterns
- 6 MCP Servers - Optional external tools
🚀 Quick Command Reference
In Your Terminal (Installation)
# Install framework (choose one)
pipx install SuperClaude # Recommended for Linux/macOS
pip install SuperClaude # Traditional method
npm install -g @bifrost_inc/superclaude # Cross-platform
# Configure and maintain
SuperClaude install # Configure Claude Code
SuperClaude update # Update framework
python3 -m SuperClaude --version # Check installation
In Claude Code (Usage)
/sc:brainstorm "project idea" # Start new project
/sc:implement "feature" # Build features
/sc:analyze src/ # Analyze code
@agent-python-expert "optimize this" # Manual specialist
@agent-security "review authentication" # Security review
📊 Framework vs Software Comparison
| Component | Type | Where It Runs | What It Does |
|---|---|---|---|
| SuperClaude Framework | Context Files | Read by Claude Code | Modifies AI behavior |
| Claude Code | Software | Your computer | Executes everything |
| MCP Servers | Software | Node.js processes | Provide tools |
| Python CLI | Software | Python runtime | Manages installation |
🔄 How Everything Connects
User Input → Claude Code → Reads SuperClaude Context → Modified Behavior → Enhanced Output
↓
May use MCP Servers
(if configured)
🆘 Getting Help
Quick Issues (< 2 min): Common Issues →
Complex Problems: Full Troubleshooting Guide →
Installation Issues: Installation Guide →
Command Help: Commands Guide →
Community Support: GitHub Discussions
🤔 Common Misconceptions Clarified
❌ "SuperClaude is an AI assistant"
✅ SuperClaude is a configuration framework that enhances Claude Code
❌ "I'm running SuperClaude"
✅ You're running Claude Code with SuperClaude context loaded
❌ "Claude Code executes; SuperClaude provides context my commands"
✅ Claude Code executes everything; SuperClaude provides the instructions
❌ "The .md files are documentation"
✅ The .md files ARE the framework - active instruction sets
Remember: SuperClaude enhances Claude Code through context - it doesn't replace it or run alongside it. Everything happens within Claude Code itself.