mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-05 01:50:27 +08:00
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
13 KiB
13 KiB
CCW Dashboard Operations Guide
Version: 6.2.0 Updated: 2025-12-20
This document provides detailed step-by-step operation instructions for each CCW Dashboard view.
Table of Contents
- Home Overview Operations
- Session Detail Operations
- CLI Manager Operations
- Core Memory Operations
- MCP Server Management Operations
- Hook Manager Operations
- Skills Manager Operations
- CodexLens Index Management Operations
1. Home Overview Operations
1.1 Entry Point
- Displayed automatically after Dashboard launch
- Click "Overview" in the sidebar navigation
1.2 Project Switching
- Click the Project Path Selector in the top action bar
- Select from recent projects dropdown, or click "Browse..." to select a new project
- System automatically loads the new project data
1.3 Data Refresh
- Click the Refresh Button (🔄) in the top action bar
- Or wait for WebSocket automatic push updates
1.4 Active Session Carousel
- Auto-rotates through currently active workflow sessions
- Click a session card to enter session details
1.5 Statistics Cards
Displays the following statistics:
- Total sessions
- Active sessions
- Archived sessions
- Task completion rate
2. Session Detail Operations
2.1 Entry Point
- Click a session card from the home page
- Click from sidebar "Sessions" > "All/Active/Archived" list
2.2 Session List Operations
| Operation | Steps |
|---|---|
| Filter sessions | Click "All/Active/Archived" tabs to switch |
| Search sessions | Enter session ID or description in search box |
| View details | Click session row to expand details |
2.3 Session Detail Panel
Basic Information Area
- Session ID, creation time, status
- Session description and objectives
Task List Area
| Operation | Description |
|---|---|
| View tasks | Tasks displayed as list with status icons |
| Expand task | Click task row to view detailed information |
| Task status | 🔵 Pending / 🟡 In Progress / 🟢 Completed / 🔴 Failed |
Action Buttons
| Button | Function |
|---|---|
| Archive | Mark session as archived |
| Delete | Delete session (requires confirmation) |
| Export | Export session data as JSON |
2.4 Task Drawer
Detail drawer opened after clicking a task:
| Area | Content |
|---|---|
| Header | Task title, status badge |
| Context | Related files list, dependencies |
| Execution log | Real-time execution output (WebSocket push) |
| Actions | Retry, Skip, Mark complete |
3. CLI Manager Operations
3.1 Entry Point
Sidebar "Project" > "Status"
3.2 CLI Tool Status Panel
Tool Status Cards
Each tool (Gemini/Qwen/Codex) displays:
- Installation status: ✅ Installed / ❌ Not installed
- Version information
- Default model configuration
Set Default Tool
- Click "Set as Default" button on tool card
- Confirm selection
Model Configuration
- Click "Configure" button
- In the modal dialog, set:
- Primary Model
- Fallback Model
- Click "Save"
3.3 Install/Uninstall Wizard
Install Tool
- Click "Install" button on uninstalled tool
- Follow wizard steps:
- Confirm system requirements
- Enter API key (if required)
- Select installation options
- Wait for installation to complete
Uninstall Tool
- Click "Uninstall" button on installed tool
- Confirm uninstall operation
- Wait for uninstall to complete
3.4 Execution History
Sidebar "Project" > "History"
| Operation | Description |
|---|---|
| View records | List displays execution time, tool, prompt summary |
| Expand details | Click record to view full input/output |
| Resume session | Click "Continue" button to resume with --resume |
| Copy command | Click "Copy" icon to copy execution command |
4. Core Memory Operations
4.1 Entry Point
Sidebar "Memory" > "Core Memory"
4.2 Memory List View
View Memories
- Memory entries displayed as cards
- Includes: title, summary, tags, creation time
Create Memory
- Click "+ New Memory" button
- Fill in the form:
Field Description Title Memory title (required) Content Memory body (Markdown supported) Tags Category tags (comma-separated) Priority High/Medium/Low - Click "Save"
Edit Memory
- Click "Edit" icon on memory card
- Modify content
- Click "Save"
Archive/Delete
- Archive: Click "Archive" icon, memory moves to archive list
- Delete: Click "Delete" icon, confirm for permanent deletion
4.3 Cluster View
Switch to "Clusters" tab
View Clusters
- Auto-clustered session groups displayed
- Each cluster shows: name, member count, creation time
Auto Clustering
- Click "Auto Cluster" button
- Set parameters:
Parameter Description Similarity Threshold 0.0-1.0, default 0.7 Minimum Members Minimum sessions per cluster - Click "Execute"
- Wait for clustering to complete
Cluster Management
| Operation | Steps |
|---|---|
| View members | Click cluster card to expand member list |
| Rename | Click cluster name to edit |
| Merge clusters | Select multiple clusters, click "Merge" |
| Delete cluster | Click "Delete" icon (members not deleted) |
4.4 Embedding Management
View Embedding Status
- Shows count of memories with generated embeddings
- Shows count of memories pending embedding
Generate Embeddings
- Click "Generate Embeddings" button
- Select scope:
- All unembedded
- Selected memories
- Wait for generation to complete (progress bar displayed)
5. MCP Server Management Operations
5.1 Entry Point
Sidebar "Config" > "MCP Servers"
5.2 Server List
View Servers
- List displays configured servers
- Each row shows: name, type, status, config source
Status Indicators
- 🟢 Running
- 🔴 Stopped
- 🟡 Starting
5.3 Create Server
Manual Creation
- Click "+ Add Server" button
- Fill in the form:
Field Description Name Server identifier (required) Command Start command (e.g., node)Arguments Command arguments array Environment Variables KEY=VALUE format Config Scope Project / Global - Click "Save"
Install from Template
- Click "Templates" tab
- Browse available templates
- Click template's "Install" button
- Confirm or modify configuration
- Click "Confirm Install"
5.4 Edit/Delete
| Operation | Steps |
|---|---|
| Edit | Click "Edit" icon → Modify config → Save |
| Delete | Click "Delete" icon → Confirm deletion |
| Enable/Disable | Toggle status switch |
5.5 Configuration File Locations
| Scope | File Path |
|---|---|
| Project | .mcp.json |
| Global | ~/.claude/settings.json |
6. Hook Manager Operations
6.1 Entry Point
Sidebar "Config" > "Hooks"
6.2 Hook List
View by Type
- PreToolUse: Triggered before tool use
- PostToolUse: Triggered after tool use
- Notification: Notification hooks
List Information
Each hook displays: name, type, matching tool, command summary
6.3 Create Hook
Wizard Mode
- Click "+ Add Hook" button
- Select hook type
- Fill in configuration:
Field Description Name Hook identifier Matcher Tool name to match (supports wildcard *)Command Shell command to execute Timeout Command timeout (milliseconds) Scope Project / Global - Click "Save"
Create from Template
- Click "Templates" tab
- Select preset template (e.g., format check, security scan)
- Click "Use Template"
- Modify configuration as needed
- Click "Save"
6.4 Edit/Delete
| Operation | Steps |
|---|---|
| Edit | Click hook row → Modify config → Save |
| Delete | Click "Delete" icon → Confirm |
| Enable/Disable | Toggle status switch |
6.5 Configuration File Locations
| Scope | File Path |
|---|---|
| Project | .claude/settings.local.json |
| Global | ~/.claude/settings.json |
7. Skills Manager Operations
7.1 Entry Point
Sidebar "Memory" > "Skills"
7.2 Skills List
Category View
- Project Skills: Skills in
./.claude/skills/directory - User Skills: Skills in
~/.claude/skills/directory
Skill Card Information
- Skill name
- Description
- Version number
- Tool count
- Support file count
7.3 View Skill Details
- Click skill card
- Detail panel displays:
- Full description
- Included tools list
- Support files list
- Dependency information
7.4 Create Skill
Import from Folder
- Click "+ Import Skill" button
- Select directory containing skill files
- Confirm skill information
- Click "Import"
Generate via CLI
- Click "+ Generate Skill" button
- Enter skill description
- Select generation options:
- Target directory (Project/User)
- Included capabilities
- Click "Generate"
- Wait for AI generation to complete
7.5 Delete Skill
- Click "Delete" icon on skill card
- Confirm delete operation
- Skill files will be removed
8. CodexLens Index Management Operations
8.1 Entry Point
Sidebar "Project" > "Status" → CodexLens panel
8.2 Index Status
Status Indicators
| Status | Description |
|---|---|
| ✅ Indexed | Project has established index |
| ⚠️ Outdated | Index needs update |
| ❌ Not indexed | Project has no index |
Index Statistics
- Total index size
- Project count
- Vector index count
- FTS index count
8.3 Initialize Index
- Click "Initialize Index" button
- Select index mode:
Mode Description FTS Full-text search, fast Vector Semantic search, requires embedding model Hybrid FTS + Vector, full features - Select languages/file types to index
- Click "Start Indexing"
- View progress bar and real-time logs
8.4 Clean Index
Clean Current Project
- Click "Clean Project Index" button
- Confirm operation
- Current project index is deleted
Clean All Indexes
- Click "Clean All Indexes" button
- Enter confirmation text
- All indexes are deleted
8.5 Semantic Dependency Management
Check Status
- Shows Python environment status
- Shows installed dependency packages
Install Dependencies
- Click "Install Semantic Dependencies" button
- Wait for installation to complete
- View installation logs
8.6 Embedding Model Management
View Models
- Lists available embedding models
- Shows downloaded/not downloaded status
Download Model
- Click "Download" button on undownloaded model
- Wait for download to complete
- Model available for vector indexing
Delete Model
- Click "Delete" button on downloaded model
- Confirm deletion
- Model files are removed
8.7 Test Search
- Enter search query in test area
- Select search mode:
auto: Auto selecthybrid: Hybrid searchexact: Exact matchripgrep: Text search
- Click "Search"
- View search results
Common Operations
Keyboard Shortcuts
| Shortcut | Function |
|---|---|
Escape |
Close modal/sidebar |
Ctrl+R / Cmd+R |
Refresh data |
Theme & Language Switching
| Operation | Location |
|---|---|
| Switch theme | Sun/moon icon in top action bar |
| Switch language | EN/ZH button in top action bar |
Error Handling
| Error Type | Resolution |
|---|---|
| Network error | Check connection, click refresh to retry |
| Permission error | Check file/directory permissions |
| Validation error | Check required form fields |
| Timeout error | Increase timeout settings or batch operations |
WebSocket Connection
- Auto reconnect: Automatically attempts reconnection after disconnect
- Heartbeat keepalive: Periodic heartbeat to maintain connection
- Status indicator: Connection status shown in footer
Related Documentation
- DASHBOARD_GUIDE.md - Dashboard User Guide
- COMMAND_REFERENCE.md - Command Reference
- GETTING_STARTED.md - Getting Started Guide
CCW Dashboard - Claude Code Workflow Visual Control Center Operations Manual