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

Version License PRs Welcome

Website PyPI npm

English δΈ­ζ–‡ ζ—₯本θͺž

Quick Start β€’ Support β€’ Features β€’ Docs β€’ Contributing

---
## πŸ“Š **Framework Statistics** | **Commands** | **Agents** | **Modes** | **MCP Servers** | |:------------:|:----------:|:---------:|:---------------:| | **22** | **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?logo=ko-fi)](https://ko-fi.com/superclaude) *One-time contributions* ### 🎯 **Patreon** [![Patreon](https://img.shields.io/badge/Become_a-Patron-f96854?logo=patreon)](https://patreon.com/superclaude) *Monthly support* ### πŸ’œ **GitHub** [![GitHub Sponsors](https://img.shields.io/badge/GitHub-Sponsor-30363D?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 - 22 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** **6 adaptive modes** for different contexts: - **Brainstorming** β†’ Asks right questions - **Business Panel** β†’ Multi-expert strategic analysis - **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 22 slash commands* - πŸ€– [**Agents Guide**](Docs/User-Guide/agents.md) *14 specialized agents* - 🎨 [**Behavioral Modes**](Docs/User-Guide/modes.md) *5 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 ↑