mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
Added npm Package version badge Signed-off-by: Mithun Gowda B <mithungowda.b7411@gmail.com>
70 lines
3.7 KiB
Markdown
70 lines
3.7 KiB
Markdown
# SuperClaude v4.0.0 🚀
|
|
[](https://superclaude-org.github.io/SuperClaude_Website/)
|
|
[](https://opensource.org/licenses/MIT)
|
|
[](https://pypi.org/project/SuperClaude/)
|
|
[](https://www.npmjs.com/package/@superclaude-org/superclaude)
|
|
[](https://github.com/SuperClaude-Org/SuperClaude_Framework)
|
|
[](https://github.com/SuperClaude-Org/SuperClaude_Framework/issues)
|
|
[](https://github.com/SuperClaude-Org/SuperClaude_Framework/blob/master/CONTRIBUTING.md)
|
|
[](https://github.com/SuperClaude-Org/SuperClaude_Framework/graphs/contributors)
|
|
[](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
|
|
|
|
# Via NPM (cross-platform)
|
|
npm install -g @superclaude-org/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.
|
|
|
|
[](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)
|
|
|
|
### 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)
|
|
|
|
## 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)
|