Files
Claude-Code-Workflow/README_CN.md
catlog22 9151a82d1d docs: 优化 README 文档并创建命令参考文档
主要变更:
1. 精简 README.md 和 README_CN.md 结构
   - 移除冗长的功能描述和安装细节
   - 合并理念章节为"核心概念"
   - 简化安装说明,链接到详细 INSTALL.md
   - 移除详细命令列表,链接到新的 COMMAND_REFERENCE.md

2. 创建 COMMAND_REFERENCE.md
   - 完整的命令列表和分类
   - 按功能组织(Workflow, CLI, Task, Memory, UI Design, Testing)
   - 包含所有遗漏的命令(UI 设计、测试工作流等)

3. 创建 COMMAND_SPEC.md
   - 详细的命令技术规范
   - 包含参数、职责、Agent 调用、Skill 调用
   - 实际使用示例
   - 命令间的工作流集成说明

4. 修正 Critical 级别问题
   - 统一仓库 URL 为 Claude-Code-Workflow
   - 更新 INSTALL.md 中的过时信息

5. 文档引用优化
   - 在 README 中添加到 COMMAND_REFERENCE.md 和 COMMAND_SPEC.md 的链接
   - 保持中英文文档结构一致

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-18 23:37:24 +08:00

3.9 KiB
Raw Blame History

🚀 Claude Code Workflow (CCW)

Version License Platform MCP Tools

语言: English | 中文


Claude Code Workflow (CCW) 将 AI 开发从简单的提示词链接转变为一个强大的、上下文优先的编排系统。它通过结构化规划、确定性执行和智能多模型编排,解决了执行不确定性和误差累积的问题。

🎉 最新版本: v4.6.0 - 概念澄清与智能体驱动分析。详见 CHANGELOG.md

📚 第一次使用 CCW 查看 快速上手指南 获取新手友好的 5 分钟教程!


核心概念

CCW 构建在一系列核心原则之上,这些原则使其与传统的 AI 开发方法区别开来:

  • 上下文优先架构: 通过预定义的上下文收集,消除了执行过程中的不确定性,确保智能体在实现之前就拥有正确的信息。
  • JSON 优先的状态管理: 任务状态完全存储在 .task/IMPL-*.json 文件中,作为唯一的事实来源,实现了无需状态漂移的程序化编排。
  • 自主多阶段编排: 命令链式调用专门的子命令和智能体,以零用户干预的方式自动化复杂的工作流。
  • 多模型策略: 充分利用不同 AI 模型(如 Gemini 用于分析Codex 用于实现)的独特优势,以获得更优越的结果。
  • 分层内存系统: 一个 4 层文档系统,在适当的抽象级别上提供上下文,防止信息过载。
  • 专门的基于角色的智能体: 一套模拟真实软件团队的智能体(@code-developer, @test-fix-agent 等),用于处理多样化的任务。

⚙️ 安装

有关详细的安装说明,请参阅 INSTALL_CN.md 指南。

🚀 一键快速安装

Windows (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 <(curl -fsSL https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.sh)

验证安装

安装后,打开 Claude Code 并通过运行以下命令检查工作流命令是否可用:

/workflow:session:list

如果斜杠命令(例如 /workflow:*)被识别,则表示安装成功。


🛠️ 命令参考

CCW 提供了一套丰富的命令,用于管理工作流、任务以及与 AI 工具的交互。有关所有可用命令的完整列表和详细说明,请参阅 COMMAND_REFERENCE.md 文件。


🚀 快速入门

开始使用的最佳方式是遵循 快速上手指南 中的 5 分钟教程。

以下是一个常见开发工作流的快速示例:

  1. 启动会话:
    /workflow:session:start "实现用户登录功能"
    
  2. 创建计划:
    /workflow:plan "实现基于 JWT 的用户登录和注册"
    
  3. 执行计划:
    /workflow:execute
    

🤝 贡献与支持

📄 许可证

此项目根据 MIT 许可证 授权。详见 LICENSE 文件。