claude-code-workflow 6.1.3 → 6.2.1

package/README.md

@@ -1,274 +1,145 @@
-# 🚀 Claude Code Workflow (CCW)
-
-[![Run in Smithery](https://smithery.ai/badge/skills/catlog22)](https://smithery.ai/skills?ns=catlog22&utm_source=github&utm_medium=badge)
-
-
-<div align="center">
-
-[![Version](https://img.shields.io/badge/version-v6.1.2-blue.svg)](https://github.com/catlog22/Claude-Code-Workflow/releases)
-[![npm](https://img.shields.io/npm/v/claude-code-workflow.svg)](https://www.npmjs.com/package/claude-code-workflow)
-[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
-[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20Linux%20%7C%20macOS-lightgrey.svg)]()
-
-**Languages:** [English](README.md) | [中文](README_CN.md)
-
-</div>
-
----
-
-**Claude Code Workflow (CCW)** is a JSON-driven multi-agent development framework with intelligent CLI orchestration (Gemini/Qwen/Codex), context-first architecture, and automated workflow execution. It transforms AI development from simple prompt chaining into a powerful orchestration system.
-
-> **🎉 Version 6.1.2: Dashboard Update Notification & Bug Fixes**
->
-> **Core Improvements**:
-> - 🔔 **Version Update Notification**: Dashboard now checks npm for updates and displays upgrade banner
-> - 🔧 **Hook Manager Fix**: Fixed button click event handling for edit/delete operations
->
-> See [CHANGELOG.md](CHANGELOG.md) for complete 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 distinguish it from traditional AI development approaches:
-
-- **Context-First Architecture**: Eliminates uncertainty during execution through pre-defined context gathering, ensuring agents have the right information *before* implementation.
-- **JSON-First State Management**: Task state is fully stored in `.task/IMPL-*.json` files as the single source of truth, enabling programmatic orchestration without state drift.
-- **Autonomous Multi-Stage Orchestration**: Commands chain-invoke specialized sub-commands and agents to automate complex workflows with zero user intervention.
-- **Multi-Model Strategy**: Leverages the unique strengths of different AI models (e.g., Gemini for analysis, Codex for implementation) for superior results.
-- **Layered Memory System**: A 4-tier documentation system that provides context at the appropriate abstraction level, preventing information overload.
-- **Specialized Role-Based Agents**: A suite of agents (`@code-developer`, `@test-fix-agent`, etc.) that emulate a real software team for diverse tasks.
-
----
-
-## ⚙️ Installation
-
-### **📦 npm Install (Recommended)**
-
-Install globally via npm:
-```bash
-npm install -g claude-code-workflow
-```
-
-Then install workflow files to your system:
-```bash
-# Interactive installation
-ccw install
-
-# Global installation (to ~/.claude)
-ccw install -m Global
-
-# Project-specific installation
-ccw install -m Path -p /path/to/project
-```
-
-### **✅ Verify Installation**
-After installation, open **Claude Code** and verify that workflow commands are available by running:
-```bash
-/workflow:session:list
-```
-If slash commands (e.g., `/workflow:*`) are recognized, the installation was successful.
-
----
-
-## 🖥️ CCW CLI Tool
-
-The `ccw` command provides a powerful CLI for managing your Claude Code Workflow installation:
-
-### **Commands**
-
-| Command | Description |
-|---------|-------------|
-| `ccw install` | Install workflow files to Global (~/.claude) or specific Path |
-| `ccw upgrade` | Upgrade existing installations to current package version |
-| `ccw uninstall` | Remove workflow files from an installation |
-| `ccw view` | Open the workflow dashboard in browser |
-| `ccw serve` | Start dashboard server without opening browser |
-| `ccw list` | List all managed installations |
-
-### **Usage Examples**
-
-```bash
-# Install globally
-ccw install -m Global
-
-# Install to specific project
-ccw install -m Path -p ./my-project
-
-# Open dashboard
-ccw view
-
-# Start dashboard server on custom port
-ccw serve -p 8080
-
-# Upgrade all installations
-ccw upgrade -a
-
-# List installations
-ccw list
-```
-
-### **Dashboard Features**
-
-The CCW Dashboard (`ccw view`) provides:
-- 📊 **Session Overview**: View all workflow sessions with status and progress
-- 📋 **Task Management**: Track task execution and completion
-- 🔍 **Review Sessions**: Manage code review cycles
-- ⚙️ **MCP Manager**: Configure and monitor MCP servers
-- 🪝 **Hook Manager**: Manage Claude Code hooks
-- 📁 **Project Explorer**: Navigate project structure and artifacts
-
----
-
-## 🛠️ Command Reference
-
-CCW provides a rich set of commands for managing workflows, tasks, and interactions with AI tools. For a complete list and detailed descriptions of all available commands, please refer to the [**COMMAND_REFERENCE.md**](COMMAND_REFERENCE.md) file.
-
-For detailed technical specifications of each command, see [**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 using 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 arguments, examples, and best practices
-- 🎓 **Beginner Onboarding** - Learn the 14 core commands through guided learning paths
-- 📝 **Issue Reporting** - Generate standardized bug reports and feature requests
-
-**Usage Examples**:
-```
-User: "CCW-help"
-→ Interactive menu with command search, recommendations, and documentation
-
-User: "What should I do after /workflow:plan?"
-→ Recommends /workflow:execute, /workflow:action-plan-verify with workflow patterns
-
-User: "CCW-issue"
-→ Guided template generation for bugs, features, or question inquiries
-```
-
----
-
-## 🚀 Quick Start
-
-The best way to get started is by following the 5-minute tutorial in the [**Getting Started Guide**](GETTING_STARTED.md).
-
-Here's 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 authentication 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 and task breakdown
-4. **Phase 4**: Three-dimensional confirmation:
-   - ✅ Confirm/Modify/Cancel task
-   - 🔧 Choose execution: Agent / Provide Plan Only / CLI (Gemini/Qwen/Codex)
-   - 🔍 Optional code review: No / Claude / Gemini / Qwen / Codex
-5. **Phase 5**: Watch live execution and task tracking
-
-### **Option 2: Lite-Fix Workflow** (🐛 Recommended for Bug Fixes)
-
-Intelligent bug diagnosis and fix workflow with adaptive severity assessment:
-
-```bash
-# Standard bug fix (auto-adapts based on severity)
-/workflow:lite-fix "User avatar upload fails with 413 error"
-
-# Production hotfix mode
-/workflow:lite-fix --hotfix "Payment gateway 5xx errors"
-```
-
-**Workflow Features**:
-- **Phase 1**: Intelligent root cause diagnosis with adaptive search
-- **Phase 2**: Automatic impact assessment and risk scoring
-- **Phase 3**: Fix strategy generation based on complexity
-- **Phase 4**: Risk-aware verification planning
-- **Phase 5**: User confirmation with execution selection
-- **Phase 6**: Execution dispatch with complete artifact tracking
-
-**Session Artifacts** (saved to `.workflow/.lite-fix/{bug-slug}-{timestamp}/`):
-- `diagnosis.json` - Root cause analysis and reproduction steps
-- `impact.json` - Risk score, severity, and workflow adaptations
-- `fix-plan.json` - Fix strategy and implementation tasks
-- `task.json` - Enhanced Task JSON with complete context
-- `followup.json` - Auto-generated follow-up tasks (hotfix mode only)
-
-### **Option 3: Full Workflow** (📋 Comprehensive Planning)
-
-Traditional multi-stage workflow for complex projects:
-
-1.  **Create Plan** (auto-starts session):
-    ```bash
-    /workflow:plan "Implement JWT-based user login and registration"
-    ```
-2.  **Execute Plan**:
-    ```bash
-    /workflow:execute
-    ```
-3.  **View Status** (optional):
-    ```bash
-    /workflow:status
-    ```
-
----
-
-## 📚 Documentation
-
-CCW provides comprehensive documentation to help you get started quickly 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 to choose the right command
-- [**Examples**](EXAMPLES.md) - Real-world use cases and practical examples
-- [**FAQ**](FAQ.md) - Common 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 Spec**](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.
+# CCW - Claude Code Workflow CLI
+
+[![Version](https://img.shields.io/badge/version-v6.2.0-blue.svg)](https://github.com/catlog22/Claude-Code-Workflow/releases)
+
+A powerful command-line tool for managing Claude Code Workflow with native CodexLens code intelligence, multi-model CLI orchestration, and interactive dashboard.
+
+## Installation
+
+```bash
+# Install globally
+npm install -g ccw
+
+# Or install from local source
+cd path/to/ccw
+npm install
+npm link
+```
+
+## Usage
+
+### View Dashboard
+
+```bash
+# Open workflow dashboard in browser
+ccw view
+
+# Specify project path
+ccw view -p /path/to/project
+
+# Generate dashboard without opening browser
+ccw view --no-browser
+
+# Custom output path
+ccw view -o report.html
+```
+
+## Features
+
+### 🔍 Native CodexLens (v6.2)
+- **Full-Text Search (FTS)**: SQLite-based fast keyword search with symbol extraction
+- **Semantic Search**: Embedding-based similarity search with vector store
+- **Hybrid Search**: RRF (Reciprocal Rank Fusion) combining FTS and semantic results
+- **HNSW Index**: Approximate Nearest Neighbor index for significantly faster vector search
+
+### 💻 CLI Tools Integration
+- **Multi-Model Support**: Execute prompts with Gemini, Qwen, or Codex
+- **Session Resume**: Resume from last session or merge multiple sessions
+- **SQLite History**: Persistent execution history with conversation tracking
+- **Custom IDs**: Support for custom execution IDs and multi-turn conversations
+
+### 🧠 Core Memory & Clustering
+- **Session Clustering**: Intelligent grouping of related sessions
+- **Cluster Visualization**: Interactive display with Cytoscape.js
+- **Cluster Management**: Delete, merge, and deduplicate operations
+
+### 🖥️ Dashboard Views
+- **Workflow Dashboard**: Active/archived sessions with task progress
+- **CodexLens Manager**: Index management with real-time progress bar
+- **Core Memory**: Session clustering visualization
+- **CLAUDE.md Manager**: File tree viewer for configuration
+- **Skills Manager**: View and manage Claude Code skills
+- **Graph Explorer**: Interactive code relationship visualization
+- **MCP Manager**: Configure and monitor MCP servers
+- **Hook Manager**: Manage Claude Code hooks
+- **Help View**: Internationalized help documentation
+
+### Review Integration
+- **Code Review Findings**: View results from `review-module-cycle`
+- **Severity Distribution**: Critical/High/Medium/Low finding counts
+- **Dimension Analysis**: Findings by review dimension (Security, Architecture, Quality, etc.)
+- **Tabbed Interface**: Switch between Workflow and Reviews tabs
+
+## Dashboard Data Sources
+
+The CLI reads data from the `.workflow/` directory structure:
+
+```
+.workflow/
+├── active/
+│   └── WFS-{session-id}/
+│       ├── workflow-session.json    # Session metadata
+│       ├── .task/
+│       │   └── IMPL-*.json          # Task definitions
+│       └── .review/
+│           ├── review-progress.json # Review progress
+│           └── dimensions/
+│               └── *.json           # Dimension findings
+└── archives/
+    └── WFS-{session-id}/            # Archived sessions
+```
+
+## Bundled Templates
+
+The CLI includes bundled dashboard templates:
+- `workflow-dashboard.html` - Workflow session and task visualization
+- `review-cycle-dashboard.html` - Code review findings display
+
+No external template installation required - templates are included in the npm package.
+
+## Requirements
+
+- Node.js >= 16.0.0
+- npm or yarn
+
+## Integration with Claude Code Workflow
+
+This CLI is a standalone tool that works with the Claude Code Workflow system:
+
+1. **Install CCW CLI** (via npm)
+   - `npm install -g ccw`
+   - Provides `ccw view` command for dashboard viewing
+   - Templates are bundled - no additional installation required
+
+2. **Optional: Install Claude Code Workflow** (via `Install-Claude.ps1`)
+   - Provides workflow commands, agents, and automation
+   - CCW will automatically detect and display workflow sessions
+
+## Options
+
+| Option | Description |
+|--------|-------------|
+| `-p, --path <path>` | Path to project directory (default: current directory) |
+| `--no-browser` | Generate dashboard without opening browser |
+| `-o, --output <file>` | Custom output path for HTML file |
+| `-V, --version` | Display version number |
+| `-h, --help` | Display help information |
+
+## Development
+
+```bash
+# Clone and install dependencies
+git clone <repo-url>
+cd ccw
+npm install
+
+# Link for local testing
+npm link
+
+# Test the CLI
+ccw view -p /path/to/test/project
+```
+
+## License
+
+MIT

package/bin/ccw-mcp.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+/**
+ * CCW MCP Server Executable
+ * Entry point for running CCW tools as an MCP server
+ */
+
+import '../dist/mcp-server/index.js';

package/bin/ccw.js

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+
+/**
+ * CCW CLI - Claude Code Workflow Dashboard
+ * Entry point for global CLI installation
+ */
+
+import { run } from '../dist/cli.js';
+
+run(process.argv);

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+export declare function run(argv: string[]): void;
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AA0DA,wBAAgB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAyLxC"}