Version npm License Stars Issues

**[English](README.md) | [中文](README_CN.md)**
Typing SVG

Quick Start Guide CLI Tools Architecture

--- ## ✨ 核心特性
### 🎯 4 级工作流 从 `lite-lite-lite`（即时执行）到 `brainstorm`（多角色分析） ### 🔄 多 CLI 编排 Gemini、Qwen、Codex、Claude - 自动选择或手动指定 ### ⚡ 依赖感知并行 Agent 并行执行，无需 worktree 复杂性 ### 🔧 Issue 工作流 开发后维护，可选 worktree 隔离 ### 📦 JSON 优先状态 `.task/IMPL-*.json` 作为唯一事实来源 ### 🖥️ Dashboard 可视化会话管理、CodexLens 搜索、图浏览器
> 📖 **新用户？** 查看 [工作流指南](WORKFLOW_GUIDE_CN.md) 了解完整的 4 级工作流系统。 --- ## 🚀 快速开始 ### 安装 CCW ```bash npm install -g claude-code-workflow ccw install -m Global ``` ### 选择工作流级别
级别命令使用场景
1/workflow:lite-lite-lite快速修复、配置调整
2/workflow:lite-plan明确的单模块功能
2/workflow:lite-fixBug 诊断修复
2/workflow:multi-cli-plan多视角分析
3/workflow:plan多模块开发
3/workflow:tdd-plan测试驱动开发
4/workflow:brainstorm:auto-parallel新功能、架构设计
### 工作流示例 ```bash # Level 1: 即时执行 /workflow:lite-lite-lite "修复 README 中的拼写错误" # Level 2: 轻量规划 /workflow:lite-plan "添加 JWT 认证" /workflow:lite-fix "用户上传失败返回 413 错误" # Level 3: 标准规划 + Session /workflow:plan "实现支付网关集成" /workflow:execute # Level 4: 多角色头脑风暴 /workflow:brainstorm:auto-parallel "设计实时协作系统" --count 5 /workflow:plan --session WFS-xxx /workflow:execute ``` --- ## 🛠️ CLI 工具安装
CLI说明官方文档
GeminiGoogle AI 分析google-gemini/gemini-cli
CodexOpenAI 自主编码openai/codex
OpenCode开源多模型opencode-ai/opencode
Qwen阿里云 Qwen-CodeQwenLM/Qwen
--- ## 🎭 语义化 CLI 调用

用户可以在提示词中 **语义指定 CLI 工具** - 系统自动调用对应的 CLI。 ### 基础调用 | 用户提示词 | 系统动作 | |------------|----------| | "使用 Gemini 分析 auth 模块" | 自动调用 `gemini` CLI 进行分析 | | "让 Codex 审查这段代码" | 自动调用 `codex` CLI 进行审查 | | "问问 Qwen 性能优化建议" | 自动调用 `qwen` CLI 进行咨询 | ### 多 CLI 编排 | 模式 | 用户提示词示例 | |------|----------------| | **协同分析** | "使用 Gemini 和 Codex 协同分析安全漏洞" | | **并行执行** | "让 Gemini、Codex、Qwen 并行分析架构设计" | | **迭代优化** | "用 Gemini 诊断问题，然后 Codex 修复，迭代直到解决" | | **流水线** | "Gemini 设计方案，Codex 实现，Claude 审查" |
📝 更多示例 ```text # 单 CLI 调用 用户: "使用 Gemini 分析数据库查询性能" → 系统自动调用: gemini CLI 执行分析任务 # 协同分析 用户: "使用 Gemini 和 Codex 协同审查认证流程" → 系统自动调用: gemini + codex CLI，综合分析结果 # 并行多视角 用户: "让所有可用的 CLI 并行分析这个架构设计" → 系统自动调用: gemini, codex, qwen 并行执行 → 合并报告 # 顺序流水线 用户: "用 Gemini 规划重构方案，然后 Codex 实现" → 系统自动调用: gemini（规划）→ codex（实现）顺序执行 ```
### 自定义 CLI 注册 通过 Dashboard 界面 **注册任意 API 为自定义 CLI**： ```bash ccw view # 打开 Dashboard → Status → API Settings → 添加自定义 CLI ``` | 字段 | 示例 | |------|------| | **名称** | `deepseek` | | **端点** | `https://api.deepseek.com/v1/chat` | | **API Key** | `your-api-key` | > ⚙️ 注册一次，永久语义调用 - 无需修改代码。 --- ## 🔍 ACE Tool 配置 ACE (Augment Context Engine) 提供强大的语义代码搜索能力。 | 方式 | 链接 | |------|------| | **官方** | [Augment MCP 文档](https://docs.augmentcode.com/context-services/mcp/overview) | | **代理** | [ace-tool (GitHub)](https://github.com/eastxiaodong/ace-tool) | --- ## 📚 CodexLens 本地搜索 > ⚠️ **开发中**: CodexLens 正在迭代优化中，部分功能可能不稳定。
搜索模式说明
FTS全文搜索，基于 SQLite FTS5
Semantic语义搜索，基于本地嵌入模型
Hybrid混合搜索，结合 FTS + 语义 + 重排序
📦 安装 ```bash # 进入 codex-lens 目录 cd codex-lens # 安装依赖 pip install -e . # 初始化索引 codexlens index /path/to/project ``` 通过 `ccw view` 打开 Dashboard，在 **CodexLens Manager** 中管理索引和执行搜索。
--- ## 💻 CCW CLI 命令 ```bash ccw install # 安装工作流文件 ccw view # 打开 Dashboard ccw cli -p "..." # 执行 CLI 工具 (Gemini/Qwen/Codex) ccw upgrade -a # 升级所有安装 ``` ### Dashboard 功能
功能说明
会话概览跟踪工作流会话和进度
CodexLensFTS + 语义 + 混合代码搜索
图浏览器交互式代码关系可视化
CLI 管理器执行历史与会话恢复
--- ## 📖 文档 | 文档 | 说明 | |------|------| | [**工作流指南**](WORKFLOW_GUIDE_CN.md) | 4 级工作流系统（推荐） | | [**快速开始**](GETTING_STARTED_CN.md) | 5 分钟快速入门 | | [**Dashboard 指南**](DASHBOARD_GUIDE.md) | Dashboard 用户指南 | | [**常见问题**](FAQ.md) | 常见问题解答 | | [**更新日志**](CHANGELOG.md) | 版本历史 | --- ## 🏗️ 架构概览 ``` ┌─────────────────────────────────────────────────────────────────┐ │ 主干工作流 (4 级) │ │ ⚡ Level 1: lite-lite-lite (即时执行，无产物) │ │ 📝 Level 2: lite-plan / lite-fix / multi-cli-plan (→ execute) │ │ 📊 Level 3: plan / tdd-plan / test-fix-gen (Session 持久化) │ │ 🧠 Level 4: brainstorm:auto-parallel → plan → execute │ └─────────────────────────────────────────────────────────────────┘ ↓ ┌─────────────────────────────────────────────────────────────────┐ │ Issue 工作流 (补充) │ │ 🔍 discover → 📋 plan → 📦 queue → ▶️ execute (worktree) │ └─────────────────────────────────────────────────────────────────┘ ``` **核心原则：** - ⚡ **依赖分析** 解决并行问题 - 主干工作流无需 worktree - 🔧 **Issue 工作流** 补充主干工作流，用于开发后维护 - 🎯 根据复杂度选择工作流级别 - 避免过度工程化 --- ## 🤝 贡献
GitHub Issues Contributing
--- ## 📄 许可证
MIT License - 详见 [LICENSE](LICENSE)