mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-05 01:50:27 +08:00
958567e35a
版本更新: v5.4.0 → v5.5.0 核心改进: - ✨ 命令指南技能 - 支持 CCW-help 和 CCW-issue 关键词触发 - ✨ 增强命令描述 - 所有 69 个命令更新了详细功能说明 - ✨ 5 索引命令系统 - 按分类、使用场景、关系和核心命令组织 - ✨ 智能推荐 - 基于上下文的下一步操作建议 文档更新: - README.md / README_CN.md: 新增"需要帮助？"章节，介绍 CCW-help/CCW-issue 用法 - CHANGELOG.md: 添加完整的 v5.5.0 版本说明（109行详细内容） - SKILL.md: 更新版本至 v1.1.0 命令指南功能: - 🔍 智能命令搜索 - 按关键词、分类或场景查找 - 🤖 下一步推荐 - 工作流引导和上下文建议 - 📖 详细文档 - 参数、示例和最佳实践 - 🎓 新手入门 - 14 个核心命令学习路径 - 📝 问题报告 - 标准化 bug 报告和功能请求模板 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
135 lines
5.6 KiB
Markdown
135 lines
5.6 KiB
Markdown
# 🚀 Claude Code Workflow (CCW)
|
|
|
|
<div align="center">
|
|
|
|
[](https://github.com/catlog22/Claude-Code-Workflow/releases)
|
|
[](LICENSE)
|
|
[]()
|
|
|
|
**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.5: Interactive Command Guide & Enhanced Documentation**
|
|
>
|
|
> **Core Improvements**:
|
|
> - ✨ **Command-Guide Skill** - Interactive help system with CCW-help and CCW-issue triggers
|
|
> - ✨ **Enhanced Command Descriptions** - All 69 commands updated with detailed functionality descriptions
|
|
> - ✨ **5-Index Command System** - Organized by category, use-case, relationships, and essentials
|
|
> - ✨ **Smart Recommendations** - Context-aware next-step suggestions for workflow guidance
|
|
>
|
|
> 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).
|
|
|
|
---
|
|
|
|
### 💡 **Need Help? Use the Interactive Command Guide**
|
|
|
|
CCW includes a built-in **command-guide skill** to help you discover and use commands effectively:
|
|
|
|
- **`CCW-help`** - Get interactive help and command recommendations
|
|
- **`CCW-issue`** - Report bugs or request features with guided templates
|
|
|
|
The command guide provides:
|
|
- 🔍 **Smart Command Search** - Find commands by keyword, category, or use-case
|
|
- 🤖 **Next-Step Recommendations** - Get suggestions for what to do after any command
|
|
- 📖 **Detailed Documentation** - View parameters, examples, and best practices
|
|
- 🎓 **Beginner Onboarding** - Learn the top 14 essential commands with a guided learning path
|
|
- 📝 **Issue Reporting** - Generate standardized bug reports and feature requests
|
|
|
|
**Example Usage**:
|
|
```
|
|
User: "CCW-help"
|
|
→ Interactive menu with command search, recommendations, and documentation
|
|
|
|
User: "What's next after /workflow:plan?"
|
|
→ Recommends /workflow:execute, /workflow:action-plan-verify, with workflow patterns
|
|
|
|
User: "CCW-issue"
|
|
→ Guided template generation for bugs, features, or questions
|
|
```
|
|
|
|
---
|
|
|
|
## 🚀 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.
|