mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-05 01:50:27 +08:00
9151a82d1d
主要变更： 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>
97 lines
4.1 KiB
Markdown
97 lines
4.1 KiB
Markdown
# 🚀 Claude Code Workflow (CCW)
|
|
|
|
<div align="center">
|
|
|
|
[](https://github.com/catlog22/Claude-Code-Workflow/releases)
|
|
[](LICENSE)
|
|
[]()
|
|
[](https://github.com/modelcontextprotocol)
|
|
|
|
**Languages:** [English](README.md) | [中文](README_CN.md)
|
|
|
|
</div>
|
|
|
|
---
|
|
|
|
**Claude Code Workflow (CCW)** transforms AI development from simple prompt chaining into a robust, context-first orchestration system. It solves execution uncertainty and error accumulation through structured planning, deterministic execution, and intelligent multi-model orchestration.
|
|
|
|
> **🎉 Latest: v4.6.0** - Concept Clarification & Agent-Driven Analysis. See [CHANGELOG.md](CHANGELOG.md) for details.
|
|
|
|
> 📚 **New to CCW?** Check out the [**Getting Started Guide**](GETTING_STARTED.md) for a beginner-friendly 5-minute tutorial!
|
|
|
|
---
|
|
|
|
## ✨ Core Concepts
|
|
|
|
CCW is built on a set of core principles that differentiate it from traditional AI development approaches:
|
|
|
|
- **Context-First Architecture**: Pre-defined context gathering eliminates execution uncertainty by ensuring agents have the correct information *before* implementation.
|
|
- **JSON-First State Management**: Task states live in `.task/IMPL-*.json` files as the single source of truth, enabling programmatic orchestration without state drift.
|
|
- **Autonomous Multi-Phase Orchestration**: Commands chain specialized sub-commands and agents to automate complex workflows with zero user intervention.
|
|
- **Multi-Model Strategy**: Leverages the unique strengths of different AI models (Gemini for analysis, Codex for implementation) for superior results.
|
|
- **Hierarchical Memory System**: A 4-layer documentation system provides context at the appropriate level of abstraction, preventing information overload.
|
|
- **Specialized Role-Based Agents**: A suite of agents (`@code-developer`, `@test-fix-agent`, etc.) mirrors a real software team to handle diverse tasks.
|
|
|
|
---
|
|
|
|
## ⚙️ Installation
|
|
|
|
For detailed installation instructions, please refer to the [**INSTALL.md**](INSTALL.md) guide.
|
|
|
|
### **🚀 Quick One-Line Installation**
|
|
|
|
**Windows (PowerShell):**
|
|
```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
|
|
bash <(curl -fsSL https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.sh)
|
|
```
|
|
|
|
### **✅ Verify Installation**
|
|
After installation, open **Claude Code** and check if the workflow commands are available by running:
|
|
```bash
|
|
/workflow:session:list
|
|
```
|
|
If the slash commands (e.g., `/workflow:*`) are recognized, the installation was successful.
|
|
|
|
---
|
|
|
|
## 🛠️ Command Reference
|
|
|
|
CCW provides a rich set of commands for managing workflows, tasks, and interacting with AI tools. For a complete list and detailed descriptions of all available commands, please see the [**COMMAND_REFERENCE.md**](COMMAND_REFERENCE.md) file.
|
|
|
|
---
|
|
|
|
## 🚀 Getting Started
|
|
|
|
The best way to get started is to follow the 5-minute tutorial in the [**Getting Started Guide**](GETTING_STARTED.md).
|
|
|
|
Here is a quick example of a common development workflow:
|
|
|
|
1. **Start a Session**:
|
|
```bash
|
|
/workflow:session:start "Implement user login feature"
|
|
```
|
|
2. **Create a Plan**:
|
|
```bash
|
|
/workflow:plan "Implement JWT-based user login and registration"
|
|
```
|
|
3. **Execute the Plan**:
|
|
```bash
|
|
/workflow:execute
|
|
```
|
|
|
|
---
|
|
|
|
## 🤝 Contributing & Support
|
|
|
|
- **Repository**: [GitHub - Claude-Code-Workflow](https://github.com/catlog22/Claude-Code-Workflow)
|
|
- **Issues**: Report bugs or request features on [GitHub Issues](https://github.com/catlog22/Claude-Code-Workflow/issues).
|
|
- **Discussions**: Join the [Community Forum](https://github.com/catlog22/Claude-Code-Workflow/discussions).
|
|
|
|
## 📄 License
|
|
|
|
This project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for details. |