Files
Claude-Code-Workflow/README_CN.md
catlog22 690d524aee docs: update README and WORKFLOW_GUIDE with simplified content
- Streamline README documentation
- Update workflow guide with current best practices
2026-02-27 22:52:28 +08:00

16 KiB
Raw Blame History


Quick Start Guide CLI Tools Architecture


核心特性

🎯 Skill 工作流

lite-plan(轻量规划)到 brainstorm(多角色分析)

🔄 多 CLI 编排

Gemini、Qwen、Codex、Claude - 自动选择或手动指定

Team 架构 v2

基于角色的智能体,支持内循环执行

🔧 队列调度器

后台队列执行服务

📦 会话生命周期

启动/恢复/完成/同步工作流会话

🖥️ 终端仪表板

多终端网格带执行监控器

🎨 编排器编辑器

基于模板的可视化工作流编辑

💬 A2UI

智能体到用户的交互界面

📖 新用户? 查看 工作流指南 了解完整的工作流文档。


🚀 快速开始

安装 CCW

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

工作流 Skill 与命令

CCW 使用两种调用方式:

类型 格式 示例
Skills 触发短语(无斜杠) workflow:lite-plan, brainstorm, workflow:plan
Commands 斜杠命令 /ccw, /workflow/session:start, /issue/new

选择工作流 Skill

Skill 触发词使用场景
workflow:lite-plan轻量规划、单模块功能
workflow:multi-cli-plan多 CLI 协同分析
workflow:plan完整规划与会话持久化
workflow:tdd-plan测试驱动开发
workflow:test-fix-gen测试生成与修复循环
brainstorm多角色头脑风暴分析

工作流示例

# Skill 触发(无斜杠 - 直接描述你想做什么)
workflow:lite-plan "添加 JWT 认证"
workflow:plan "实现支付网关集成"
workflow:execute

# 头脑风暴
brainstorm "设计实时协作系统"

# 会话管理命令
/workflow:session:start
/workflow:session:resume
/workflow:session:complete

🛠️ 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 审查"

🔍 ACE Tool 配置

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

方式 链接
官方 Augment MCP 文档
代理 ace-tool (GitHub)

📚 CodexLens 本地搜索

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

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

💻 CCW CLI 命令

🌟 推荐命令

命令说明适用场景
/ccw 自动工作流编排器 - 分析意图、选择工作流、执行 通用任务、自动选择工作流
/ccw-coordinator 智能编排器 - 推荐命令链、支持手动调整 🔧 复杂多步骤工作流

快速示例

# /ccw - 自动工作流选择
/ccw "添加用户认证"
/ccw "修复 WebSocket 中的内存泄漏"
/ccw "使用 TDD 方式实现"

# /ccw-coordinator - 手动链编排
/ccw-coordinator "实现 OAuth2 系统"

会话管理命令

/workflow:session:start     # 启动新工作流会话
/workflow:session:resume    # 恢复暂停的会话
/workflow:session:list      # 列出所有会话
/workflow:session:sync      # 同步会话工作
/workflow:session:complete  # 完成会话

Issue 工作流命令

/issue/new       # 创建新 issue
/issue/plan      # 规划 issue 解决方案
/issue/queue     # 形成执行队列
/issue/execute   # 执行 issue 队列

其他 CLI 命令

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

🏗️ 架构概览

┌─────────────────────────────────────────────────────────────────┐
│                     工作流 Skills                                │
│  📝 workflow:lite-plan / workflow:multi-cli-plan (轻量级)       │
│  📊 workflow:plan / workflow:tdd-plan (会话式)                  │
│  🧪 workflow:test-fix-gen / workflow:test-cycle-execute         │
│  🧠 brainstorm (多角色分析)                                      │
└─────────────────────────────────────────────────────────────────┘
                              ↓
┌─────────────────────────────────────────────────────────────────┐
│                     Team 架构 v2                                 │
│  🤖 基于 role-spec 的 team-worker 智能体执行                     │
│  🔄 内循环框架用于顺序任务处理                                   │
│  📢 消息总线协议与团队协调                                       │
│  🧠 智慧积累 (learnings/decisions/conventions)                   │
└─────────────────────────────────────────────────────────────────┘
                              ↓
┌─────────────────────────────────────────────────────────────────┐
│                     队列调度服务                                  │
│  ⚙️ 后台执行服务与 API 端点                                      │
│  📊 队列管理与统一的 CLI 执行设置                                │
└─────────────────────────────────────────────────────────────────┘
                              ↓
┌─────────────────────────────────────────────────────────────────┐
│                     终端仪表板与编排器                            │
│  🖥️ 多终端网格与执行监控器                                       │
│  🎨 基于模板的工作流编辑器与斜杠命令                             │
│  📡 通过 A2UI 实现实时智能体通信                                 │
└─────────────────────────────────────────────────────────────────┘

📦 项目结构

Claude-Code-Workflow/
├── .claude/
│   ├── agents/          # 22 个专业化智能体 (team-worker, cli-discuss 等)
│   ├── commands/        # 斜杠命令5 个类别)
│   │   ├── ccw.md       # 主编排器
│   │   ├── ccw-coordinator.md
│   │   ├── cli/         # CLI 命令 (cli-init, codex-review)
│   │   ├── issue/       # Issue 管理 (plan, execute, queue)
│   │   ├── memory/      # 内存命令 (prepare, style-skill-memory)
│   │   └── workflow/    # 工作流命令 (session, ui-design 等)
│   └── skills/          # 37 个模块化技能
│       ├── workflow-lite-plan/
│       ├── workflow-plan/
│       ├── workflow-tdd/
│       ├── workflow-test-fix/
│       ├── brainstorm/
│       ├── team-*/      # 团队协调技能
│       └── ...
├── ccw/
│   ├── src/             # TypeScript 源码
│   │   ├── commands/    # CLI 命令实现
│   │   ├── core/        # 核心服务 (a2ui, auth, hooks, routes)
│   │   ├── mcp-server/  # MCP 服务器实现
│   │   └── tools/       # 工具实现
│   └── frontend/        # React 前端(终端仪表板、编排器)
├── codex-lens/          # 本地语义代码搜索引擎
└── docs/                # 文档

🎼 团队节拍控制 (Beat Model)

v2 团队架构引入了事件驱动的节拍模型,实现高效编排:

节拍循环 (单个节拍)
======================================================================
  事件                    协调器                    工作者
----------------------------------------------------------------------
  回调/恢复 --> +- 处理回调 ------+
                |  标记已完成      |
                |  检查流水线      |
                +- 处理下一批 -----+
                |  查找就绪任务    |
                |  生成工作者 -----+--> [team-worker A] 阶段 1-5
                |  (可并行)      --+--> [team-worker B] 阶段 1-5
                +- 停止 (空闲) ----+         |
                                             |
  回调 <--------------------------------------+
  (下一节拍)        SendMessage + TaskUpdate(completed)
======================================================================

核心优势:

  • 🎯 事件驱动:协调器仅在需要时唤醒(回调/恢复)
  • 快速推进:简单后继直接生成,无需协调器往返
  • 🔄 动态流水线:根据依赖图按任务生成
  • 📊 并行执行:独立任务并发运行

🖥️ 前端亮点

终端仪表板 (Terminal Dashboard)

多终端网格布局,实时执行监控。

功能特性:

  • 🖥️ 多终端网格,可调整窗格大小
  • 📊 带智能体列表的执行监控器
  • 📁 项目导航文件侧边栏
  • 🎯 按项目标签分组会话
  • 🌙 全屏/沉浸模式

编排器编辑器 (Orchestrator Editor)

可视化工作流模板编辑器,支持拖放。

功能特性:

  • 🎨 基于 React Flow 的可视化编辑
  • 📦 预构建工作流的模板库
  • 🔧 节点配置属性面板
  • 斜杠命令集成

🤝 贡献

GitHub Issues

📄 许可证

MIT License - 详见 LICENSE


💬 社区交流

欢迎加入 CCW 交流群,与其他开发者一起讨论使用心得、分享经验!

CCW 微信交流群

扫码加入微信交流群(如二维码过期,请提 Issue 获取最新二维码)