# ๐Ÿš€ SuperClaude Framework ### **Transform Claude Code into a Structured Development Platform**

Version License PRs Welcome

Website PyPI npm

Quick Start โ€ข Support โ€ข Features โ€ข Docs โ€ข Contributing

---
## ๐Ÿ“Š **Framework Statistics** | **Commands** | **Agents** | **Modes** | **MCP Servers** | |:------------:|:----------:|:---------:|:---------------:| | **21** | **14** | **6** | **6** | | Slash Commands | Specialized AI | Behavioral | Integrations |
---
## ๐ŸŽฏ **Overview** SuperClaude is a **meta-programming configuration framework** that transforms Claude Code into a structured development platform through behavioral instruction injection and component orchestration. It provides systematic workflow automation with powerful tools and intelligent agents. ## โšก **Quick Installation** ### **Choose Your Installation Method** | Method | Command | Best For | |:------:|---------|----------| | **๐Ÿ pipx** | `pipx install SuperClaude && pipx upgrade SuperClaude && SuperClaude install` | **โœ… Recommended** - Linux/macOS | | **๐Ÿ“ฆ pip** | `pip install SuperClaude && pip upgrade SuperClaude && SuperClaude install` | Traditional Python environments | | **๐ŸŒ npm** | `npm install -g @bifrost_inc/superclaude && superclaude install` | Cross-platform, Node.js users |
โš ๏ธ IMPORTANT: Upgrading from SuperClaude V3 **If you have SuperClaude V3 installed, you SHOULD uninstall it before installing V4:** ```bash # Uninstall V3 first Remove all related files and directories : *.md *.json and commands/ # Then install V4 pipx install SuperClaude && pipx upgrade SuperClaude && SuperClaude install ``` **โœ… What gets preserved during upgrade:** - โœ“ Your custom slash commands (outside `commands/sc/`) - โœ“ Your custom content in `CLAUDE.md` - โœ“ Claude Code's `.claude.json`, `.credentials.json`, `settings.json` and `settings.local.json` - โœ“ Any custom agents and files you've added **โš ๏ธ Note:** Other SuperClaude-related `.json` files from V3 may cause conflicts and should be removed.
๐Ÿ’ก Troubleshooting PEP 668 Errors ```bash # Option 1: Use pipx (Recommended) pipx install SuperClaude # Option 2: User installation pip install --user SuperClaude # Option 3: Force installation (use with caution) pip install --break-system-packages SuperClaude ```
---
## ๐Ÿ’– **Support the Project** > Hey, let's be real - maintaining SuperClaude takes time and resources. > > *The Claude Max subscription alone runs $100/month for testing, and that's before counting the hours spent on documentation, bug fixes, and feature development.* > *If you're finding value in SuperClaude for your daily work, consider supporting the project.* > *Even a few dollars helps cover the basics and keeps development active.* > > Every contributor matters, whether through code, feedback, or support. Thanks for being part of this community! ๐Ÿ™
### โ˜• **Ko-fi** [![Ko-fi](https://img.shields.io/badge/Support_on-Ko--fi-ff5e5b?style=for-the-badge&logo=ko-fi)](https://ko-fi.com/superclaude) *One-time contributions* ### ๐ŸŽฏ **Patreon** [![Patreon](https://img.shields.io/badge/Become_a-Patron-f96854?style=for-the-badge&logo=patreon)](https://patreon.com/superclaude) *Monthly support* ### ๐Ÿ’œ **GitHub** [![GitHub Sponsors](https://img.shields.io/badge/GitHub-Sponsor-30363D?style=for-the-badge&logo=github-sponsors)](https://github.com/sponsors/SuperClaude-Org) *Flexible tiers*
### **Your Support Enables:** | Item | Cost/Impact | |------|-------------| | ๐Ÿ”ฌ **Claude Max Testing** | $100/month for validation & testing | | โšก **Feature Development** | New capabilities & improvements | | ๐Ÿ“š **Documentation** | Comprehensive guides & examples | | ๐Ÿค **Community Support** | Quick issue responses & help | | ๐Ÿ”ง **MCP Integration** | Testing new server connections | | ๐ŸŒ **Infrastructure** | Hosting & deployment costs | > **Note:** No pressure though - the framework stays open source regardless. Just knowing people use and appreciate it is motivating. Contributing code, documentation, or spreading the word helps too! ๐Ÿ™
---
## ๐ŸŽ‰ **What's New in V4** > *Version 4 brings significant improvements based on community feedback and real-world usage patterns.*
### ๐Ÿค– **Smarter Agent System** **14 specialized agents** with domain expertise: - Security engineer catches real vulnerabilities - Frontend architect understands UI patterns - Automatic coordination based on context - Domain-specific expertise on demand ### ๐Ÿ“ **Improved Namespace** **`/sc:` prefix** for all commands: - No conflicts with custom commands - 21 commands covering full lifecycle - From brainstorming to deployment - Clean, organized command structure
### ๐Ÿ”ง **MCP Server Integration** **6 powerful servers** working together: - **Context7** โ†’ Up-to-date documentation - **Sequential** โ†’ Complex analysis - **Magic** โ†’ UI component generation - **Playwright** โ†’ Browser testing - **Morphllm** โ†’ Bulk transformations - **Serena** โ†’ Session persistence ### ๐ŸŽฏ **Behavioral Modes** **5 adaptive modes** for different contexts: - **Brainstorming** โ†’ Asks right questions - **Orchestration** โ†’ Efficient tool coordination - **Token-Efficiency** โ†’ 30-50% context savings - **Task Management** โ†’ Systematic organization - **Introspection** โ†’ Meta-cognitive analysis
### โšก **Optimized Performance** **Smaller framework, bigger projects:** - Reduced framework footprint - More context for your code - Longer conversations possible - Complex operations enabled ### ๐Ÿ“š **Documentation Overhaul** **Complete rewrite** for developers: - Real examples & use cases - Common pitfalls documented - Practical workflows included - Better navigation structure
---
## ๐Ÿ“š **Documentation** ### **Complete Guide to SuperClaude**
๐Ÿš€ Getting Started ๐Ÿ“– User Guides ๐Ÿ› ๏ธ Developer Resources ๐Ÿ“‹ Reference
- ๐Ÿ“ [**Quick Start Guide**](Docs/Getting-Started/quick-start.md) *Get up and running fast* - ๐Ÿ’พ [**Installation Guide**](Docs/Getting-Started/installation.md) *Detailed setup instructions* - ๐ŸŽฏ [**Commands Reference**](Docs/User-Guide/commands.md) *All 21 slash commands* - ๐Ÿค– [**Agents Guide**](Docs/User-Guide/agents.md) *14 specialized agents* - ๐ŸŽจ [**Behavioral Modes**](Docs/User-Guide/modes.md) *6 adaptive modes* - ๐Ÿšฉ [**Flags Guide**](Docs/User-Guide/flags.md) *Control behaviors* - ๐Ÿ”ง [**MCP Servers**](Docs/User-Guide/mcp-servers.md) *6 server integrations* - ๐Ÿ’ผ [**Session Management**](Docs/User-Guide/session-management.md) *Save & restore state* - ๐Ÿ—๏ธ [**Technical Architecture**](Docs/Developer-Guide/technical-architecture.md) *System design details* - ๐Ÿ’ป [**Contributing Code**](Docs/Developer-Guide/contributing-code.md) *Development workflow* - ๐Ÿงช [**Testing & Debugging**](Docs/Developer-Guide/testing-debugging.md) *Quality assurance* - โœจ [**Best Practices**](Docs/Reference/quick-start-practices.md) *Pro tips & patterns* - ๐Ÿ““ [**Examples Cookbook**](Docs/Reference/examples-cookbook.md) *Real-world recipes* - ๐Ÿ” [**Troubleshooting**](Docs/Reference/troubleshooting.md) *Common issues & fixes*
---
## ๐Ÿค **Contributing** ### **Join the SuperClaude Community** We welcome contributions of all kinds! Here's how you can help: | Priority | Area | Description | |:--------:|------|-------------| | ๐Ÿ“ **High** | Documentation | Improve guides, add examples, fix typos | | ๐Ÿ”ง **High** | MCP Integration | Add server configs, test integrations | | ๐ŸŽฏ **Medium** | Workflows | Create command patterns & recipes | | ๐Ÿงช **Medium** | Testing | Add tests, validate features | | ๐ŸŒ **Low** | i18n | Translate docs to other languages |

Contributing Guide Contributors

---
## โš–๏ธ **License** This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.

MIT License

---
## โญ **Star History** Star History Chart
---
### **๐Ÿš€ Built with passion by the SuperClaude community**

Made with โค๏ธ for developers who push boundaries

Back to Top โ†‘