mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-11 02:33:51 +08:00
c27ed8c900
### Added Configuration Details - **Gemini CLI Setup**: Essential settings.json configuration - **.geminiignore**: Performance optimization guidelines - **MCP Tools**: Complete setup guide with links and benefits - Exa MCP Server for external API patterns - Code Index MCP for advanced code search - Benefits and automatic fallback explanation ### Improvements - Organized configuration into three clear sections: Essential, Recommended, Optional - Added installation guide links for MCP servers - Clarified that MCP tools are completely optional - Consistent bilingual documentation structure 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
179 lines
5.7 KiB
Markdown
179 lines
5.7 KiB
Markdown
# 🚀 Claude Code Workflow (CCW)
|
||
|
||
<div align="center">
|
||
|
||
[](https://github.com/catlog22/Claude-Code-Workflow/releases)
|
||
[](LICENSE)
|
||
[]()
|
||
[](https://github.com/modelcontextprotocol)
|
||
|
||
**语言:** [English](README.md) | [中文](README_CN.md)
|
||
|
||
</div>
|
||
|
||
---
|
||
|
||
**Claude Code Workflow (CCW)** 是一个新一代的多智能体自动化开发框架，通过智能工作流管理和自主执行来协调复杂的软件开发任务。
|
||
|
||
> **🎉 最新版本: v3.0.1** - 文档优化和头脑风暴角色更新。详见 [CHANGELOG.md](CHANGELOG.md)。
|
||
>
|
||
> **v3.0.0 版本**: 引入了**统一的 CLI 命令结构**。`/cli:*` 命令通过 `--tool` 标志整合了所有工具（Gemini, Qwen, Codex）的交互。
|
||
|
||
---
|
||
|
||
## ✨ 核心特性
|
||
|
||
- **🤖 多智能体系统**: 用于规划、编码、测试和审查的专用智能体。
|
||
- **🔄 端到端工作流自动化**: 从头脑风暴 (`/workflow:brainstorm`) 到部署的完整流程。
|
||
- **🎯 JSON 优先架构**: 使用 JSON 作为任务的唯一真实数据源，确保一致性。
|
||
- **🧪 自动测试生成**: 基于实现分析创建全面的测试套件。
|
||
- **✅ 执行前验证**: 通过战略（Gemini）和技术（Codex）双重分析验证计划。
|
||
- **🔧 统一 CLI**: 一个强大、统一的 `/cli:*` 命令集，用于与各种 AI 工具交互。
|
||
- **🧠 智能上下文管理**: 自动管理和更新项目文档 (`CLAUDE.md`)。
|
||
|
||
---
|
||
|
||
## ⚙️ 安装
|
||
|
||
### **🚀 一键快速安装**
|
||
|
||
**Windows (PowerShell):**
|
||
```powershell
|
||
Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1" -UseBasicParsing).Content
|
||
```
|
||
|
||
**Linux/macOS (Bash/Zsh):**
|
||
```bash
|
||
bash <(curl -fsSL https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.sh)
|
||
```
|
||
|
||
### **✅ 验证安装**
|
||
安装后，运行以下命令以确保 CCW 正常工作：
|
||
```bash
|
||
/workflow:session:list
|
||
```
|
||
|
||
---
|
||
|
||
## 🚀 快速入门：一个简单的工作流
|
||
|
||
1. **启动一个新的工作流会话：**
|
||
```bash
|
||
/workflow:session:start "创建一个新的用户认证功能"
|
||
```
|
||
|
||
2. **生成一个实现计划：**
|
||
```bash
|
||
/workflow:plan "实现基于JWT的用户认证"
|
||
```
|
||
|
||
3. **使用 AI 智能体执行计划：**
|
||
```bash
|
||
/workflow:execute
|
||
```
|
||
|
||
4. **检查状态：**
|
||
```bash
|
||
/workflow:status
|
||
```
|
||
|
||
---
|
||
|
||
## 🛠️ 命令参考
|
||
|
||
### **统一 CLI 命令 (`/cli:*)**
|
||
*使用 `--tool <gemini|qwen|codex>` 标志选择所需工具。默认为 `gemini`。*
|
||
|
||
| 命令 | 描述 |
|
||
|---|---|
|
||
| `/cli:analyze` | 深度代码库分析。 |
|
||
| `/cli:chat` | 与工具进行直接的交互式聊天。 |
|
||
| `/cli:execute` | 以完全权限执行任务。 |
|
||
| `/cli:cli-init`| 为工作区初始化CLI工具配置。 |
|
||
| `/cli:mode:bug-index` | 分析错误并提出修复建议。 |
|
||
| `/cli:mode:code-analysis` | 执行深度代码分析和调试。 |
|
||
| `/cli:mode:plan` | 项目规划和架构分析。 |
|
||
|
||
### **工作流命令 (`/workflow:*)**
|
||
|
||
| 命令 | 描述 |
|
||
|---|---|
|
||
| `/workflow:session:*` | 管理开发会话（`start`, `pause`, `resume`, `list`, `switch`, `complete`）。 |
|
||
| `/workflow:brainstorm:*` | 使用基于角色的智能体进行多视角规划。 |
|
||
| `/workflow:plan` | 从描述创建详细、可执行的计划。 |
|
||
| `/workflow:execute` | 自主执行当前的工作流计划。 |
|
||
| `/workflow:status` | 显示工作流的当前状态。 |
|
||
| `/workflow:test-gen` | 从实现中自动生成测试计划。 |
|
||
| `/workflow:review` | 对已完成的工作启动质量保证审查。 |
|
||
|
||
### **任务与内存命令**
|
||
|
||
| 命令 | 描述 |
|
||
|---|---|
|
||
| `/task:*` | 管理单个任务（`create`, `breakdown`, `execute`, `replan`）。 |
|
||
| `/update-memory-full` | 重新索引整个项目文档。 |
|
||
| `/update-memory-related` | 更新与最近更改相关的文档。 |
|
||
|
||
---
|
||
|
||
## ⚙️ 配置
|
||
|
||
### **必需: Gemini CLI 设置**
|
||
|
||
配置 Gemini CLI 以实现最佳集成：
|
||
|
||
```json
|
||
// ~/.gemini/settings.json
|
||
{
|
||
"contextFileName": "CLAUDE.md"
|
||
}
|
||
```
|
||
|
||
### **推荐: .geminiignore**
|
||
|
||
通过排除不必要的文件来优化性能：
|
||
|
||
```bash
|
||
# .geminiignore (在项目根目录)
|
||
/dist/
|
||
/build/
|
||
/node_modules/
|
||
/.next/
|
||
*.tmp
|
||
*.log
|
||
/temp/
|
||
|
||
# 包含重要文档
|
||
!README.md
|
||
!**/CLAUDE.md
|
||
```
|
||
|
||
### **可选: MCP 工具** *(增强分析)*
|
||
|
||
MCP (模型上下文协议) 工具提供高级代码库分析。**完全可选** - CCW 在没有它们的情况下也能完美工作。
|
||
|
||
#### 可用的 MCP 服务器
|
||
|
||
| MCP 服务器 | 用途 | 安装指南 |
|
||
|------------|------|---------|
|
||
| **Exa MCP** | 外部 API 模式和最佳实践 | [安装指南](https://github.com/exa-labs/exa-mcp-server) |
|
||
| **Code Index MCP** | 高级内部代码搜索 | [安装指南](https://github.com/johnhuang316/code-index-mcp) |
|
||
|
||
#### 启用后的好处
|
||
- 📊 **更快分析**: 直接代码库索引 vs 手动搜索
|
||
- 🌐 **外部上下文**: 真实世界的 API 模式和示例
|
||
- 🔍 **高级搜索**: 模式匹配和相似性检测
|
||
- ⚡ **自动回退**: MCP 不可用时使用传统工具
|
||
|
||
---
|
||
|
||
## 🤝 贡献与支持
|
||
|
||
- **仓库**: [GitHub - Claude-Code-Workflow](https://github.com/catlog22/Claude-Code-Workflow)
|
||
- **问题**: 在 [GitHub Issues](https://github.com/catlog22/Claude-Code-Workflow/issues) 上报告错误或请求功能。
|
||
- **讨论**: 加入 [社区论坛](https://github.com/catlog22/Claude-Code-Workflow/discussions)。
|
||
|
||
## 📄 许可证
|
||
|
||
此项目根据 **MIT 许可证** 授权。详见 [LICENSE](LICENSE) 文件。
|