mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
* Fix: Install only selected MCP servers and ensure valid empty backups This commit addresses two separate issues: 1. **MCP Installation:** The `install` command was installing all MCP servers instead of only the ones selected by the user. The `_install` method in `setup/components/mcp.py` was iterating through all available servers, not the user's selection. This has been fixed to respect the `selected_mcp_servers` configuration. A new test has been added to verify this fix. 2. **Backup Creation:** The `create_backup` method in `setup/core/installer.py` created an invalid `.tar.gz` file when the backup source was empty. This has been fixed to ensure that a valid, empty tar archive is always created. A test was added for this as well. Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com> Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com> * Fix: Correct installer validation for MCP and MCP Docs components This commit fixes a validation issue in the installer where it would incorrectly fail after a partial installation of MCP servers. The `MCPComponent` validation logic was checking for all "required" servers, regardless of whether they were selected by the user. This has been corrected to only validate the servers that were actually installed, by checking against the list of installed servers stored in the metadata. The metadata storage has also been fixed to only record the installed servers. The `MCPDocsComponent` was failing validation because it was not being registered in the metadata if no documentation files were installed. This has been fixed by ensuring the post-installation hook runs even when no files are copied. New tests have been added for both components to verify the corrected logic. Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com> Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com> * Fix: Allow re-installation of components and correct validation logic This commit fixes a bug that prevented new MCP servers from being installed on subsequent runs of the installer. It also fixes the validation logic that was causing failures after a partial installation. The key changes are: 1. A new `is_reinstallable` method has been added to the base `Component` class. This allows certain components (like the `mcp` component) to be re-run even if they are already marked as installed. 2. The installer logic has been updated to respect this new method. 3. The `MCPComponent` now correctly stores only the installed servers in the metadata. 4. The validation logic for `MCPComponent` and `MCPDocsComponent` has been corrected to prevent incorrect failures. New tests have been added to verify all aspects of the new logic. Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com> Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com> * feat: Display authors in UI header and update author info This commit implements the user's request to display author names and emails in the UI header of the installer. The key changes are: 1. The `__email__` field in `SuperClaude/__init__.py` has been updated to include both authors' emails. 2. The `display_header` function in `setup/utils/ui.py` has been modified to read the author and email information and display it. 3. A new test has been added to `tests/test_ui.py` to verify the new UI output. Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com> Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com> * feat: Version bump to 4.1.0 and various fixes This commit prepares the project for the v4.1.0 release. It includes a version bump across all relevant files and incorporates several bug fixes and feature enhancements from recent tasks. Key changes in this release: - **Version Bump**: The project version has been updated from 4.0.9 to 4.1.0 in all configuration files, documentation, and source code. - **Installer Fixes**: - Components can now be marked as `reinstallable`, allowing them to be re-run on subsequent installations. This fixes a bug where new MCP servers could not be added. - The validation logic for `mcp` and `mcp_docs` components has been corrected to avoid incorrect failures. - A bug in the backup creation process that created invalid empty archives has been fixed. - **UI Enhancements**: - Author names and emails are now displayed in the installer UI header. - **Metadata Updates**: - Mithun Gowda B has been added as an author. - **New Tests**: - Comprehensive tests have been added for the installer logic, MCP components, and UI changes to ensure correctness and prevent regressions. Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com> Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com> * fix: Resolve dependencies for partial installs and other fixes This commit addresses several issues, the main one being a dependency resolution failure during partial installations. Key changes: - **Dependency Resolution**: The installer now correctly resolves the full dependency tree when a user requests to install a subset of components. This fixes the "Unknown component: core" error. - **Component Re-installation**: A new `is_reinstallable` flag allows components like `mcp` to be re-run on subsequent installs, enabling the addition of new servers. - **Validation Logic**: The validation for `mcp` and `mcp_docs` has been corrected to avoid spurious failures. - **UI and Metadata**: Author information has been added to the UI header and source files. - **Version Bump**: The project version has been updated to 4.1.0. - **Tests**: New tests have been added to cover all the above changes. Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com> Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com> * fix: Installer fixes and version bump to 4.1.0 This commit includes a collection of fixes for the installer logic, UI enhancements, and a version bump to 4.1.0. Key changes: - **Dependency Resolution**: The installer now correctly resolves the full dependency tree for partial installations, fixing the "Unknown component: core" error. - **Component Re-installation**: A new `is_reinstallable` flag allows components like `mcp` to be re-run to add new servers. - **MCP Installation**: The non-interactive installation of the `mcp` component now correctly prompts the user to select servers. - **Validation Logic**: The post-installation validation logic has been corrected to only validate components from the current session and to use the correct list of installed servers. - **UI & Metadata**: Author information has been added to the UI and source files. - **Version Bump**: The project version has been updated from 4.0.9 to 4.1.0 across all files. - **Tests**: New tests have been added to cover all the bug fixes. Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com> Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com> * feat: Add --authors flag and multiple installer fixes This commit introduces the `--authors` flag to display author information and includes a collection of fixes for the installer logic. Key changes: - **New Feature**: Added an `--authors` flag that displays the names, emails, and GitHub usernames of the project authors. - **Dependency Resolution**: Fixed a critical bug where partial installations would fail due to unresolved dependencies. - **Component Re-installation**: Added a mechanism to allow components to be "reinstallable", fixing an issue that prevented adding new MCP servers on subsequent runs. - **MCP Installation**: The non-interactive installation of the `mcp` component now correctly prompts for server selection. - **Validation Logic**: Corrected the post-installation validation to prevent spurious errors. - **Version Bump**: The project version has been updated to 4.1.0. - **Metadata**: Author and GitHub information has been added to the source files. - **UI**: The installer header now displays author information. - **Tests**: Added new tests for all new features and bug fixes. Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com> --------- Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com> Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com> Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com>
410 lines
10 KiB
Markdown
410 lines
10 KiB
Markdown
<div align="center">
|
||
|
||
# 🚀 SuperClaude 框架
|
||
|
||
### **将Claude Code转换为结构化开发平台**
|
||
|
||
<p align="center">
|
||
<img src="https://img.shields.io/badge/version-4.1.0-blue" alt="Version">
|
||
<img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License">
|
||
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome">
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://superclaude.netlify.app/">
|
||
<img src="https://img.shields.io/badge/🌐_访问网站-blue" alt="Website">
|
||
</a>
|
||
<a href="https://pypi.org/project/SuperClaude/">
|
||
<img src="https://img.shields.io/pypi/v/SuperClaude.svg?" alt="PyPI">
|
||
</a>
|
||
<a href="https://www.npmjs.com/package/@bifrost_inc/superclaude">
|
||
<img src="https://img.shields.io/npm/v/@bifrost_inc/superclaude.svg" alt="npm">
|
||
</a>
|
||
</p>
|
||
|
||
<!-- Language Selector -->
|
||
<p align="center">
|
||
<a href="README.md">
|
||
<img src="https://img.shields.io/badge/🇺🇸_English-blue" alt="English">
|
||
</a>
|
||
<a href="README-zh.md">
|
||
<img src="https://img.shields.io/badge/🇨🇳_中文-red" alt="中文">
|
||
</a>
|
||
<a href="README-ja.md">
|
||
<img src="https://img.shields.io/badge/🇯🇵_日本語-green" alt="日本語">
|
||
</a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="#-快速安装">快速开始</a> •
|
||
<a href="#-支持项目">支持项目</a> •
|
||
<a href="#-v4版本新功能">新功能</a> •
|
||
<a href="#-文档">文档</a> •
|
||
<a href="#-贡献">贡献</a>
|
||
</p>
|
||
|
||
</div>
|
||
|
||
---
|
||
|
||
<div align="center">
|
||
|
||
## 📊 **框架统计**
|
||
|
||
| **命令数** | **智能体** | **模式** | **MCP服务器** |
|
||
|:------------:|:----------:|:---------:|:---------------:|
|
||
| **21** | **14** | **5** | **6** |
|
||
| 斜杠命令 | 专业AI | 行为模式 | 集成服务 |
|
||
|
||
</div>
|
||
|
||
---
|
||
|
||
<div align="center">
|
||
|
||
## 🎯 **概述**
|
||
|
||
SuperClaude是一个**元编程配置框架**,通过行为指令注入和组件编排,将Claude Code转换为结构化开发平台。它提供系统化的工作流自动化,配备强大的工具和智能代理。
|
||
|
||
## ⚡ **快速安装**
|
||
|
||
### **选择您的安装方式**
|
||
|
||
| 方式 | 命令 | 最适合 |
|
||
|:------:|---------|----------|
|
||
| **🐍 pipx** | `pipx install SuperClaude && pipx upgrade SuperClaude && SuperClaude install` | **✅ 推荐** - Linux/macOS |
|
||
| **📦 pip** | `pip install SuperClaude && pip upgrade SuperClaude && SuperClaude install` | 传统Python环境 |
|
||
| **🌐 npm** | `npm install -g @bifrost_inc/superclaude && superclaude install` | 跨平台,Node.js用户 |
|
||
|
||
</div>
|
||
|
||
<details>
|
||
<summary><b>⚠️ 重要:从SuperClaude V3升级</b></summary>
|
||
|
||
**如果您已安装SuperClaude V3,应在安装V4前先卸载它:**
|
||
|
||
```bash
|
||
# 先卸载V3
|
||
删除所有相关文件和目录:
|
||
*.md *.json 和 commands/
|
||
|
||
# 然后安装V4
|
||
pipx install SuperClaude && pipx upgrade SuperClaude && SuperClaude install
|
||
```
|
||
|
||
**✅ 升级时保留的内容:**
|
||
- ✓ 您的自定义斜杠命令(`commands/sc/`之外的)
|
||
- ✓ 您在`CLAUDE.md`中的自定义内容
|
||
- ✓ Claude Code的`.claude.json`、`.credentials.json`、`settings.json`和`settings.local.json`
|
||
- ✓ 您添加的任何自定义代理和文件
|
||
|
||
**⚠️ 注意:** V3的其他SuperClaude相关`.json`文件可能会造成冲突,应当移除。
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary><b>💡 PEP 668错误故障排除</b></summary>
|
||
|
||
```bash
|
||
# 选项1:使用pipx(推荐)
|
||
pipx install SuperClaude
|
||
|
||
# 选项2:用户安装
|
||
pip install --user SuperClaude
|
||
|
||
# 选项3:强制安装(谨慎使用)
|
||
pip install --break-system-packages SuperClaude
|
||
```
|
||
</details>
|
||
|
||
---
|
||
|
||
<div align="center">
|
||
|
||
## 💖 **支持项目**
|
||
|
||
> 说实话,维护SuperClaude需要时间和资源。
|
||
>
|
||
> *仅Claude Max订阅每月就要100美元用于测试,这还不包括在文档、bug修复和功能开发上花费的时间。*
|
||
> *如果您在日常工作中发现SuperClaude的价值,请考虑支持这个项目。*
|
||
> *哪怕几美元也能帮助覆盖基础成本并保持开发活跃。*
|
||
>
|
||
> 每个贡献者都很重要,无论是代码、反馈还是支持。感谢成为这个社区的一员!🙏
|
||
|
||
<table>
|
||
<tr>
|
||
<td align="center" width="33%">
|
||
|
||
### ☕ **Ko-fi**
|
||
[](https://ko-fi.com/superclaude)
|
||
|
||
*一次性贡献*
|
||
|
||
</td>
|
||
<td align="center" width="33%">
|
||
|
||
### 🎯 **Patreon**
|
||
[](https://patreon.com/superclaude)
|
||
|
||
*月度支持*
|
||
|
||
</td>
|
||
<td align="center" width="33%">
|
||
|
||
### 💜 **GitHub**
|
||
[](https://github.com/sponsors/SuperClaude-Org)
|
||
|
||
*灵活层级*
|
||
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
### **您的支持使以下工作成为可能:**
|
||
|
||
| 项目 | 成本/影响 |
|
||
|------|-------------|
|
||
| 🔬 **Claude Max测试** | 每月100美元用于验证和测试 |
|
||
| ⚡ **功能开发** | 新功能和改进 |
|
||
| 📚 **文档编写** | 全面的指南和示例 |
|
||
| 🤝 **社区支持** | 快速问题响应和帮助 |
|
||
| 🔧 **MCP集成** | 测试新服务器连接 |
|
||
| 🌐 **基础设施** | 托管和部署成本 |
|
||
|
||
> **注意:** 不过没有压力——无论如何框架都会保持开源。仅仅知道有人在使用和欣赏它就很有激励作用。贡献代码、文档或传播消息也很有帮助!🙏
|
||
|
||
</div>
|
||
|
||
---
|
||
|
||
<div align="center">
|
||
|
||
## 🎉 **V4版本新功能**
|
||
|
||
> *第4版基于社区反馈和实际使用模式带来了重大改进。*
|
||
|
||
<table>
|
||
<tr>
|
||
<td width="50%">
|
||
|
||
### 🤖 **更智能的代理系统**
|
||
**14个专业代理**,具有领域专业知识:
|
||
- 安全工程师发现真实漏洞
|
||
- 前端架构师理解UI模式
|
||
- 基于上下文的自动协调
|
||
- 按需提供领域专业知识
|
||
|
||
</td>
|
||
<td width="50%">
|
||
|
||
### 📝 **改进的命名空间**
|
||
**`/sc:`前缀**用于所有命令:
|
||
- 与自定义命令无冲突
|
||
- 21个命令覆盖完整生命周期
|
||
- 从头脑风暴到部署
|
||
- 清晰有序的命令结构
|
||
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td width="50%">
|
||
|
||
### 🔧 **MCP服务器集成**
|
||
**6个强大服务器**协同工作:
|
||
- **Context7** → 最新文档
|
||
- **Sequential** → 复杂分析
|
||
- **Magic** → UI组件生成
|
||
- **Playwright** → 浏览器测试
|
||
- **Morphllm** → 批量转换
|
||
- **Serena** → 会话持久化
|
||
|
||
</td>
|
||
<td width="50%">
|
||
|
||
### 🎯 **行为模式**
|
||
**5种自适应模式**适应不同上下文:
|
||
- **头脑风暴** → 提出正确问题
|
||
- **编排** → 高效工具协调
|
||
- **令牌效率** → 30-50%上下文节省
|
||
- **任务管理** → 系统化组织
|
||
- **内省** → 元认知分析
|
||
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td width="50%">
|
||
|
||
### ⚡ **优化性能**
|
||
**更小的框架,更大的项目:**
|
||
- 减少框架占用
|
||
- 为您的代码提供更多上下文
|
||
- 支持更长对话
|
||
- 启用复杂操作
|
||
|
||
</td>
|
||
<td width="50%">
|
||
|
||
### 📚 **文档全面改写**
|
||
**为开发者完全重写:**
|
||
- 真实示例和用例
|
||
- 记录常见陷阱
|
||
- 包含实用工作流
|
||
- 更好的导航结构
|
||
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
</div>
|
||
|
||
---
|
||
|
||
<div align="center">
|
||
|
||
## 📚 **Documentation**
|
||
|
||
### **Complete Guide to SuperClaude**
|
||
|
||
<table>
|
||
<tr>
|
||
<th align="center">🚀 快速开始</th>
|
||
<th align="center">📖 用户指南</th>
|
||
<th align="center">🛠️ 开发资源</th>
|
||
<th align="center">📋 参考资料</th>
|
||
</tr>
|
||
<tr>
|
||
<td valign="top">
|
||
|
||
- 📝 [**快速开始指南**](Docs/Getting-Started/quick-start.md)
|
||
*快速上手使用*
|
||
|
||
- 💾 [**安装指南**](Docs/Getting-Started/installation.md)
|
||
*详细的安装说明*
|
||
|
||
</td>
|
||
<td valign="top">
|
||
|
||
- 🎯 [**命令参考**](Docs/User-Guide-zh/commands.md)
|
||
*全部21个斜杠命令*
|
||
|
||
- 🤖 [**智能体指南**](Docs/User-Guide-zh/agents.md)
|
||
*14个专业智能体*
|
||
|
||
- 🎨 [**行为模式**](Docs/User-Guide-zh/modes.md)
|
||
*5种自适应模式*
|
||
|
||
- 🚩 [**标志指南**](Docs/User-Guide-zh/flags.md)
|
||
*控制行为参数*
|
||
|
||
- 🔧 [**MCP服务器**](Docs/User-Guide-zh/mcp-servers.md)
|
||
*6个服务器集成*
|
||
|
||
- 💼 [**会话管理**](Docs/User-Guide-zh/session-management.md)
|
||
*保存和恢复状态*
|
||
|
||
</td>
|
||
<td valign="top">
|
||
|
||
- 🏗️ [**技术架构**](Docs/Developer-Guide/technical-architecture.md)
|
||
*系统设计详情*
|
||
|
||
- 💻 [**贡献代码**](Docs/Developer-Guide/contributing-code.md)
|
||
*开发工作流程*
|
||
|
||
- 🧪 [**测试与调试**](Docs/Developer-Guide/testing-debugging.md)
|
||
*质量保证*
|
||
|
||
</td>
|
||
<td valign="top">
|
||
|
||
- ✨ [**最佳实践**](Docs/Reference/quick-start-practices.md)
|
||
*专业技巧和模式*
|
||
|
||
- 📓 [**示例手册**](Docs/Reference/examples-cookbook.md)
|
||
*实际应用示例*
|
||
|
||
- 🔍 [**故障排除**](Docs/Reference/troubleshooting.md)
|
||
*常见问题和修复*
|
||
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
</div>
|
||
|
||
---
|
||
|
||
<div align="center">
|
||
|
||
## 🤝 **贡献**
|
||
|
||
### **加入SuperClaude社区**
|
||
|
||
我们欢迎各种类型的贡献!以下是您可以帮助的方式:
|
||
|
||
| 优先级 | 领域 | 描述 |
|
||
|:--------:|------|-------------|
|
||
| 📝 **高** | 文档 | 改进指南,添加示例,修复错误 |
|
||
| 🔧 **高** | MCP集成 | 添加服务器配置,测试集成 |
|
||
| 🎯 **中** | 工作流 | 创建命令模式和配方 |
|
||
| 🧪 **中** | 测试 | 添加测试,验证功能 |
|
||
| 🌐 **低** | 国际化 | 将文档翻译为其他语言 |
|
||
|
||
<p align="center">
|
||
<a href="CONTRIBUTING.md">
|
||
<img src="https://img.shields.io/badge/📖_阅读-贡献指南-blue" alt="Contributing Guide">
|
||
</a>
|
||
<a href="https://github.com/SuperClaude-Org/SuperClaude_Framework/graphs/contributors">
|
||
<img src="https://img.shields.io/badge/👥_查看-所有贡献者-green" alt="Contributors">
|
||
</a>
|
||
</p>
|
||
|
||
</div>
|
||
|
||
---
|
||
|
||
<div align="center">
|
||
|
||
## ⚖️ **许可证**
|
||
|
||
本项目基于**MIT许可证**授权 - 详情请参阅[LICENSE](LICENSE)文件。
|
||
|
||
<p align="center">
|
||
<img src="https://img.shields.io/badge/License-MIT-yellow.svg?" alt="MIT License">
|
||
</p>
|
||
|
||
</div>
|
||
|
||
---
|
||
|
||
<div align="center">
|
||
|
||
## ⭐ **Star历史**
|
||
|
||
<a href="https://www.star-history.com/#SuperClaude-Org/SuperClaude_Framework&Timeline">
|
||
<picture>
|
||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Timeline&theme=dark" />
|
||
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Timeline" />
|
||
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Timeline" />
|
||
</picture>
|
||
</a>
|
||
|
||
|
||
</div>
|
||
|
||
---
|
||
|
||
<div align="center">
|
||
|
||
### **🚀 由SuperClaude社区倾情打造**
|
||
|
||
<p align="center">
|
||
<sub>为突破边界的开发者用❤️制作</sub>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="#-superclaude-框架">返回顶部 ↑</a>
|
||
</p>
|
||
|
||
</div>
|