diff --git a/README.md b/README.md index ad20b211..0df036b2 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,74 @@
-# Claude Code Workflow (CCW) + + -[![Version](https://img.shields.io/badge/version-v6.3.33-blue.svg)](https://github.com/catlog22/Claude-Code-Workflow/releases) -[![npm](https://img.shields.io/npm/v/claude-code-workflow.svg)](https://www.npmjs.com/package/claude-code-workflow) -[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE) + +

+ Version + npm + License +

+ +

+ Stars + Forks + Issues +

**[English](README.md) | [中文](README_CN.md)** +
+ + +Typing SVG +
+
+ + +
+ Quick Start + Guide + CLI Tools + Architecture +
+ +
+ --- -**CCW** is a JSON-driven multi-agent development framework with intelligent CLI orchestration. It provides **4-level workflow system** from rapid execution to full brainstorming, transforming AI development into powerful orchestration. - ## ✨ Key Features -| Feature | Description | -|---------|-------------| -| 🎯 **4-Level Workflows** | From `lite-lite-lite` (instant) to `brainstorm` (multi-role analysis) | -| 🔄 **Multi-CLI Orchestration** | Gemini, Qwen, Codex, Claude - auto-select or manual | -| ⚡ **Dependency-Aware Parallelism** | Agent parallel execution without worktree complexity | -| 🔧 **Issue Workflow** | Post-development maintenance with optional worktree isolation | -| 📦 **JSON-First State** | `.task/IMPL-*.json` as single source of truth | -| 🖥️ **Dashboard** | Visual session management, CodexLens search, graph explorer | + + + + + +
+ +### 🎯 4-Level Workflows +From `lite-lite-lite` (instant) to `brainstorm` (multi-role analysis) + +### 🔄 Multi-CLI Orchestration +Gemini, Qwen, Codex, Claude - auto-select or manual + +### ⚡ Dependency-Aware Parallelism +Agent parallel execution without worktree complexity + + + +### 🔧 Issue Workflow +Post-development maintenance with optional worktree isolation + +### 📦 JSON-First State +`.task/IMPL-*.json` as single source of truth + +### 🖥️ Dashboard +Visual session management, CodexLens search, graph explorer + +
> 📖 **New?** See [Workflow Guide](WORKFLOW_GUIDE.md) for the complete 4-level workflow system. @@ -40,15 +85,16 @@ ccw install -m Global ### Choose Your Workflow Level -| Level | Command | Use Case | -|-------|---------|----------| -| ⚡ **1** | `/workflow:lite-lite-lite` | Quick fixes, config changes | -| 📝 **2** | `/workflow:lite-plan` | Clear single-module features | -| 🔧 **2** | `/workflow:lite-fix` | Bug diagnosis and fix | -| 🔍 **2** | `/workflow:multi-cli-plan` | Multi-perspective analysis | -| 📊 **3** | `/workflow:plan` | Multi-module development | -| 🧪 **3** | `/workflow:tdd-plan` | Test-driven development | -| 🧠 **4** | `/workflow:brainstorm:auto-parallel` | New features, architecture design | + + + + + + + + + +
LevelCommandUse Case
1/workflow:lite-lite-liteQuick fixes, config changes
📝 2/workflow:lite-planClear single-module features
🔧 2/workflow:lite-fixBug diagnosis and fix
🔍 2/workflow:multi-cli-planMulti-perspective analysis
📊 3/workflow:planMulti-module development
🧪 3/workflow:tdd-planTest-driven development
🧠 4/workflow:brainstorm:auto-parallelNew features, architecture design
### Workflow Examples @@ -74,20 +120,26 @@ ccw install -m Global ## 🛠️ CLI Tool Installation -CCW supports multiple CLI tools. Install as needed: - -| CLI | Description | Official Docs | -|-----|-------------|---------------| -| 🔷 **Gemini** | Google AI analysis | [google-gemini/gemini-cli](https://github.com/google-gemini/gemini-cli) | -| 🟢 **Codex** | OpenAI autonomous coding | [openai/codex](https://github.com/openai/codex) | -| 🟠 **OpenCode** | Open-source multi-model | [opencode-ai/opencode](https://github.com/opencode-ai/opencode) | -| 🟣 **Qwen** | Alibaba Qwen-Code | [QwenLM/Qwen](https://github.com/QwenLM) | + + + + + + +
CLIDescriptionOfficial Docs
🔷 GeminiGoogle AI analysisgoogle-gemini/gemini-cli
🟢 CodexOpenAI autonomous codingopenai/codex
🟠 OpenCodeOpen-source multi-modelopencode-ai/opencode
🟣 QwenAlibaba Qwen-CodeQwenLM/Qwen
--- ## 🎭 Semantic CLI Invocation -Users can **semantically specify CLI tools** in prompts - the system automatically invokes the corresponding CLI for analysis. +
+ + +
+ +
+ +Users can **semantically specify CLI tools** in prompts - the system automatically invokes the corresponding CLI. ### Basic Invocation @@ -99,8 +151,6 @@ Users can **semantically specify CLI tools** in prompts - the system automatical ### Multi-CLI Orchestration -Users can semantically orchestrate multiple CLIs in a single prompt: - | Pattern | User Prompt Example | |---------|---------------------| | 🔄 **Collaborative** | "Use Gemini and Codex to collaboratively analyze security vulnerabilities" | @@ -108,7 +158,8 @@ Users can semantically orchestrate multiple CLIs in a single prompt: | 🔁 **Iterative** | "Use Gemini to diagnose, then Codex to fix, iterate until resolved" | | 🔗 **Pipeline** | "Gemini designs the solution, Codex implements, Claude reviews" | -### Examples +
+📝 More Examples ```text # Single CLI invocation @@ -128,7 +179,7 @@ User: "Use Gemini to plan the refactoring, then Codex to implement it" → System auto-calls: gemini (plan) → codex (implement) sequentially ``` -> 💡 **Key**: Just describe which CLI to use and what to do - CCW handles the invocation automatically. +
### Custom CLI Registration @@ -144,16 +195,6 @@ ccw view # Open Dashboard → Status → API Settings → Add Custom CLI | **Endpoint** | `https://api.deepseek.com/v1/chat` | | **API Key** | `your-api-key` | -After registration, use it semantically like built-in CLIs: - -```text -User: "Use DeepSeek to analyze this algorithm complexity" -→ System auto-calls: deepseek CLI (your custom endpoint) - -User: "Let DeepSeek and Gemini compare their analysis results" -→ System auto-calls: deepseek + gemini in parallel -``` - > ⚙️ Register once, invoke semantically forever - no code changes needed. --- @@ -173,15 +214,15 @@ ACE (Augment Context Engine) provides powerful semantic code search. > ⚠️ **In Development**: CodexLens is under iterative optimization. Some features may be unstable. -CodexLens provides local code indexing and search without external APIs: + + + + + +
Search ModeDescription
🔤 FTSFull-text search, based on SQLite FTS5
🧠 SemanticSemantic search, using local embedding models
🔀 HybridHybrid search, combining FTS + Semantic + Reranking
-| Search Mode | Description | -|-------------|-------------| -| 🔤 **FTS** | Full-text search, based on SQLite FTS5 | -| 🧠 **Semantic** | Semantic search, using local embedding models | -| 🔀 **Hybrid** | Hybrid search, combining FTS + Semantic + Reranking | - -### Installation +
+📦 Installation ```bash # Enter codex-lens directory @@ -194,10 +235,10 @@ pip install -e . codexlens index /path/to/project ``` -### Dashboard Integration - Open Dashboard via `ccw view`, manage indexes and execute searches in **CodexLens Manager**. +
+ --- ## 💻 CCW CLI Commands @@ -211,12 +252,13 @@ ccw upgrade -a # Upgrade all installations ### Dashboard Features -| Feature | Description | -|---------|-------------| -| 📊 **Session Overview** | Track workflow sessions and progress | -| 🔍 **CodexLens** | FTS + Semantic + Hybrid code search | -| 🕸️ **Graph Explorer** | Interactive code relationship visualization | -| 📜 **CLI Manager** | Execution history with session resume | + + + + + + +
FeatureDescription
📊 Session OverviewTrack workflow sessions and progress
🔍 CodexLensFTS + Semantic + Hybrid code search
🕸️ Graph ExplorerInteractive code relationship visualization
📜 CLI ManagerExecution history with session resume
--- @@ -258,10 +300,23 @@ ccw upgrade -a # Upgrade all installations ## 🤝 Contributing -- **Repository**: [GitHub](https://github.com/catlog22/Claude-Code-Workflow) -- **Issues**: [Report bugs or request features](https://github.com/catlog22/Claude-Code-Workflow/issues) -- **Contributing**: See [CONTRIBUTING.md](CONTRIBUTING.md) +
+ GitHub + Issues + Contributing +
+ +--- ## 📄 License +
+ MIT License - see [LICENSE](LICENSE) + +
+ + + + +
diff --git a/README_CN.md b/README_CN.md index 382443e5..301118c5 100644 --- a/README_CN.md +++ b/README_CN.md @@ -1,35 +1,80 @@
-# Claude Code Workflow (CCW) + + -[![Version](https://img.shields.io/badge/version-v6.3.33-blue.svg)](https://github.com/catlog22/Claude-Code-Workflow/releases) -[![npm](https://img.shields.io/npm/v/claude-code-workflow.svg)](https://www.npmjs.com/package/claude-code-workflow) -[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE) + +

+ Version + npm + License +

+ +

+ Stars + Forks + Issues +

**[English](README.md) | [中文](README_CN.md)** +
+ + +Typing SVG +
+
+ + +
+ Quick Start + Guide + CLI Tools + Architecture +
+ +
+ --- -**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 级工作流 +从 `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 @@ -40,15 +85,16 @@ 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` | 新功能、架构设计 | + + + + + + + + + +
级别命令使用场景
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新功能、架构设计
### 工作流示例 @@ -74,20 +120,26 @@ ccw install -m Global ## 🛠️ CLI 工具安装 -CCW 支持多种 CLI 工具,按需安装: - -| CLI | 说明 | 官方文档 | -|-----|------|----------| -| 🔷 **Gemini** | Google AI 分析 | [google-gemini/gemini-cli](https://github.com/google-gemini/gemini-cli) | -| 🟢 **Codex** | OpenAI 自主编码 | [openai/codex](https://github.com/openai/codex) | -| 🟠 **OpenCode** | 开源多模型 | [opencode-ai/opencode](https://github.com/opencode-ai/opencode) | -| 🟣 **Qwen** | 阿里云 Qwen-Code | [QwenLM/Qwen](https://github.com/QwenLM) | + + + + + + +
CLI说明官方文档
🔷 GeminiGoogle AI 分析google-gemini/gemini-cli
🟢 CodexOpenAI 自主编码openai/codex
🟠 OpenCode开源多模型opencode-ai/opencode
🟣 Qwen阿里云 Qwen-CodeQwenLM/Qwen
--- ## 🎭 语义化 CLI 调用 -用户可以在提示词中 **语义指定 CLI 工具** - 系统自动调用对应的 CLI 进行分析。 +
+ + +
+ +
+ +用户可以在提示词中 **语义指定 CLI 工具** - 系统自动调用对应的 CLI。 ### 基础调用 @@ -99,8 +151,6 @@ CCW 支持多种 CLI 工具,按需安装: ### 多 CLI 编排 -用户可以在单个提示词中语义编排多个 CLI: - | 模式 | 用户提示词示例 | |------|----------------| | 🔄 **协同分析** | "使用 Gemini 和 Codex 协同分析安全漏洞" | @@ -108,7 +158,8 @@ CCW 支持多种 CLI 工具,按需安装: | 🔁 **迭代优化** | "用 Gemini 诊断问题,然后 Codex 修复,迭代直到解决" | | 🔗 **流水线** | "Gemini 设计方案,Codex 实现,Claude 审查" | -### 示例 +
+📝 更多示例 ```text # 单 CLI 调用 @@ -128,7 +179,7 @@ CCW 支持多种 CLI 工具,按需安装: → 系统自动调用: gemini(规划)→ codex(实现)顺序执行 ``` -> 💡 **核心**:只需描述使用哪个 CLI 做什么 - CCW 自动处理调用。 +
### 自定义 CLI 注册 @@ -144,21 +195,11 @@ ccw view # 打开 Dashboard → Status → API Settings → 添加自定义 CLI | **端点** | `https://api.deepseek.com/v1/chat` | | **API Key** | `your-api-key` | -注册后即可像内置 CLI 一样语义调用: - -```text -用户: "使用 DeepSeek 分析这个算法复杂度" -→ 系统自动调用: deepseek CLI(你的自定义端点) - -用户: "让 DeepSeek 和 Gemini 对比分析结果" -→ 系统自动调用: deepseek + gemini 并行执行 -``` - > ⚙️ 注册一次,永久语义调用 - 无需修改代码。 --- -## ACE Tool 配置 +## 🔍 ACE Tool 配置 ACE (Augment Context Engine) 提供强大的语义代码搜索能力。 @@ -169,19 +210,19 @@ ACE (Augment Context Engine) 提供强大的语义代码搜索能力。 --- -## CodexLens 本地搜索 +## 📚 CodexLens 本地搜索 > ⚠️ **开发中**: CodexLens 正在迭代优化中,部分功能可能不稳定。 -CodexLens 提供本地代码索引和搜索能力,无需外部 API: + + + + + +
搜索模式说明
🔤 FTS全文搜索,基于 SQLite FTS5
🧠 Semantic语义搜索,基于本地嵌入模型
🔀 Hybrid混合搜索,结合 FTS + 语义 + 重排序
-| 搜索模式 | 说明 | -|----------|------| -| **FTS** | 全文搜索,基于 SQLite FTS5 | -| **Semantic** | 语义搜索,基于本地嵌入模型 | -| **Hybrid** | 混合搜索,结合 FTS + 语义 + 重排序 | - -### 安装 +
+📦 安装 ```bash # 进入 codex-lens 目录 @@ -194,13 +235,13 @@ pip install -e . codexlens index /path/to/project ``` -### Dashboard 集成 - 通过 `ccw view` 打开 Dashboard,在 **CodexLens Manager** 中管理索引和执行搜索。 +
+ --- -## CCW CLI 命令 +## 💻 CCW CLI 命令 ```bash ccw install # 安装工作流文件 @@ -211,55 +252,71 @@ ccw upgrade -a # 升级所有安装 ### Dashboard 功能 -- **会话概览** - 跟踪工作流会话和进度 -- **CodexLens** - FTS + 语义 + 混合代码搜索 -- **图浏览器** - 交互式代码关系可视化 -- **CLI 管理器** - 执行历史与会话恢复 + + + + + + +
功能说明
📊 会话概览跟踪工作流会话和进度
🔍 CodexLensFTS + 语义 + 混合代码搜索
🕸️ 图浏览器交互式代码关系可视化
📜 CLI 管理器执行历史与会话恢复
--- -## 文档 +## 📖 文档 | 文档 | 说明 | |------|------| -| [**工作流指南**](WORKFLOW_GUIDE_CN.md) | 4 级工作流系统(推荐) | -| [**快速开始**](GETTING_STARTED_CN.md) | 5 分钟快速入门 | -| [**Dashboard 指南**](DASHBOARD_GUIDE.md) | Dashboard 用户指南 | -| [**常见问题**](FAQ.md) | 常见问题解答 | -| [**更新日志**](CHANGELOG.md) | 版本历史 | +| 📘 [**工作流指南**](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 (→ lite-execute)│ -│ Level 3: plan / tdd-plan / test-fix-gen (Session 持久化) │ -│ Level 4: brainstorm:auto-parallel → plan → execute │ +│ ⚡ 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 隔离) │ +│ 🔍 discover → 📋 plan → 📦 queue → ▶️ execute (worktree) │ └─────────────────────────────────────────────────────────────────┘ ``` **核心原则:** -- **依赖分析** 解决并行问题 - 主干工作流无需 worktree -- **Issue 工作流** 补充主干工作流,用于开发后维护 -- 根据复杂度选择工作流级别 - 避免过度工程化 +- ⚡ **依赖分析** 解决并行问题 - 主干工作流无需 worktree +- 🔧 **Issue 工作流** 补充主干工作流,用于开发后维护 +- 🎯 根据复杂度选择工作流级别 - 避免过度工程化 --- -## 贡献 +## 🤝 贡献 -- **仓库**: [GitHub](https://github.com/catlog22/Claude-Code-Workflow) -- **问题**: [报告 Bug 或请求功能](https://github.com/catlog22/Claude-Code-Workflow/issues) -- **贡献**: 查看 [CONTRIBUTING.md](CONTRIBUTING.md) +
+ GitHub + Issues + Contributing +
-## 许可证 +--- + +## 📄 许可证 + +
MIT License - 详见 [LICENSE](LICENSE) + +
+ + + + +