mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-05 01:50:27 +08:00
62ffc5c645
Major improvements to workflow understanding and guidance: 1. New Document: WORKFLOW_DECISION_GUIDE.md - Comprehensive decision flowchart for full software lifecycle - Interactive Mermaid diagram with 40+ decision points - Clear guidance on when to use each command - Real-world scenarios for all workflow types - Quick reference tables by knowledge level, project stage, and mode - Expert tips and common pitfalls 2. Clarified Brainstorm vs Plan Relationship Core concept correction: - Brainstorm: Use when you know WHAT to build, NOT HOW - Plan: Use when you know both WHAT and HOW - Plan can accept user input OR brainstorm output 3. Updated Documentation Files - GETTING_STARTED.md: Added clear distinction and decision criteria - GETTING_STARTED_CN.md: Chinese version with same clarifications - FAQ.md: Enhanced brainstorm usage explanation with workflow comparison table - README.md: Added Workflow Decision Guide link - README_CN.md: Added Chinese link to decision guide 4. Key Improvements When to Use Brainstorming: - Unclear solution approach (multiple ways to solve) - Architectural exploration needed - Requirements clarification (high-level clear, details not) - Multiple trade-offs to analyze - Unfamiliar domain When to Skip Brainstorming: - Clear implementation approach - Similar to existing code patterns - Well-defined requirements - Simple features 5. Decision Flowchart Covers: - Ideation phase (know what to build?) - Design phase (know how to build?) - UI design phase (need UI design?) - Planning phase (complexity level?) - Testing phase (TDD, post-test, test-fix?) - Review phase (security, architecture, quality?) - Completion Benefits: - Eliminates confusion about brainstorm usage - Provides clear decision criteria for all commands - Visual flowchart helps users navigate workflows - Comprehensive coverage of all development stages - Reduces trial-and-error in workflow selection Files modified: 5 Files added: 1 (WORKFLOW_DECISION_GUIDE.md)
199 lines
8.6 KiB
Markdown
199 lines
8.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.8.1: Lite-Plan Workflow & CLI Tools Enhancement**
|
|
>
|
|
> **Core Improvements**:
|
|
> - ✨ **Lite-Plan Workflow** (`/workflow:lite-plan`) - Lightweight interactive planning with intelligent automation
|
|
> - **Three-Dimensional Multi-Select Confirmation**: Task approval + Execution method + Code review tool
|
|
> - **Smart Code Exploration**: Auto-detects when codebase context is needed (use `-e` flag to force)
|
|
> - **Parallel Task Execution**: Identifies independent tasks for concurrent execution
|
|
> - **Flexible Execution**: Choose between Agent (@code-developer) or CLI (Gemini/Qwen/Codex)
|
|
> - **Optional Post-Review**: Built-in code quality analysis with your choice of AI tool
|
|
> - ✨ **CLI Tools Optimization** - Simplified command syntax with auto-model-selection
|
|
> - Removed `-m` parameter requirement for Gemini, Qwen, and Codex (auto-selects best model)
|
|
> - Clearer command structure and improved documentation
|
|
> - 🔄 **Execution Workflow Enhancement** - Streamlined phases with lazy loading strategy
|
|
> - 🎨 **CLI Explore Agent** - Improved visibility with yellow color scheme
|
|
>
|
|
> 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:
|
|
|
|
### **Option 1: Lite-Plan Workflow** (⚡ Recommended for Quick Tasks)
|
|
|
|
Lightweight interactive workflow with in-memory planning and immediate execution:
|
|
|
|
```bash
|
|
# Basic usage with auto-detection
|
|
/workflow:lite-plan "Add JWT authentication to user login"
|
|
|
|
# Force code exploration
|
|
/workflow:lite-plan -e "Refactor logging module for better performance"
|
|
|
|
# Basic usage
|
|
/workflow:lite-plan "Add unit tests for auth service"
|
|
```
|
|
|
|
**Interactive Flow**:
|
|
1. **Phase 1**: Automatic task analysis and smart code exploration (if needed)
|
|
2. **Phase 2**: Answer clarification questions (if any)
|
|
3. **Phase 3**: Review generated plan with task breakdown
|
|
4. **Phase 4**: Three-dimensional confirmation:
|
|
- ✅ Confirm/Modify/Cancel task
|
|
- 🔧 Choose execution: Agent / Provide Plan / CLI (Gemini/Qwen/Codex)
|
|
- 🔍 Optional code review: No / Claude / Gemini / Qwen / Codex
|
|
5. **Phase 5**: Watch real-time execution with live task tracking
|
|
|
|
### **Option 2: Full Workflow** (Comprehensive Planning)
|
|
|
|
Traditional multi-phase workflow for complex projects:
|
|
|
|
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
|
|
```
|
|
|
|
---
|
|
|
|
## 📚 Documentation
|
|
|
|
CCW provides comprehensive documentation to help you get started and master advanced features:
|
|
|
|
### 📖 **Getting Started**
|
|
- [**Getting Started Guide**](GETTING_STARTED.md) - 5-minute quick start tutorial
|
|
- [**Installation Guide**](INSTALL.md) - Detailed installation instructions ([中文](INSTALL_CN.md))
|
|
- [**Workflow Decision Guide**](WORKFLOW_DECISION_GUIDE.md) - 🌳 Interactive flowchart for choosing the right commands
|
|
- [**Examples**](EXAMPLES.md) - Real-world use cases and practical examples
|
|
- [**FAQ**](FAQ.md) - Frequently asked questions and troubleshooting
|
|
|
|
### 🏗️ **Architecture & Design**
|
|
- [**Architecture Overview**](ARCHITECTURE.md) - System design and core components
|
|
- [**Project Introduction**](PROJECT_INTRODUCTION.md) - Detailed project overview (中文)
|
|
- [**Workflow Diagrams**](WORKFLOW_DIAGRAMS.md) - Visual workflow representations
|
|
|
|
### 📋 **Command Reference**
|
|
- [**Command Reference**](COMMAND_REFERENCE.md) - Complete list of all commands
|
|
- [**Command Specification**](COMMAND_SPEC.md) - Detailed technical specifications
|
|
- [**Command Flow Standard**](COMMAND_FLOW_STANDARD.md) - Command design patterns
|
|
|
|
### 🤝 **Contributing**
|
|
- [**Contributing Guide**](CONTRIBUTING.md) - How to contribute to CCW
|
|
- [**Changelog**](CHANGELOG.md) - Version history and release notes
|
|
|
|
---
|
|
|
|
## 🤝 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).
|
|
- **Contributing**: See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.
|
|
|
|
## 📄 License
|
|
|
|
This project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for details.
|