SuperClaude/README.md

134 lines
7.9 KiB
Markdown
Raw Normal View History

# SuperClaude v4.0.4 🚀
[![Website Preview](https://img.shields.io/badge/Visit-Website-blue?logo=google-chrome)](https://superclaude-org.github.io/SuperClaude_Website/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![PyPI version](https://img.shields.io/pypi/v/SuperClaude.svg)](https://pypi.org/project/SuperClaude/)
[![npm version](https://img.shields.io/npm/v/@bifrost_inc/superclaude.svg)](https://www.npmjs.com/package/@bifrost_inc/superclaude)
[![Version](https://img.shields.io/badge/version-4.0.4-blue.svg)](https://github.com/SuperClaude-Org/SuperClaude_Framework)
docs: Comprehensive documentation update for SuperClaude V4 Beta Updated all root documentation to reflect V4 Beta capabilities: Root Documentation: - VERSION: Updated to 4.0.0-beta.1 - README.md: Complete rewrite with V4 features (21 commands, 13 agents, 6 MCP servers) - ARCHITECTURE_OVERVIEW.md: Updated for V4 Beta with correct counts and new features - CHANGELOG.md: Added comprehensive V4.0.0-beta.1 release section - ROADMAP.md: Added V4 Beta current status and updated future vision - CONTRIBUTING.md: Updated architecture, testing, and contribution guidelines - SECURITY.md: Added V4 security features and version support table - MANIFEST.in: Updated to include new V4 directories - pyproject.toml: Updated URLs and description for V4 Beta User Documentation: - commands-guide.md: Updated to 21 commands with new V4 commands - superclaude-user-guide.md: Comprehensive V4 Beta features documentation - flags-guide.md: Updated with new V4 flags and agent system - installation-guide.md: V4 Beta installation including hooks system - agents-guide.md: NEW - Complete guide for 13 specialized agents - personas-guide.md: Renamed to personas-guide-v3-legacy.md Key V4 Beta Features Documented: - 21 specialized commands (added: brainstorm, reflect, save, select-tool) - 13 domain expert agents replacing persona system - 6 MCP servers (added Morphllm and Serena) - 4 Behavioral Modes (Brainstorming, Introspection, Task Management, Token Efficiency) - Session Lifecycle with cross-session persistence - Redesigned Hooks System with Python integration - SuperClaude-Lite minimal implementation - Comprehensive Templates system All documentation maintains friendly, accessible tone while accurately reflecting V4 Beta's advanced capabilities. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-05 14:44:37 +02:00
[![GitHub issues](https://img.shields.io/github/issues/SuperClaude-Org/SuperClaude_Framework)](https://github.com/SuperClaude-Org/SuperClaude_Framework/issues)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/SuperClaude-Org/SuperClaude_Framework/blob/master/CONTRIBUTING.md)
[![Contributors](https://img.shields.io/github/contributors/SuperClaude-Org/SuperClaude_Framework)](https://github.com/SuperClaude-Org/SuperClaude_Framework/graphs/contributors)
[![Website](https://img.shields.io/website?url=https://superclaude-org.github.io/SuperClaude_Website/)](https://superclaude-org.github.io/SuperClaude_Website/)
SuperClaude is a meta-programming configuration framework that transforms Claude Code into a structured development platform through behavioral instruction injection and component orchestration. It enhances Claude Code with 21 slash commands, 14 specialized agents, 6 behavioral modes, and 6 MCP server integrations for systematic workflow automation.
## Quick Start
```bash
# Via pipx (recommended for Linux/macOS)
pipx install SuperClaude && SuperClaude install
# Via pip (traditional)
pip install SuperClaude && SuperClaude install
docs: Comprehensive documentation update for SuperClaude V4 Beta Updated all root documentation to reflect V4 Beta capabilities: Root Documentation: - VERSION: Updated to 4.0.0-beta.1 - README.md: Complete rewrite with V4 features (21 commands, 13 agents, 6 MCP servers) - ARCHITECTURE_OVERVIEW.md: Updated for V4 Beta with correct counts and new features - CHANGELOG.md: Added comprehensive V4.0.0-beta.1 release section - ROADMAP.md: Added V4 Beta current status and updated future vision - CONTRIBUTING.md: Updated architecture, testing, and contribution guidelines - SECURITY.md: Added V4 security features and version support table - MANIFEST.in: Updated to include new V4 directories - pyproject.toml: Updated URLs and description for V4 Beta User Documentation: - commands-guide.md: Updated to 21 commands with new V4 commands - superclaude-user-guide.md: Comprehensive V4 Beta features documentation - flags-guide.md: Updated with new V4 flags and agent system - installation-guide.md: V4 Beta installation including hooks system - agents-guide.md: NEW - Complete guide for 13 specialized agents - personas-guide.md: Renamed to personas-guide-v3-legacy.md Key V4 Beta Features Documented: - 21 specialized commands (added: brainstorm, reflect, save, select-tool) - 13 domain expert agents replacing persona system - 6 MCP servers (added Morphllm and Serena) - 4 Behavioral Modes (Brainstorming, Introspection, Task Management, Token Efficiency) - Session Lifecycle with cross-session persistence - Redesigned Hooks System with Python integration - SuperClaude-Lite minimal implementation - Comprehensive Templates system All documentation maintains friendly, accessible tone while accurately reflecting V4 Beta's advanced capabilities. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-05 14:44:37 +02:00
# Via NPM (cross-platform)
npm install -g @bifrost_inc/superclaude && superclaude install
# If you get PEP 668 errors, use one of these:
pipx install SuperClaude # Recommended
pip install --user SuperClaude # User install
pip install --break-system-packages SuperClaude # Force (use with caution)
```
## 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.
[![Ko-fi](https://img.shields.io/badge/Ko--fi-Support%20Me-ff5e5b?style=for-the-badge&logo=ko-fi)](https://ko-fi.com/superclaude)
[![Patreon](https://img.shields.io/badge/Patreon-Become%20a%20Patron-f96854?style=for-the-badge&logo=patreon)](https://patreon.com/superclaude)
[![GitHub Sponsors](https://img.shields.io/badge/GitHub-Sponsor-30363D?style=for-the-badge&logo=github-sponsors)](https://github.com/sponsors/SuperClaude-Org)
**What your support covers:**
- Claude Max subscription for testing and validation ($100/month)
- Development time for new features and bug fixes
- Documentation and example creation
- Community support and issue responses
- MCP server integration testing
- Infrastructure and hosting costs
No pressure though - the framework stays open source regardless. Just knowing people use and appreciate it is motivating. If you can't support financially, contributing code, documentation, or just spreading the word helps too.
Every contributor matters, whether through code, feedback, or support. Thanks for being part of this community! 🙏
## What's New in V4
Version 4 brings significant improvements based on community feedback and real-world usage patterns.
### 🤖 Smarter Agent System
We've expanded to 14 specialized agents that actually know their domains. The security engineer catches real vulnerabilities, the frontend architect understands modern UI patterns, and they coordinate automatically based on what you're working on. No more generic advice - you get domain expertise when you need it.
### 📝 Namespace That Makes Sense
All commands now use `/sc:` prefix to avoid stepping on your custom commands. Simple change, but it matters when you're managing multiple command sets. The 21 commands cover the full development lifecycle from brainstorming to deployment.
### 🔧 MCP Servers That Actually Help
Six integrated MCP servers provide real capabilities:
- **Context7** for up-to-date documentation
- **Sequential** for complex analysis and problem-solving
- **Magic** for UI component generation
- **Playwright** for browser testing
- **Morphllm** for bulk code transformations
- **Serena** for session persistence
These aren't just wrappers; they're properly integrated tools that work together.
### 🎯 Behavioral Modes for Different Contexts
Five modes adjust Claude's approach based on what you're doing. Brainstorming mode asks the right questions, orchestration mode coordinates tools efficiently, token-efficiency mode reduces context usage by 30-50%. It adapts to your workflow, not the other way around.
### ⚡ Smaller Framework, Bigger Projects
We've cut the framework's footprint significantly. Less framework overhead at Claude Code startup means more context available for your actual work. The entire V4 framework uses fewer tokens to load, leaving you with more room for your codebase, longer conversations, and complex operations. It's simple math - smaller framework = larger available context for what matters.
### 📚 Complete Documentation Overhaul
We've rebuilt the docs from scratch based on what developers actually need. Every guide now includes real examples, common pitfalls, and practical workflows. The whole documentation set got restructured for better navigation - you'll find what you need faster. If something's unclear or missing, let us know. Seriously, we want the docs to be genuinely helpful, not just technically complete.
## Documentation
### Getting Started
- [Quick Start Guide](Docs/Getting-Started/quick-start.md)
- [Installation Guide](Docs/Getting-Started/installation.md)
### User Guides
- [Commands Reference](Docs/User-Guide/commands.md)
- [Agents Guide](Docs/User-Guide/agents.md)
- [Behavioral Modes](Docs/User-Guide/modes.md)
- [Flags Guide](Docs/User-Guide/flags.md)
- [MCP Servers](Docs/User-Guide/mcp-servers.md)
- [Session Management](Docs/User-Guide/session-management.md)
docs: Comprehensive documentation update for SuperClaude V4 Beta Updated all root documentation to reflect V4 Beta capabilities: Root Documentation: - VERSION: Updated to 4.0.0-beta.1 - README.md: Complete rewrite with V4 features (21 commands, 13 agents, 6 MCP servers) - ARCHITECTURE_OVERVIEW.md: Updated for V4 Beta with correct counts and new features - CHANGELOG.md: Added comprehensive V4.0.0-beta.1 release section - ROADMAP.md: Added V4 Beta current status and updated future vision - CONTRIBUTING.md: Updated architecture, testing, and contribution guidelines - SECURITY.md: Added V4 security features and version support table - MANIFEST.in: Updated to include new V4 directories - pyproject.toml: Updated URLs and description for V4 Beta User Documentation: - commands-guide.md: Updated to 21 commands with new V4 commands - superclaude-user-guide.md: Comprehensive V4 Beta features documentation - flags-guide.md: Updated with new V4 flags and agent system - installation-guide.md: V4 Beta installation including hooks system - agents-guide.md: NEW - Complete guide for 13 specialized agents - personas-guide.md: Renamed to personas-guide-v3-legacy.md Key V4 Beta Features Documented: - 21 specialized commands (added: brainstorm, reflect, save, select-tool) - 13 domain expert agents replacing persona system - 6 MCP servers (added Morphllm and Serena) - 4 Behavioral Modes (Brainstorming, Introspection, Task Management, Token Efficiency) - Session Lifecycle with cross-session persistence - Redesigned Hooks System with Python integration - SuperClaude-Lite minimal implementation - Comprehensive Templates system All documentation maintains friendly, accessible tone while accurately reflecting V4 Beta's advanced capabilities. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-05 14:44:37 +02:00
### Developer Resources
- [Technical Architecture](Docs/Developer-Guide/technical-architecture.md)
- [Contributing Code](Docs/Developer-Guide/contributing-code.md)
- [Testing & Debugging](Docs/Developer-Guide/testing-debugging.md)
### Reference
- [Quick Start Practices](Docs/Reference/quick-start-practices.md)
- [Examples Cookbook](Docs/Reference/examples-cookbook.md)
- [Troubleshooting](Docs/Reference/troubleshooting.md)
docs: Comprehensive documentation update for SuperClaude V4 Beta Updated all root documentation to reflect V4 Beta capabilities: Root Documentation: - VERSION: Updated to 4.0.0-beta.1 - README.md: Complete rewrite with V4 features (21 commands, 13 agents, 6 MCP servers) - ARCHITECTURE_OVERVIEW.md: Updated for V4 Beta with correct counts and new features - CHANGELOG.md: Added comprehensive V4.0.0-beta.1 release section - ROADMAP.md: Added V4 Beta current status and updated future vision - CONTRIBUTING.md: Updated architecture, testing, and contribution guidelines - SECURITY.md: Added V4 security features and version support table - MANIFEST.in: Updated to include new V4 directories - pyproject.toml: Updated URLs and description for V4 Beta User Documentation: - commands-guide.md: Updated to 21 commands with new V4 commands - superclaude-user-guide.md: Comprehensive V4 Beta features documentation - flags-guide.md: Updated with new V4 flags and agent system - installation-guide.md: V4 Beta installation including hooks system - agents-guide.md: NEW - Complete guide for 13 specialized agents - personas-guide.md: Renamed to personas-guide-v3-legacy.md Key V4 Beta Features Documented: - 21 specialized commands (added: brainstorm, reflect, save, select-tool) - 13 domain expert agents replacing persona system - 6 MCP servers (added Morphllm and Serena) - 4 Behavioral Modes (Brainstorming, Introspection, Task Management, Token Efficiency) - Session Lifecycle with cross-session persistence - Redesigned Hooks System with Python integration - SuperClaude-Lite minimal implementation - Comprehensive Templates system All documentation maintains friendly, accessible tone while accurately reflecting V4 Beta's advanced capabilities. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-05 14:44:37 +02:00
## Contributing
**Current Priorities:**
- 📝 Documentation improvements and examples
- 🔧 MCP server integrations and configurations
- 🎯 Command workflow examples and patterns
- 🧪 Testing and validation procedures
- 🌐 Translation and internationalization
See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed contribution guidelines.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
**Contributors:** [View all contributors](https://github.com/SuperClaude-Org/SuperClaude_Framework/graphs/contributors)
## Star History
<a href="https://www.star-history.com/#SuperClaude-Org/SuperClaude_Framework&Date">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Date" />
</picture>
</a>
---