mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-05 01:50:27 +08:00
4458af83d8
- Updated COMMAND_SPEC.md to reflect new version and features including native CodexLens and CLI refactor. - Revised GETTING_STARTED.md and GETTING_STARTED_CN.md for improved onboarding experience with new features. - Enhanced INSTALL_CN.md to highlight the new CodexLens and Dashboard capabilities. - Updated README.md and README_CN.md to showcase version 6.2.0 features and breaking changes. - Introduced memory embedder scripts with comprehensive documentation and quick reference. - Added test suite for memory embedder functionality to ensure reliability and correctness. - Implemented TypeScript integration examples for memory embedder usage.
146 lines
4.4 KiB
Markdown
146 lines
4.4 KiB
Markdown
# CCW - Claude Code Workflow CLI
|
|
|
|
[](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
|