Files
Claude-Code-Workflow/README_CN.md
catlog22 fd5f6c2c97 docs: 简化 CLI 工具安装说明
- 移除详细配置步骤
- 使用表格形式简明展示
- 提供官方文档链接
2026-01-17 11:06:21 +08:00

8.9 KiB
Raw Blame History

Claude Code Workflow (CCW)


CCW 是一个 JSON 驱动的多智能体开发框架,具有智能 CLI 编排能力。提供 4 级工作流系统,从急速执行到完整头脑风暴,将 AI 开发转变为强大的编排系统。

核心特性

特性 说明
4 级工作流 lite-lite-lite(即时执行)到 brainstorm(多角色分析)
多 CLI 编排 Gemini、Qwen、Codex、Claude - 自动选择或手动指定
依赖感知并行 Agent 并行执行,无需 worktree 复杂性
Issue 工作流 开发后维护,可选 worktree 隔离
JSON 优先状态 .task/IMPL-*.json 作为唯一事实来源
Dashboard 可视化会话管理、CodexLens 搜索、图浏览器

📖 新用户? 查看 工作流指南 了解完整的 4 级工作流系统。


快速开始

安装 CCW

npm install -g claude-code-workflow
ccw install -m Global

选择工作流级别

级别 命令 使用场景
1 /workflow:lite-lite-lite 快速修复、配置调整
2 /workflow:lite-plan 明确的单模块功能
2 /workflow:lite-fix Bug 诊断修复
2 /workflow:multi-cli-plan 多视角分析
3 /workflow:plan 多模块开发
3 /workflow:tdd-plan 测试驱动开发
4 /workflow:brainstorm:auto-parallel 新功能、架构设计

工作流示例

# 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 工具安装

CCW 支持多种 CLI 工具,按需安装:

CLI 说明 官方文档
🔷 Gemini Google AI 分析 github.com/anthropics/anthropic-quickstarts
🟢 Codex OpenAI 自主编码 github.com/openai/codex
🟠 OpenCode 开源多模型 github.com/opencode-ai/opencode
🟣 Qwen 阿里云 Qwen github.com/QwenLM/Qwen

🎭 语义化 CLI 调用

用户可以在提示词中 语义指定 CLI 工具 - 系统自动调用对应的 CLI 进行分析。

基础调用

用户提示词 系统动作
"使用 Gemini 分析 auth 模块" 自动调用 gemini CLI 进行分析
"让 Codex 审查这段代码" 自动调用 codex CLI 进行审查
"问问 Qwen 性能优化建议" 自动调用 qwen CLI 进行咨询

多 CLI 编排

用户可以在单个提示词中语义编排多个 CLI

模式 用户提示词示例
🔄 协同分析 "使用 Gemini 和 Codex 协同分析安全漏洞"
并行执行 "让 Gemini、Codex、Qwen 并行分析架构设计"
🔁 迭代优化 "用 Gemini 诊断问题,然后 Codex 修复,迭代直到解决"
🔗 流水线 "Gemini 设计方案Codex 实现Claude 审查"

示例

# 单 CLI 调用
用户: "使用 Gemini 分析数据库查询性能"
→ 系统自动调用: gemini CLI 执行分析任务

# 协同分析
用户: "使用 Gemini 和 Codex 协同审查认证流程"
→ 系统自动调用: gemini + codex CLI综合分析结果

# 并行多视角
用户: "让所有可用的 CLI 并行分析这个架构设计"
→ 系统自动调用: gemini, codex, qwen 并行执行 → 合并报告

# 顺序流水线
用户: "用 Gemini 规划重构方案,然后 Codex 实现"
→ 系统自动调用: gemini规划→ codex实现顺序执行

💡 核心:只需描述使用哪个 CLI 做什么 - CCW 自动处理调用。

自定义 CLI 注册

通过 Dashboard 界面 注册任意 API 为自定义 CLI

ccw view  # 打开 Dashboard → Status → API Settings → 添加自定义 CLI
字段 示例
名称 deepseek
端点 https://api.deepseek.com/v1/chat
API Key your-api-key

注册后即可像内置 CLI 一样语义调用:

用户: "使用 DeepSeek 分析这个算法复杂度"
→ 系统自动调用: deepseek CLI你的自定义端点

用户: "让 DeepSeek 和 Gemini 对比分析结果"
→ 系统自动调用: deepseek + gemini 并行执行

⚙️ 注册一次,永久语义调用 - 无需修改代码。


ACE Tool 配置

ACE (Augment Context Engine) 提供强大的语义代码搜索能力。

方式 链接
📘 官方安装 Augment MCP 文档
🔧 代理版本 ace-tool (GitHub)

CodexLens 本地搜索

⚠️ 开发中: CodexLens 正在迭代优化中,部分功能可能不稳定。

CodexLens 提供本地代码索引和搜索能力,无需外部 API

搜索模式 说明
FTS 全文搜索,基于 SQLite FTS5
Semantic 语义搜索,基于本地嵌入模型
Hybrid 混合搜索,结合 FTS + 语义 + 重排序

安装

# 进入 codex-lens 目录
cd codex-lens

# 安装依赖
pip install -e .

# 初始化索引
codexlens index /path/to/project

Dashboard 集成

通过 ccw view 打开 DashboardCodexLens Manager 中管理索引和执行搜索。


CCW CLI 命令

ccw install           # 安装工作流文件
ccw view              # 打开 Dashboard
ccw cli -p "..."      # 执行 CLI 工具 (Gemini/Qwen/Codex)
ccw upgrade -a        # 升级所有安装

Dashboard 功能

  • 会话概览 - 跟踪工作流会话和进度
  • CodexLens - FTS + 语义 + 混合代码搜索
  • 图浏览器 - 交互式代码关系可视化
  • CLI 管理器 - 执行历史与会话恢复

文档

文档 说明
工作流指南 4 级工作流系统(推荐)
快速开始 5 分钟快速入门
Dashboard 指南 Dashboard 用户指南
常见问题 常见问题解答
更新日志 版本历史

架构概览

┌─────────────────────────────────────────────────────────────────┐
│                     主干工作流 (4 级)                            │
│  Level 1: lite-lite-lite (即时执行,无产物)                      │
│  Level 2: lite-plan / lite-fix / multi-cli-plan (→ lite-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 工作流 补充主干工作流,用于开发后维护
  • 根据复杂度选择工作流级别 - 避免过度工程化

贡献

许可证

MIT License - 详见 LICENSE