SuperClaude/README.md

69 lines
3.5 KiB
Markdown
Raw Normal View History

# SuperClaude v4.0.0 🚀
[![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/)
[![Version](https://img.shields.io/badge/version-4.0.0-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, 13 specialized agents, 6 behavioral modes, and 6 MCP server integrations for systematic workflow automation.
## Quick Start
```bash
# Via Python (recommended)
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 superclaude && superclaude install
```
## Support SuperClaude Development 💎
SuperClaude Framework development requires ongoing support to maintain MCP server integrations, expand the command system, and provide comprehensive documentation. Your support enables continuous improvement and new capabilities.
[![GitHub Sponsors](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#white)](https://github.com/sponsors/SuperClaude-Org)
## 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)