mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
docs: sync translated READMEs with main README structure
Updated all translated READMEs (Chinese, Japanese, Korean) to match the main README.md structure: Changes: - Updated Framework Statistics (3 plugins, 16 agents, 7 modes, 8 MCP servers) - Added Disclaimer section - Added Developer & Contributors documentation table - Restructured installation section with v4.1.8 and v5.0 details - Expanded "What's New in v4.1" (6 subsections) - Added complete "Deep Research Capabilities" section (8 subsections) - Updated Documentation section with correct counts - Fixed all path references and command descriptions Structure Consistency: 58/58 headings (100/100 score) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
363
README-zh.md
363
README-zh.md
@@ -51,10 +51,12 @@
|
||||
|
||||
## 📊 **框架统计**
|
||||
|
||||
| **命令数** | **智能体** | **模式** | **MCP服务器** |
|
||||
| **插件** | **智能体** | **模式** | **MCP服务器** |
|
||||
|:------------:|:----------:|:---------:|:---------------:|
|
||||
| **21** | **14** | **5** | **6** |
|
||||
| 斜杠命令 | 专业AI | 行为模式 | 集成服务 |
|
||||
| **3** | **16** | **7** | **8** |
|
||||
| 插件命令 | 专业AI | 行为模式 | 集成服务 |
|
||||
|
||||
三个核心插件:**PM Agent**(编排)、**Research**(网络搜索)、**Index**(上下文优化)。
|
||||
|
||||
</div>
|
||||
|
||||
@@ -66,57 +68,101 @@
|
||||
|
||||
SuperClaude是一个**元编程配置框架**,通过行为指令注入和组件编排,将Claude Code转换为结构化开发平台。它提供系统化的工作流自动化,配备强大的工具和智能代理。
|
||||
|
||||
|
||||
## 免责声明
|
||||
|
||||
本项目与Anthropic无关联或认可。
|
||||
Claude Code是由[Anthropic](https://www.anthropic.com/)构建和维护的产品。
|
||||
|
||||
## 📖 **开发者与贡献者指南**
|
||||
|
||||
**使用SuperClaude框架的必备文档:**
|
||||
|
||||
| 文档 | 用途 | 何时阅读 |
|
||||
|----------|---------|--------------|
|
||||
| **[PLANNING.md](PLANNING.md)** | 架构、设计原则、绝对规则 | 会话开始、实施前 |
|
||||
| **[TASK.md](TASK.md)** | 当前任务、优先级、待办事项 | 每天、开始工作前 |
|
||||
| **[KNOWLEDGE.md](KNOWLEDGE.md)** | 积累的见解、最佳实践、故障排除 | 遇到问题时、学习模式 |
|
||||
| **[CONTRIBUTING.md](CONTRIBUTING.md)** | 贡献指南、工作流程 | 提交PR前 |
|
||||
|
||||
> **💡 专业提示**:Claude Code在会话开始时会读取这些文件,以确保符合项目标准的一致、高质量开发。
|
||||
|
||||
## ⚡ **快速安装**
|
||||
|
||||
### **选择您的安装方式**
|
||||
> **重要**:旧文档中描述的TypeScript插件系统
|
||||
> 尚未可用(计划在v5.0中推出)。请按照以下v4.x的
|
||||
> 当前安装说明操作。
|
||||
|
||||
| 方式 | 命令 | 最适合 |
|
||||
|:------:|---------|----------|
|
||||
| **🐍 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用户 |
|
||||
### **当前稳定版本 (v4.1.8)**
|
||||
|
||||
SuperClaude目前使用斜杠命令。
|
||||
|
||||
**选项1:pipx(推荐)**
|
||||
```bash
|
||||
# 从PyPI安装
|
||||
pipx install superclaude
|
||||
|
||||
# 安装命令(安装 /research, /index-repo, /agent, /recommend)
|
||||
superclaude install
|
||||
|
||||
# 验证安装
|
||||
superclaude install --list
|
||||
superclaude doctor
|
||||
```
|
||||
|
||||
安装后,重启Claude Code以使用命令:
|
||||
- `/sc:research` - 并行搜索的深度网络研究
|
||||
- `/sc:index-repo` - 用于上下文优化的仓库索引
|
||||
- `/sc:agent` - 专业AI智能体
|
||||
- `/sc:recommend` - 命令推荐
|
||||
- `/sc` - 显示所有可用的SuperClaude命令
|
||||
|
||||
**选项2:从Git直接安装**
|
||||
```bash
|
||||
# 克隆仓库
|
||||
git clone https://github.com/SuperClaude-Org/SuperClaude_Framework.git
|
||||
cd SuperClaude_Framework
|
||||
|
||||
# 运行安装脚本
|
||||
./install.sh
|
||||
```
|
||||
|
||||
### **v5.0即将推出(开发中)**
|
||||
|
||||
我们正在积极开发新的TypeScript插件系统(详见issue [#419](https://github.com/SuperClaude-Org/SuperClaude_Framework/issues/419))。发布后,安装将简化为:
|
||||
|
||||
```bash
|
||||
# 此功能尚未可用
|
||||
/plugin marketplace add SuperClaude-Org/superclaude-plugin-marketplace
|
||||
/plugin install superclaude
|
||||
```
|
||||
|
||||
**状态**:开发中。尚未设定ETA。
|
||||
|
||||
### **增强性能(可选MCP)**
|
||||
|
||||
要获得**2-3倍**更快的执行速度和**30-50%**更少的token消耗,可选择安装MCP服务器:
|
||||
|
||||
```bash
|
||||
# 用于增强性能的可选MCP服务器(通过airis-mcp-gateway):
|
||||
# - Serena: 代码理解(快2-3倍)
|
||||
# - Sequential: Token高效推理(减少30-50% token)
|
||||
# - Tavily: 用于深度研究的网络搜索
|
||||
# - Context7: 官方文档查找
|
||||
# - Mindbase: 跨所有对话的语义搜索(可选增强)
|
||||
|
||||
# 注意:错误学习通过内置的ReflexionMemory提供(无需安装)
|
||||
# Mindbase提供语义搜索增强(需要"recommended"配置文件)
|
||||
# 安装MCP服务器:https://github.com/agiletec-inc/airis-mcp-gateway
|
||||
# 详见 docs/mcp/mcp-integration-policy.md
|
||||
```
|
||||
|
||||
**性能对比:**
|
||||
- **不使用MCP**:功能完整,标准性能 ✅
|
||||
- **使用MCP**:快2-3倍,减少30-50% token ⚡
|
||||
|
||||
</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">
|
||||
@@ -179,16 +225,18 @@ pip install --break-system-packages SuperClaude
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 🎉 **V4版本新功能**
|
||||
## 🎉 **V4.1版本新功能**
|
||||
|
||||
> *第4版基于社区反馈和实际使用模式带来了重大改进。*
|
||||
> *版本4.1专注于稳定斜杠命令架构、增强智能体能力和改进文档。*
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
### 🤖 **更智能的代理系统**
|
||||
**14个专业代理**,具有领域专业知识:
|
||||
### 🤖 **更智能的智能体系统**
|
||||
**16个专业智能体**具有领域专业知识:
|
||||
- PM Agent通过系统化文档确保持续学习
|
||||
- 深度研究智能体用于自主网络研究
|
||||
- 安全工程师发现真实漏洞
|
||||
- 前端架构师理解UI模式
|
||||
- 基于上下文的自动协调
|
||||
@@ -197,43 +245,6 @@ pip install --break-system-packages SuperClaude
|
||||
</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%">
|
||||
|
||||
### ⚡ **优化性能**
|
||||
**更小的框架,更大的项目:**
|
||||
- 减少框架占用
|
||||
@@ -242,6 +253,37 @@ pip install --break-system-packages SuperClaude
|
||||
- 启用复杂操作
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
### 🔧 **MCP服务器集成**
|
||||
**8个强大服务器**(通过airis-mcp-gateway):
|
||||
- **Tavily** → 主要网络搜索(深度研究)
|
||||
- **Serena** → 会话持久化和内存
|
||||
- **Mindbase** → 跨会话学习(零占用)
|
||||
- **Sequential** → Token高效推理
|
||||
- **Context7** → 官方文档查找
|
||||
- **Playwright** → JavaScript重度内容提取
|
||||
- **Magic** → UI组件生成
|
||||
- **Chrome DevTools** → 性能分析
|
||||
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
### 🎯 **行为模式**
|
||||
**7种自适应模式**适应不同上下文:
|
||||
- **头脑风暴** → 提出正确问题
|
||||
- **商业面板** → 多专家战略分析
|
||||
- **深度研究** → 自主网络研究
|
||||
- **编排** → 高效工具协调
|
||||
- **令牌效率** → 30-50%上下文节省
|
||||
- **任务管理** → 系统化组织
|
||||
- **内省** → 元认知分析
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
### 📚 **文档全面改写**
|
||||
@@ -251,6 +293,16 @@ pip install --break-system-packages SuperClaude
|
||||
- 包含实用工作流
|
||||
- 更好的导航结构
|
||||
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
### 🧪 **增强稳定性**
|
||||
**专注于可靠性:**
|
||||
- 核心命令的错误修复
|
||||
- 改进测试覆盖率
|
||||
- 更健壮的错误处理
|
||||
- CI/CD流水线改进
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -261,9 +313,101 @@ pip install --break-system-packages SuperClaude
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 📚 **Documentation**
|
||||
## 🔬 **深度研究能力**
|
||||
|
||||
### **Complete Guide to SuperClaude**
|
||||
### **与DR智能体架构一致的自主网络研究**
|
||||
|
||||
SuperClaude v4.2引入了全面的深度研究能力,实现自主、自适应和智能的网络研究。
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
### 🎯 **自适应规划**
|
||||
**三种智能策略:**
|
||||
- **仅规划**:对明确查询直接执行
|
||||
- **意图规划**:对模糊请求进行澄清
|
||||
- **统一**:协作式计划完善(默认)
|
||||
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
### 🔄 **多跳推理**
|
||||
**最多5次迭代搜索:**
|
||||
- 实体扩展(论文 → 作者 → 作品)
|
||||
- 概念深化(主题 → 细节 → 示例)
|
||||
- 时间进展(当前 → 历史)
|
||||
- 因果链(效果 → 原因 → 预防)
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
### 📊 **质量评分**
|
||||
**基于置信度的验证:**
|
||||
- 来源可信度评估(0.0-1.0)
|
||||
- 覆盖完整性跟踪
|
||||
- 综合连贯性评估
|
||||
- 最低阈值:0.6,目标:0.8
|
||||
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
### 🧠 **基于案例的学习**
|
||||
**跨会话智能:**
|
||||
- 模式识别和重用
|
||||
- 随时间优化策略
|
||||
- 保存成功的查询公式
|
||||
- 性能改进跟踪
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
### **研究命令使用**
|
||||
|
||||
```bash
|
||||
# 使用自动深度的基本研究
|
||||
/research "2024年最新AI发展"
|
||||
|
||||
# 控制研究深度(通过TypeScript中的选项)
|
||||
/research "量子计算突破" # depth: exhaustive
|
||||
|
||||
# 特定策略选择
|
||||
/research "市场分析" # strategy: planning-only
|
||||
|
||||
# 领域过滤研究(Tavily MCP集成)
|
||||
/research "React模式" # domains: reactjs.org,github.com
|
||||
```
|
||||
|
||||
### **研究深度级别**
|
||||
|
||||
| 深度 | 来源 | 跳数 | 时间 | 最适合 |
|
||||
|:-----:|:-------:|:----:|:----:|----------|
|
||||
| **快速** | 5-10 | 1 | ~2分钟 | 快速事实、简单查询 |
|
||||
| **标准** | 10-20 | 3 | ~5分钟 | 一般研究(默认) |
|
||||
| **深入** | 20-40 | 4 | ~8分钟 | 综合分析 |
|
||||
| **详尽** | 40+ | 5 | ~10分钟 | 学术级研究 |
|
||||
|
||||
### **集成工具编排**
|
||||
|
||||
深度研究系统智能协调多个工具:
|
||||
- **Tavily MCP**:主要网络搜索和发现
|
||||
- **Playwright MCP**:复杂内容提取
|
||||
- **Sequential MCP**:多步推理和综合
|
||||
- **Serena MCP**:内存和学习持久化
|
||||
- **Context7 MCP**:技术文档查找
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 📚 **文档**
|
||||
|
||||
### **SuperClaude完整指南**
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
@@ -275,55 +419,52 @@ pip install --break-system-packages SuperClaude
|
||||
<tr>
|
||||
<td valign="top">
|
||||
|
||||
- 📝 [**快速开始指南**](docs/getting-started/quick-start.md)
|
||||
- 📝 [**快速开始指南**](docs/getting-started/quick-start.md)
|
||||
*快速上手使用*
|
||||
|
||||
- 💾 [**安装指南**](docs/getting-started/installation.md)
|
||||
- 💾 [**安装指南**](docs/getting-started/installation.md)
|
||||
*详细的安装说明*
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
- 🎯 [**命令参考**](docs/user-guide-zh/commands.md)
|
||||
*全部21个斜杠命令*
|
||||
- 🎯 [**斜杠命令**](docs/user-guide/commands.md)
|
||||
*完整的 `/sc` 命令列表*
|
||||
|
||||
- 🤖 [**智能体指南**](docs/user-guide-zh/agents.md)
|
||||
*14个专业智能体*
|
||||
- 🤖 [**智能体指南**](docs/user-guide/agents.md)
|
||||
*16个专业智能体*
|
||||
|
||||
- 🎨 [**行为模式**](docs/user-guide-zh/modes.md)
|
||||
*5种自适应模式*
|
||||
- 🎨 [**行为模式**](docs/user-guide/modes.md)
|
||||
*7种自适应模式*
|
||||
|
||||
- 🚩 [**标志指南**](docs/user-guide-zh/flags.md)
|
||||
- 🚩 [**标志指南**](docs/user-guide/flags.md)
|
||||
*控制行为参数*
|
||||
|
||||
- 🔧 [**MCP服务器**](docs/user-guide-zh/mcp-servers.md)
|
||||
*6个服务器集成*
|
||||
- 🔧 [**MCP服务器**](docs/user-guide/mcp-servers.md)
|
||||
*8个服务器集成*
|
||||
|
||||
- 💼 [**会话管理**](docs/user-guide-zh/session-management.md)
|
||||
- 💼 [**会话管理**](docs/user-guide/session-management.md)
|
||||
*保存和恢复状态*
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
- 🏗️ [**技术架构**](docs/developer-guide/technical-architecture.md)
|
||||
- 🏗️ [**技术架构**](docs/developer-guide/technical-architecture.md)
|
||||
*系统设计详情*
|
||||
|
||||
- 💻 [**贡献代码**](docs/developer-guide/contributing-code.md)
|
||||
- 💻 [**贡献代码**](docs/developer-guide/contributing-code.md)
|
||||
*开发工作流程*
|
||||
|
||||
- 🧪 [**测试与调试**](docs/developer-guide/testing-debugging.md)
|
||||
- 🧪 [**测试与调试**](docs/developer-guide/testing-debugging.md)
|
||||
*质量保证*
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
- ✨ [**最佳实践**](docs/reference/basic-examples.md)
|
||||
*专业技巧和模式*
|
||||
|
||||
- 📓 [**示例手册**](docs/reference/examples-cookbook.md)
|
||||
- 📓 [**示例手册**](docs/reference/examples-cookbook.md)
|
||||
*实际应用示例*
|
||||
|
||||
- 🔍 [**故障排除**](docs/reference/troubleshooting.md)
|
||||
- 🔍 [**故障排除**](docs/reference/troubleshooting.md)
|
||||
*常见问题和修复*
|
||||
|
||||
</td>
|
||||
|
||||
Reference in New Issue
Block a user