Files
Claude-Code-Workflow/README.md
catlog22 164d1df341 docs: 更新文档以反映v5.4.0版本更新
更新内容:
- CHANGELOG.md:添加v5.4.0完整更新日志
  - CLI模板系统重组(19个模板,优先级前缀)
  - Gemini 404错误回退策略
  - 21处模板引用更新
  - 目录结构优化

- README.md & README_CN.md:更新版本号和核心亮点
  - 版本徽章:v5.2.0 → v5.4.0
  - 版本说明:更新为v5.4核心改进
  - 突出优先级模板、错误处理、统一引用、组织优化

文档变更详情:
- 完整的v5.4.0变更日志(141行)
- 双语README版本信息同步更新
- 清晰的升级说明和使用指南

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-06 11:07:43 +08:00

106 lines
4.5 KiB
Markdown

# 🚀 Claude Code Workflow (CCW)
<div align="center">
[![Version](https://img.shields.io/badge/version-v5.4.0-blue.svg)](https://github.com/catlog22/Claude-Code-Workflow/releases)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20Linux%20%7C%20macOS-lightgrey.svg)]()
**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.
> **🎉 Version 5.4: CLI Template System Reorganization**
>
> **Core Improvements**:
> - ✅ **Priority-Based Templates** - 19 templates reorganized with clear priority prefixes (01-universal, 02-specialized, 03-domain)
> - ✅ **Enhanced Error Handling** - Automatic Gemini 404 fallback to gemini-2.5-pro
> - ✅ **Unified References** - All 21 template references updated across 5 command files
> - ✅ **Better Organization** - Bug diagnosis moved to analysis/, redundant directories removed
>
> See [CHANGELOG.md](CHANGELOG.md) for full 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.
For a detailed technical specification of every command, see the [**COMMAND_SPEC.md**](COMMAND_SPEC.md).
---
## 🚀 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. **Create a Plan** (automatically starts a session):
```bash
/workflow:plan "Implement JWT-based user login and registration"
```
2. **Execute the Plan**:
```bash
/workflow:execute
```
3. **Check Status** (optional):
```bash
/workflow:status
```
---
## 🤝 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.