mirror of https://github.com/catlog22/Claude-Code-Workflow.git synced 2026-02-05 01:50:27 +08:00

Files

catlog22 ee3a420f60 docs: 完善文档引用和安装说明

主要变更：
1. README.md 和 README_CN.md
   - 添加 COMMAND_SPEC.md 引用链接
   - 区分用户友好参考和技术规范

2. GETTING_STARTED.md
   - 添加 Skill 系统介绍章节
   - 添加 UI 设计工作流介绍
   - 包含 prompt-enhancer 使用示例
   - 包含 explore-auto 和 imitate-auto 示例

3. INSTALL.md 和 INSTALL_CN.md
   - 添加推荐系统工具安装说明（ripgrep, jq）
   - 添加 MCP 工具安装说明（Exa, Code Index, Chrome DevTools）
   - 添加可选 CLI 工具说明（Gemini, Codex, Qwen）
   - 提供各平台安装命令和验证步骤
   - 标注必需和可选工具

改进效果：
- 用户可快速找到技术规范文档
- 新手指南更完整，覆盖高级功能
- 安装文档更详细，包含所有依赖工具

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

Co-Authored-By: Claude <noreply@anthropic.com>

2025-10-19 09:44:48 +08:00

4.2 KiB

Raw Blame History

🚀 Claude Code Workflow (CCW)

Languages: English | 中文

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 for details.

📚 New to CCW? Check out the Getting Started Guide 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 guide.

🚀 Quick One-Line Installation

Windows (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 <(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:

/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 file.

For a detailed technical specification of every command, see the COMMAND_SPEC.md.

🚀 Getting Started

The best way to get started is to follow the 5-minute tutorial in the Getting Started Guide.

Here is a quick example of a common development workflow:

Start a Session:

/workflow:session:start "Implement user login feature"

Create a Plan:

/workflow:plan "Implement JWT-based user login and registration"

Execute the Plan:
```
/workflow:execute
```

🤝 Contributing & Support

Repository: GitHub - Claude-Code-Workflow
Issues: Report bugs or request features on GitHub Issues.
Discussions: Join the Community Forum.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

4.2 KiB Raw Blame History