catlog22 b243bca577 docs: Streamline and optimize README files
- Reduced content by 81% while maintaining all essential information
- Improved structure with clearer sections and better navigation
- Added Quick Start guide for immediate usability
- Consolidated redundant sections and removed verbose explanations
- Simplified command reference tables
- Maintained all installation steps, badges, and links
- Ensured consistent structure between English and Chinese versions

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-01 23:43:14 +08:00

🚀 Claude Code Workflow (CCW)

Version License Platform MCP Tools

Languages: English | 中文


Claude Code Workflow (CCW) is a next-generation multi-agent automation framework that orchestrates complex software development tasks through intelligent workflow management and autonomous execution.

🎉 v3.0.0: This version introduces a unified CLI command structure. The /cli:* commands now consolidate all tool interactions (Gemini, Qwen, Codex) using a --tool flag for selection.


Key Features

  • 🤖 Multi-Agent System: Specialized agents for planning, coding, testing, and reviewing.
  • 🔄 End-to-End Workflow Automation: From brainstorming (/workflow:brainstorm) to deployment.
  • 🎯 JSON-First Architecture: Uses JSON as the single source of truth for tasks, ensuring consistency.
  • 🧪 Automated Test Generation: Creates comprehensive test suites based on implementation analysis.
  • Pre-execution Verification: Validates plans with both strategic (Gemini) and technical (Codex) analysis.
  • 🔧 Unified CLI: A single, powerful /cli:* command set for interacting with various AI tools.
  • 🧠 Smart Context Management: Automatically manages and updates project documentation (CLAUDE.md).

⚙️ Installation

🚀 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, run the following command to ensure CCW is working:

/workflow:session:list

🚀 Getting Started: A Simple Workflow

  1. Start a new workflow session:

    /workflow:session:start "Create a new user authentication feature"
    
  2. Generate an implementation plan:

    /workflow:plan "Implement JWT-based user authentication"
    
  3. Execute the plan with AI agents:

    /workflow:execute
    
  4. Check the status:

    /workflow:status
    

🛠️ Command Reference

Unified CLI Commands (`/cli:*)

Use the --tool <gemini|qwen|codex> flag to select the desired tool. Defaults to gemini.

Command Description
/cli:analyze Deep codebase analysis.
/cli:chat Direct, interactive chat with a tool.
/cli:execute Execute a task with full permissions.
/cli:cli-init Initialize CLI tool configurations for the workspace.
/cli:mode:bug-index Analyze bugs and suggest fixes.
/cli:mode:code-analysis Perform deep code analysis and debugging.
/cli:mode:plan Project planning and architecture analysis.

Workflow Commands (`/workflow:*)

Command Description
/workflow:session:* Manage development sessions (start, pause, resume, list, switch, complete).
/workflow:brainstorm:* Use role-based agents for multi-perspective planning.
/workflow:plan Create a detailed, executable plan from a description.
/workflow:execute Execute the current workflow plan autonomously.
/workflow:status Display the current status of the workflow.
/workflow:test-gen Automatically generate a test plan from the implementation.
/workflow:review Initiate a quality assurance review of the completed work.

Task & Memory Commands

Command Description
/task:* Manage individual tasks (create, breakdown, execute, replan).
/update-memory-full Re-index the entire project documentation.
/update-memory-related Update documentation related to recent changes.

⚙️ Essential Configuration

For optimal integration, configure your Gemini CLI settings by creating a settings.json file in ~/.gemini/:

// ~/.gemini/settings.json
{
  "contextFileName": "CLAUDE.md"
}

This ensures CCW's intelligent documentation system works seamlessly with the Gemini CLI.


🤝 Contributing & Support

📄 License

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

Description
JSON-driven multi-agent development framework with intelligent CLI orchestration (Gemini/Qwen/Codex), context-first architecture, and automated workflow execution
Readme MIT 33 MiB
Languages
TypeScript 38.2%
Python 24.2%
HTML 16.3%
JavaScript 15.2%
CSS 4.5%
Other 1.6%