Claude-Code-Workflow/README.md at 902ee8528a4c72e7e17fa3f8d0ee5ec96655ce12

mirror of https://github.com/catlog22/Claude-Code-Workflow.git synced 2026-02-28 09:23:08 +08:00

Files

catlog22 690d524aee docs: update README and WORKFLOW_GUIDE with simplified content

- Streamline README documentation
- Update workflow guide with current best practices

2026-02-27 22:52:28 +08:00

16 KiB

Raw Blame History

English | 中文

✨ Key Features

🎯 Skill-based Workflows

From lite-plan (lightweight) to brainstorm (multi-role analysis)

🔄 Multi-CLI Orchestration

Gemini, Qwen, Codex, Claude - auto-select or manual

⚡ Team Architecture v2

Role-based agents with inner loop execution

🔧 Queue Scheduler

Background queue execution service

📦 Session Lifecycle

start/resume/complete/sync workflow sessions

🖥️ Terminal Dashboard

Multi-terminal grid with execution monitor

🎨 Orchestrator Editor

Template-based workflow visual editing

💬 A2UI

Agent-to-User interactive interface

📖 New? See Workflow Guide for complete workflow documentation.

🚀 Quick Start

Install CCW

npm install -g claude-code-workflow
ccw install -m Global

Workflow Skills vs Commands

CCW uses two types of invocations:

Type	Format	Examples
Skills	Trigger phrase (no slash)	`workflow:lite-plan`, `brainstorm`, `workflow:plan`
Commands	Slash command	`/ccw`, `/workflow/session:start`, `/issue/new`

Choose Your Workflow Skill

Skill Trigger	Use Case
`workflow:lite-plan`	Lightweight planning, single-module features
`workflow:multi-cli-plan`	Multi-CLI collaborative analysis
`workflow:plan`	Full planning with session persistence
`workflow:tdd-plan`	Test-driven development
`workflow:test-fix-gen`	Test generation and fix cycles
`brainstorm`	Multi-role brainstorming analysis

Workflow Examples

# Skill triggers (no slash - just describe what you want)
workflow:lite-plan "Add JWT authentication"
workflow:plan "Implement payment gateway integration"
workflow:execute

# Brainstorming
brainstorm "Design real-time collaboration system"

# Slash commands for session management
/workflow/session:start
/workflow/session:resume
/workflow/session:complete

🛠️ CLI Tool Installation

CLI	Description	Official Docs
Gemini	Google AI analysis	google-gemini/gemini-cli
Codex	OpenAI autonomous coding	openai/codex
OpenCode	Open-source multi-model	opencode-ai/opencode
Qwen	Alibaba Qwen-Code	QwenLM/Qwen

🎭 Semantic CLI Invocation

Users can semantically specify CLI tools in prompts - the system automatically invokes the corresponding CLI.

Basic Invocation

User Prompt	System Action
"Use Gemini to analyze the auth module"	Auto-invoke `gemini` CLI for analysis
"Let Codex review this code"	Auto-invoke `codex` CLI for review
"Ask Qwen about performance optimization"	Auto-invoke `qwen` CLI for consultation

Multi-CLI Orchestration

Pattern	User Prompt Example
Collaborative	"Use Gemini and Codex to collaboratively analyze security vulnerabilities"
Parallel	"Have Gemini, Codex, and Qwen analyze the architecture in parallel"
Iterative	"Use Gemini to diagnose, then Codex to fix, iterate until resolved"
Pipeline	"Gemini designs the solution, Codex implements, Claude reviews"

🔍 ACE Tool Configuration

ACE (Augment Context Engine) provides powerful semantic code search.

Method	Link
Official	Augment MCP Documentation
Proxy	ace-tool (GitHub)

📚 CodexLens Local Search

⚠️ In Development: CodexLens is under iterative optimization. Some features may be unstable.

Search Mode	Description
FTS	Full-text search, based on SQLite FTS5
Semantic	Semantic search, using local embedding models
Hybrid	Hybrid search, combining FTS + Semantic + Reranking

💻 CCW CLI Commands

🌟 Recommended Commands

Command	Description	When to Use
/ccw	Auto workflow orchestrator - analyzes intent, selects workflow, executes	✅ General tasks, auto workflow selection
/ccw-coordinator	Smart orchestrator - recommends command chains, allows manual adjustment	🔧 Complex multi-step workflows

Quick Examples:

# /ccw - Auto workflow selection
/ccw "Add user authentication"
/ccw "Fix memory leak in WebSocket"
/ccw "Implement with TDD"

# /ccw-coordinator - Manual chain orchestration
/ccw-coordinator "Implement OAuth2 system"

Session Management Commands

/workflow:session:start     # Start new workflow session
/workflow:session:resume    # Resume paused session
/workflow:session:list      # List all sessions
/workflow:session:sync      # Sync session work
/workflow:session:complete  # Complete session

Issue Workflow Commands

/issue/new       # Create new issue
/issue/plan      # Plan issue resolution
/issue/queue     # Form execution queue
/issue/execute   # Execute issue queue

Other CLI Commands

ccw install           # Install workflow files
ccw view              # Open dashboard
ccw cli -p "..."      # Execute CLI tools (Gemini/Qwen/Codex)
ccw upgrade -a        # Upgrade all installations

🏗️ Architecture

┌─────────────────────────────────────────────────────────────────┐
│                     Workflow Skills                              │
│  📝 workflow:lite-plan / workflow:multi-cli-plan (lightweight)  │
│  📊 workflow:plan / workflow:tdd-plan (session-based)           │
│  🧪 workflow:test-fix-gen / workflow:test-cycle-execute         │
│  🧠 brainstorm (multi-role analysis)                            │
└─────────────────────────────────────────────────────────────────┘
                              ↓
┌─────────────────────────────────────────────────────────────────┐
│                   Team Architecture v2                          │
│  🤖 team-worker agents with role-spec based execution           │
│  🔄 Inner loop framework for sequential task processing         │
│  📢 Message bus protocol with team coordination                 │
│  🧠 Wisdom accumulation (learnings/decisions/conventions)       │
└─────────────────────────────────────────────────────────────────┘
                              ↓
┌─────────────────────────────────────────────────────────────────┐
│                   Queue Scheduler Service                       │
│  ⚙️ Background execution service with API endpoints             │
│  📊 Queue management and unified CLI execution settings         │
└─────────────────────────────────────────────────────────────────┘
                              ↓
┌─────────────────────────────────────────────────────────────────┐
│                   Terminal Dashboard & Orchestrator             │
│  🖥️ Multi-terminal grid with execution monitor                  │
│  🎨 Template-based workflow editor with slash commands          │
│  📡 Real-time agent communication via A2UI                      │
└─────────────────────────────────────────────────────────────────┘

📦 Project Structure

Claude-Code-Workflow/
├── .claude/
│   ├── agents/          # 22 specialized agents (team-worker, cli-discuss, etc.)
│   ├── commands/        # Slash commands (5 categories)
│   │   ├── ccw.md       # Main orchestrator
│   │   ├── ccw-coordinator.md
│   │   ├── cli/         # CLI commands (cli-init, codex-review)
│   │   ├── issue/       # Issue management (plan, execute, queue)
│   │   ├── memory/      # Memory commands (prepare, style-skill-memory)
│   │   └── workflow/    # Workflow commands (session, ui-design, etc.)
│   └── skills/          # 37 modular skills
│       ├── workflow-lite-plan/
│       ├── workflow-plan/
│       ├── workflow-tdd/
│       ├── workflow-test-fix/
│       ├── brainstorm/
│       ├── team-*/      # Team coordination skills
│       └── ...
├── ccw/
│   ├── src/             # TypeScript source code
│   │   ├── commands/    # CLI command implementations
│   │   ├── core/        # Core services (a2ui, auth, hooks, routes)
│   │   ├── mcp-server/  # MCP server implementation
│   │   └── tools/       # Tool implementations
│   └── frontend/        # React frontend (Terminal Dashboard, Orchestrator)
├── codex-lens/          # Local semantic code search engine
└── docs/                # Documentation

🎼 Team Cadence Control (Beat Model)

The v2 team architecture introduces an event-driven beat model for efficient orchestration:

Beat Cycle (single beat)
======================================================================
  Event                   Coordinator              Workers
----------------------------------------------------------------------
  callback/resume --> +- handleCallback -+
                      |  mark completed   |
                      |  check pipeline   |
                      +- handleSpawnNext -+
                      |  find ready tasks |
                      |  spawn workers ---+--> [team-worker A] Phase 1-5
                      |  (parallel OK)  --+--> [team-worker B] Phase 1-5
                      +- STOP (idle) -----+         |
                                                     |
  callback <-----------------------------------------+
  (next beat)              SendMessage + TaskUpdate(completed)
======================================================================

Key Benefits:

🎯 Event-driven: Coordinator only wakes when needed (callback/resume)
⚡ Fast-advance: Simple successors spawn directly without coordinator roundtrip
🔄 Dynamic pipelines: Generated per-task from dependency graph
📊 Parallel execution: Independent tasks run concurrently

🖥️ Frontend Highlights

Terminal Dashboard

Multi-terminal grid layout with real-time execution monitoring.

Features:

🖥️ Multi-terminal grid with resizable panes
📊 Execution monitor with agent list
📁 File sidebar for project navigation
🎯 Session grouping by project tags
🌙 Fullscreen/immersive mode

Orchestrator Editor

Visual workflow template editor with drag-drop.