mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-05 01:50:27 +08:00
docs: 重新设计酷炫主页
- 添加渐变动画 Header (capsule-render) - 添加打字动画效果 (typing-svg) - 使用 for-the-badge 风格徽章 - 添加 Stars/Forks/Issues 统计 - 使用 HTML 表格优化布局 - 添加快速导航按钮 - 使用折叠面板整理长内容 - 添加渐变动画 Footer
This commit is contained in:
catlog22
185
README.md
185
README.md
@@ -1,29 +1,74 @@
|
||||
<div align="center">
|
||||
|
||||
# Claude Code Workflow (CCW)
|
||||
<!-- Animated Header -->
|
||||
<img src="https://capsule-render.vercel.app/api?type=waving&color=gradient&customColorList=6,11,20&height=180§ion=header&text=Claude%20Code%20Workflow&fontSize=42&fontColor=fff&animation=twinkling&fontAlignY=32&desc=Multi-Agent%20AI%20Development%20Framework&descAlignY=52&descSize=18"/>
|
||||
|
||||
[](https://github.com/catlog22/Claude-Code-Workflow/releases)
|
||||
[](https://www.npmjs.com/package/claude-code-workflow)
|
||||
[](LICENSE)
|
||||
<!-- Badges -->
|
||||
<p>
|
||||
<a href="https://github.com/catlog22/Claude-Code-Workflow/releases"><img src="https://img.shields.io/badge/version-v6.3.33-blue?style=for-the-badge&logo=semanticrelease" alt="Version"/></a>
|
||||
<a href="https://www.npmjs.com/package/claude-code-workflow"><img src="https://img.shields.io/npm/v/claude-code-workflow?style=for-the-badge&logo=npm&logoColor=white&color=cb3837" alt="npm"/></a>
|
||||
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-green?style=for-the-badge&logo=opensourceinitiative&logoColor=white" alt="License"/></a>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<a href="https://github.com/catlog22/Claude-Code-Workflow/stargazers"><img src="https://img.shields.io/github/stars/catlog22/Claude-Code-Workflow?style=for-the-badge&logo=github&color=yellow" alt="Stars"/></a>
|
||||
<a href="https://github.com/catlog22/Claude-Code-Workflow/network/members"><img src="https://img.shields.io/github/forks/catlog22/Claude-Code-Workflow?style=for-the-badge&logo=github&color=lightgray" alt="Forks"/></a>
|
||||
<a href="https://github.com/catlog22/Claude-Code-Workflow/issues"><img src="https://img.shields.io/github/issues/catlog22/Claude-Code-Workflow?style=for-the-badge&logo=github&color=red" alt="Issues"/></a>
|
||||
</p>
|
||||
|
||||
**[English](README.md) | [中文](README_CN.md)**
|
||||
|
||||
<br/>
|
||||
|
||||
<!-- Typing Animation -->
|
||||
<a href="https://git.io/typing-svg"><img src="https://readme-typing-svg.demolab.com?font=Fira+Code&weight=600&size=22&pause=1000&color=6366F1¢er=true&vCenter=true&random=false&width=600&lines=JSON-Driven+Multi-Agent+Framework;4-Level+Workflow+System;Semantic+CLI+Orchestration;Gemini+%7C+Codex+%7C+Qwen+%7C+Claude" alt="Typing SVG" /></a>
|
||||
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
||||
<!-- Quick Links -->
|
||||
<div align="center">
|
||||
<a href="#-quick-start"><img src="https://img.shields.io/badge/🚀_Quick_Start-4285F4?style=flat-square" alt="Quick Start"/></a>
|
||||
<a href="WORKFLOW_GUIDE.md"><img src="https://img.shields.io/badge/📖_Workflow_Guide-34A853?style=flat-square" alt="Guide"/></a>
|
||||
<a href="#-cli-tool-installation"><img src="https://img.shields.io/badge/🛠️_CLI_Tools-EA4335?style=flat-square" alt="CLI Tools"/></a>
|
||||
<a href="#-architecture"><img src="https://img.shields.io/badge/🏗️_Architecture-FBBC05?style=flat-square" alt="Architecture"/></a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
||||
---
|
||||
|
||||
**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 |
|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
|
||||
### 🎯 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
|
||||
|
||||
</td>
|
||||
<td width="50%">
|
||||
|
||||
### 🔧 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
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
> 📖 **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 |
|
||||
<table>
|
||||
<tr><th>Level</th><th>Command</th><th>Use Case</th></tr>
|
||||
<tr><td>⚡ <b>1</b></td><td><code>/workflow:lite-lite-lite</code></td><td>Quick fixes, config changes</td></tr>
|
||||
<tr><td>📝 <b>2</b></td><td><code>/workflow:lite-plan</code></td><td>Clear single-module features</td></tr>
|
||||
<tr><td>🔧 <b>2</b></td><td><code>/workflow:lite-fix</code></td><td>Bug diagnosis and fix</td></tr>
|
||||
<tr><td>🔍 <b>2</b></td><td><code>/workflow:multi-cli-plan</code></td><td>Multi-perspective analysis</td></tr>
|
||||
<tr><td>📊 <b>3</b></td><td><code>/workflow:plan</code></td><td>Multi-module development</td></tr>
|
||||
<tr><td>🧪 <b>3</b></td><td><code>/workflow:tdd-plan</code></td><td>Test-driven development</td></tr>
|
||||
<tr><td>🧠 <b>4</b></td><td><code>/workflow:brainstorm:auto-parallel</code></td><td>New features, architecture design</td></tr>
|
||||
</table>
|
||||
|
||||
### 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) |
|
||||
<table>
|
||||
<tr><th>CLI</th><th>Description</th><th>Official Docs</th></tr>
|
||||
<tr><td>🔷 <b>Gemini</b></td><td>Google AI analysis</td><td><a href="https://github.com/google-gemini/gemini-cli">google-gemini/gemini-cli</a></td></tr>
|
||||
<tr><td>🟢 <b>Codex</b></td><td>OpenAI autonomous coding</td><td><a href="https://github.com/openai/codex">openai/codex</a></td></tr>
|
||||
<tr><td>🟠 <b>OpenCode</b></td><td>Open-source multi-model</td><td><a href="https://github.com/opencode-ai/opencode">opencode-ai/opencode</a></td></tr>
|
||||
<tr><td>🟣 <b>Qwen</b></td><td>Alibaba Qwen-Code</td><td><a href="https://github.com/QwenLM">QwenLM/Qwen</a></td></tr>
|
||||
</table>
|
||||
|
||||
---
|
||||
|
||||
## 🎭 Semantic CLI Invocation
|
||||
|
||||
Users can **semantically specify CLI tools** in prompts - the system automatically invokes the corresponding CLI for analysis.
|
||||
<div align="center">
|
||||
<img src="https://img.shields.io/badge/Just_Describe-What_You_Want-6366F1?style=for-the-badge"/>
|
||||
<img src="https://img.shields.io/badge/CCW_Handles-The_Rest-10B981?style=for-the-badge"/>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
||||
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
|
||||
<details>
|
||||
<summary><b>📝 More Examples</b></summary>
|
||||
|
||||
```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.
|
||||
</details>
|
||||
|
||||
### 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:
|
||||
<table>
|
||||
<tr><th>Search Mode</th><th>Description</th></tr>
|
||||
<tr><td>🔤 <b>FTS</b></td><td>Full-text search, based on SQLite FTS5</td></tr>
|
||||
<tr><td>🧠 <b>Semantic</b></td><td>Semantic search, using local embedding models</td></tr>
|
||||
<tr><td>🔀 <b>Hybrid</b></td><td>Hybrid search, combining FTS + Semantic + Reranking</td></tr>
|
||||
</table>
|
||||
|
||||
| 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
|
||||
<details>
|
||||
<summary><b>📦 Installation</b></summary>
|
||||
|
||||
```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**.
|
||||
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
## 💻 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 |
|
||||
<table>
|
||||
<tr><th>Feature</th><th>Description</th></tr>
|
||||
<tr><td>📊 <b>Session Overview</b></td><td>Track workflow sessions and progress</td></tr>
|
||||
<tr><td>🔍 <b>CodexLens</b></td><td>FTS + Semantic + Hybrid code search</td></tr>
|
||||
<tr><td>🕸️ <b>Graph Explorer</b></td><td>Interactive code relationship visualization</td></tr>
|
||||
<tr><td>📜 <b>CLI Manager</b></td><td>Execution history with session resume</td></tr>
|
||||
</table>
|
||||
|
||||
---
|
||||
|
||||
@@ -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)
|
||||
<div align="center">
|
||||
<a href="https://github.com/catlog22/Claude-Code-Workflow"><img src="https://img.shields.io/badge/GitHub-Repository-181717?style=for-the-badge&logo=github" alt="GitHub"/></a>
|
||||
<a href="https://github.com/catlog22/Claude-Code-Workflow/issues"><img src="https://img.shields.io/badge/Issues-Report_Bug-FF6B6B?style=for-the-badge&logo=github" alt="Issues"/></a>
|
||||
<a href="CONTRIBUTING.md"><img src="https://img.shields.io/badge/Contributing-Guide-4CAF50?style=for-the-badge&logo=github" alt="Contributing"/></a>
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## 📄 License
|
||||
|
||||
<div align="center">
|
||||
|
||||
MIT License - see [LICENSE](LICENSE)
|
||||
|
||||
<br/>
|
||||
|
||||
<!-- Footer -->
|
||||
<img src="https://capsule-render.vercel.app/api?type=waving&color=gradient&customColorList=6,11,20&height=100§ion=footer"/>
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user