catlog22/Claude-Code-Workflow
1
0
Fork 0
mirror of https://github.com/catlog22/Claude-Code-Workflow.git synced 2026-02-12 02:37:45 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: 优化文档准确性和安装说明

Browse Source 
- 修正 Agent Skills 描述,明确区分 -e 和 --enhance 机制
- 简化 INSTALL.md,对齐 README.md 的清晰结构
- 移除不必要的远程安装参数说明
- 优化 MCP 工具配置说明

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

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
catlog22
2025-10-19 13:17:19 +08:00
parent 423289c539
commit ac8c3b3d0c
3 changed files with 208 additions and 222 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
GETTING_STARTED.md
View File

@@ -275,20 +275,31 @@ This command will:
## Advanced Usage: Agent Skills ## Advanced Usage: Agent Skills
Agent Skills are modular, reusable capabilities that extend the AI's functionality. They are stored in the `.claude/skills/` directory and are invoked automatically by the model based on your request. Agent Skills are modular, reusable capabilities that extend the AI's functionality. They are stored in the `.claude/skills/` directory and are invoked through specific trigger mechanisms.
### How Skills Work ### How Skills Work
- **Model-Invoked**: Unlike slash commands, you don't call Skills directly. The AI decides when to use a Skill based on its understanding of your goal. - **Model-Invoked**: Unlike slash commands, you don't call Skills directly. The AI decides when to use a Skill based on its understanding of your goal.
- **Contextual**: Skills provide specific instructions, scripts, and templates to the AI for specialized tasks. - **Contextual**: Skills provide specific instructions, scripts, and templates to the AI for specialized tasks.
- **Example**: The built-in `prompt-enhancer` skill is triggered when you use the `--enhance` flag, automatically refining your prompt for better results. - **Trigger Mechanisms**:
- **Conversational Trigger**: Use `-e` or `--enhance` flag in **natural conversation** to trigger the `prompt-enhancer` skill
- **CLI Command Enhancement**: Use `--enhance` flag in **CLI commands** for prompt refinement (this is a CLI feature, not a skill trigger)
### Examples
**Conversational Trigger** (activates prompt-enhancer skill):
```
User: "Analyze authentication module -e"
→ AI uses prompt-enhancer skill to expand the request
```
**CLI Command Enhancement** (built-in CLI feature):
```bash ```bash
# Using a command that triggers the prompt-enhancer skill # The --enhance flag here is a CLI parameter, not a skill trigger
/cli:analyze --enhance "check for security issues" /cli:analyze --enhance "check for security issues"
``` ```
In this case, the `prompt-enhancer` skill activates to expand your brief request into a detailed, structured prompt for the security analysis. **Important Note**: The `-e` flag works in natural conversation, but `--enhance` in CLI commands is a separate enhancement mechanism, not the skill system.
--- ---

52
GETTING_STARTED_CN.md
View File

@@ -273,6 +273,58 @@ CCW 使用分层的 CLAUDE.md 文档系统维护项目上下文。定期更新
--- ---
## 🎯 进阶用法：智能体技能 (Agent Skills)
智能体技能是可扩展 AI 功能的模块化、可复用能力。它们存储在 `.claude/skills/` 目录中,通过特定的触发机制调用。
### 技能工作原理
- **模型调用**：与斜杠命令不同,您不直接调用技能。AI 会根据对您目标的理解来决定何时使用技能。
- **上下文化**：技能为 AI 提供特定的指令、脚本和模板,用于专门化任务。
- **触发机制**：
- **对话触发**：在**自然对话**中使用 `-e` 或 `--enhance` 标识符来触发 `prompt-enhancer` 技能
- **CLI 命令增强**：在 **CLI 命令**中使用 `--enhance` 标识符进行提示词优化(这是 CLI 功能,不是技能触发)
### 使用示例
**对话触发** (激活 prompt-enhancer 技能):
```
用户: "分析认证模块 -e"
→ AI 使用 prompt-enhancer 技能扩展请求
```
**CLI 命令增强** (CLI 内置功能):
```bash
# 这里的 --enhance 标识符是 CLI 参数,不是技能触发器
/cli:analyze --enhance "检查安全问题"
```
**重要说明**：`-e` 标识符仅在自然对话中有效,而 CLI 命令中的 `--enhance` 是独立的增强机制,与技能系统无关。
---
## 🎨 进阶用法：UI 设计工作流
CCW 包含强大的多阶段 UI 设计和原型制作工作流,能够从简单的描述或参考图像生成完整的设计系统和交互式原型。
### 核心命令
- `/workflow:ui-design:explore-auto`: 探索性工作流,基于提示词生成多种不同的设计变体。
- `/workflow:ui-design:imitate-auto`: 复制工作流,从参考 URL 创建高保真原型。
### 示例：从提示词生成 UI
您可以使用单个命令为网页生成多种设计选项:
```bash
# 此命令将为登录页面生成 3 种不同的样式和布局变体
/workflow:ui-design:explore-auto --prompt "一个现代简洁的 SaaS 应用登录页面" --targets "login" --style-variants 3 --layout-variants 3
```
工作流完成后,会提供一个 `compare.html` 文件,让您可以可视化地查看和选择最佳设计组合。
---
## ❓ 常见问题排查 (Troubleshooting) ## ❓ 常见问题排查 (Troubleshooting)
- **问题：提示 "No active session found" (未找到活动会话)** - **问题：提示 "No active session found" (未找到活动会话)**

357
INSTALL.md
View File

@@ -4,278 +4,201 @@
Interactive installation guide for Claude Code with Agent workflow coordination and distributed memory system. Interactive installation guide for Claude Code with Agent workflow coordination and distributed memory system.
## ⚡ One-Line Remote Installation (Recommended) ## ⚡ Quick One-Line Installation
### All Platforms - Remote PowerShell Installation **Windows (PowerShell):**
```powershell ```powershell
# Interactive remote installation from feature branch (latest) Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1" -UseBasicParsing).Content
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1)
# Global installation with unified file output system
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1) -Global
# Force overwrite (non-interactive) - includes all new workflow file generation features
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1) -Force -NonInteractive
# One-click backup all existing files (no confirmations needed)
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1) -BackupAll
``` ```
**What the remote installer does:** **Linux/macOS (Bash/Zsh):**
- ✅ Checks system requirements (PowerShell version, network connectivity) ```bash
- ✅ Downloads latest version from GitHub (main branch) bash <(curl -fsSL https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.sh)
- ✅ Includes all new unified file output system features ```
- ✅ Automatically extracts and runs local installer
- ✅ Security confirmation and user prompts
- ✅ Automatic cleanup of temporary files
- ✅ Sets up .workflow/ directory structure for session management
**Note**: Interface is in English for cross-platform compatibility ### Interactive Version Selection
## 📂 Local Installation After running the installation command, you'll see an interactive menu with real-time version information:
### All Platforms (PowerShell) ```
Detecting latest release and commits...
Latest stable: v4.6.0 (2025-10-19 04:27 UTC)
Latest commit: cdea58f (2025-10-19 08:15 UTC)
====================================================
Version Selection Menu
====================================================
1) Latest Stable Release (Recommended)
|-- Version: v4.6.0
|-- Released: 2025-10-19 04:27 UTC
\-- Production-ready
2) Latest Development Version
|-- Branch: main
|-- Commit: cdea58f
|-- Updated: 2025-10-19 08:15 UTC
|-- Cutting-edge features
\-- May contain experimental changes
3) Specific Release Version
|-- Install a specific tagged release
\-- Recent: v4.6.0, v4.5.0, v4.4.0
====================================================
Select version to install (1-3, default: 1):
```
**Version Options:**
- **Option 1 (Recommended)**: Latest stable release with verified production quality
- **Option 2**: Latest development version from main branch with newest features
- **Option 3**: Specific version tag for controlled deployments
> 💡 **Pro Tip**: The installer automatically detects and displays the latest version numbers and release dates from GitHub. Just press Enter to select the recommended stable release.
## 📂 Local Installation (Install-Claude.ps1)
For local installation without network access, use the bundled PowerShell installer:
**Installation Modes:**
```powershell ```powershell
# Clone the repository with latest features # Interactive mode with prompts (recommended)
cd Claude-Code-Workflow
# Windows PowerShell 5.1+ or PowerShell Core (Global installation only)
.\Install-Claude.ps1 .\Install-Claude.ps1
# Linux/macOS PowerShell Core (Global installation only) # Quick install with automatic backup
pwsh ./Install-Claude.ps1 .\Install-Claude.ps1 -Force -BackupAll
# Non-interactive install
.\Install-Claude.ps1 -NonInteractive -Force
``` ```
**Note**: The feature branch contains all the latest unified file output system enhancements and should be used for new installations. **Installation Options:**
## Installation Options | Mode | Description | Installs To |
|------|-------------|-------------|
| **Global** | System-wide installation (default) | `~/.claude/`, `~/.codex/`, `~/.gemini/` |
| **Path** | Custom directory + global hybrid | Local: `agents/`, `commands/`<br>Global: `workflows/`, `scripts/` |
### Remote Installation Parameters **Backup Behavior:**
- **Default**: Automatic backup enabled (`-BackupAll`)
- **Disable**: Use `-NoBackup` flag (⚠️ overwrites without backup)
- **Backup location**: `claude-backup-{timestamp}/` in installation directory
All parameters can be passed to the remote installer: **⚠️ Important Warnings:**
- `-Force -BackupAll`: Silent file overwrite (with backup)
- `-NoBackup -Force`: Permanent file overwrite (no recovery)
- Global mode modifies user profile directories
```powershell ### ✅ Verify Installation
# Global installation After installation, open **Claude Code** and check if the workflow commands are available by running:
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1) -Global ```bash
/workflow:session:list
# Install to specific directory
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1) -Directory "C:\MyProject"
# Force overwrite without prompts
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1) -Force -NonInteractive
# Install from specific branch
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1) -Branch "dev"
# Skip backups (overwrite without backup - not recommended)
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1) -NoBackup
# Explicit automatic backup all existing files (default behavior since v1.1.0)
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1) -BackupAll
``` ```
### Local Installation Options This command should be recognized in Claude Code's interface. If you see the workflow slash commands (e.g., `/workflow:*`, `/cli:*`), the installation was successful.
### Global Installation (Default and Only Mode) > **📝 Installation Notes:**
Install to user home directory (`~/.claude`): > - The installer will automatically install/update `.codex/` and `.gemini/` directories
```powershell > - **Global mode**: Installs to `~/.codex` and `~/.gemini`
# All platforms - Global installation (default) > - **Path mode**: Installs to your specified directory (e.g., `project/.codex`, `project/.gemini`)
.\Install-Claude.ps1 > - **Backup**: Existing files are backed up by default to `claude-backup-{timestamp}/`
> - **Safety**: Use interactive mode for first-time installation to review changes
# With automatic backup (default since v1.1.0)
.\Install-Claude.ps1 -BackupAll
# Disable automatic backup (not recommended)
.\Install-Claude.ps1 -NoBackup
# Non-interactive mode for automation
.\Install-Claude.ps1 -Force -NonInteractive
```
**Global installation structure:**
```
~/.claude/
├── agents/
├── commands/
├── output-styles/
├── settings.local.json
└── CLAUDE.md
```
**Note**: Starting from v1.2.0, only global installation is supported. Local directory and custom path installations have been removed to simplify the installation process and ensure consistent behavior across all platforms.
## Advanced Options
### 🛡️ Enhanced Backup Features (v1.1.0+)
The installer now includes **automatic backup as the default behavior** to protect your existing files:
**Backup Modes:**
- **Automatic Backup** (default since v1.1.0): Automatically backs up all existing files without prompts
- **Explicit Backup** (`-BackupAll`): Same as default behavior, explicitly specified for compatibility
- **No Backup** (`-NoBackup`): Disable backup functionality (not recommended)
**Backup Organization:**
- Creates timestamped backup folders (e.g., `claude-backup-20240117-143022`)
- Preserves directory structure within backup folders
- Maintains file relationships and paths
### Force Installation
Overwrite existing files:
```powershell
.\Install-Claude.ps1 -Force
```
### One-Click Backup
Automatically backup all existing files without confirmations:
```powershell
.\Install-Claude.ps1 -BackupAll
```
### Skip Backups
Don't create backup files:
```powershell
.\Install-Claude.ps1 -NoBackup
```
### Uninstall
Remove installation:
```powershell
.\Install-Claude.ps1 -Uninstall -Force
```
## Platform Requirements ## Platform Requirements
### PowerShell (Recommended)
- **Windows**: PowerShell 5.1+ or PowerShell Core 6+ - **Windows**: PowerShell 5.1+ or PowerShell Core 6+
- **Linux**: PowerShell Core 6+ - **Linux/macOS**: Bash/Zsh (for installer) or PowerShell Core 6+ (for manual Install-Claude.ps1)
- **macOS**: PowerShell Core 6+
Install PowerShell Core: **Install PowerShell Core (if needed):**
- **Ubuntu/Debian**: `sudo apt install powershell` - **Ubuntu/Debian**: `sudo apt install powershell`
- **CentOS/RHEL**: `sudo dnf install powershell`
- **macOS**: `brew install powershell` - **macOS**: `brew install powershell`
- **Or download**: https://github.com/PowerShell/PowerShell - **Download**: https://github.com/PowerShell/PowerShell
## ⚙️ Configuration
## Complete Installation Examples ### Tool Control System
### ⚡ Super Quick (One-Liner) CCW uses a **configuration-based tool control system** that makes external CLI tools **optional** rather than required. This allows you to:
```powershell
# Complete installation in one command
iex (iwr -useb https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1) -Global
# Done! 🎉 - ✅ **Start with Claude-only mode** - Work immediately without installing additional tools
# Start using Claude Code with Agent workflows! - ✅ **Progressive enhancement** - Add external tools selectively as needed
- ✅ **Graceful degradation** - Automatic fallback when tools are unavailable
- ✅ **Flexible configuration** - Control tool availability per project
**Configuration File**: `~/.claude/workflows/tool-control.yaml`
```yaml
tools:
gemini:
enabled: false # Optional: AI analysis & documentation
qwen:
enabled: true # Optional: AI architecture & code generation
codex:
enabled: true # Optional: AI development & implementation
``` ```
### 📂 Manual Installation Method **Behavior**:
```powershell - **When disabled**: CCW automatically falls back to other enabled tools or Claude's native capabilities
# Manual installation steps: - **When enabled**: Uses specialized tools for their specific strengths
# 1. Install PowerShell Core (if needed) - **Default**: All tools disabled - Claude-only mode works out of the box
# Windows: Download from GitHub
# Linux: sudo apt install powershell
# macOS: brew install powershell
# 2. Download Claude Code Workflow System ### Optional CLI Tools *(Enhanced Capabilities)*
git clone https://github.com/catlog22/Claude-CCW.git
cd Dmsflow
# 3. Install globally (interactive) While CCW works with Claude alone, installing these tools provides enhanced analysis and extended context:
.\Install-Claude.ps1 -Global
# 4. Start using Claude Code with Agent workflows! #### System Utilities
# Use /workflow commands and memory system for development
```
## Prerequisites & Recommended Tools | Tool | Purpose | Installation |
|------|---------|--------------|
| **ripgrep (rg)** | Fast code search | `brew install ripgrep` (macOS), `apt install ripgrep` (Ubuntu), `winget install ripgrep` (Windows) |
| **jq** | JSON processing | `brew install jq` (macOS), `apt install jq` (Ubuntu), `winget install jq` (Windows) |
To unlock the full potential of CCW, installing these additional tools is highly recommended. #### External AI Tools
### System Tools (Recommended) Configure these tools in `~/.claude/workflows/tool-control.yaml` after installation:
These tools enhance file search and data processing capabilities. | Tool | Purpose | Installation |
|------|---------|--------------|
| **Gemini CLI** | AI analysis & documentation | Follow [official docs](https://ai.google.dev) - Free quota, extended context |
| **Codex CLI** | AI development & implementation | Follow [official docs](https://github.com/openai/codex) - Autonomous development |
| **Qwen Code** | AI architecture & code generation | Follow [official docs](https://github.com/QwenLM/qwen-code) - Large context window |
- **`ripgrep` (rg)**: A high-speed code search tool. ### Recommended: MCP Tools *(Enhanced Analysis)*
- **Windows**: `winget install BurntSushi.Ripper.MSVC` or `choco install ripgrep`
- **macOS**: `brew install ripgrep`
- **Linux**: `sudo apt-get install ripgrep` (Debian/Ubuntu) or `sudo dnf install ripgrep` (Fedora)
- **Verify**: `rg --version`
- **`jq`**: A command-line JSON processor. MCP (Model Context Protocol) tools provide advanced codebase analysis. **Recommended installation** - While CCW has fallback mechanisms, not installing MCP tools may lead to unexpected behavior or degraded performance in some workflows.
- **Windows**: `winget install jqlang.jq` or `choco install jq`
- **macOS**: `brew install jq`
- **Linux**: `sudo apt-get install jq` (Debian/Ubuntu) or `sudo dnf install jq` (Fedora)
- **Verify**: `jq --version`
### Model Context Protocol (MCP) Tools (Optional) | MCP Server | Purpose | Installation Guide |
|------------|---------|-------------------|
| **Exa MCP** | External API patterns & best practices | [Install Guide](https://smithery.ai/server/exa) |
| **Code Index MCP** | Advanced internal code search | [Install Guide](https://github.com/johnhuang316/code-index-mcp) |
| **Chrome DevTools MCP** | ⚠️ **Required for UI workflows** - URL mode design extraction | [Install Guide](https://github.com/ChromeDevTools/chrome-devtools-mcp) |
MCP tools provide advanced context retrieval from external sources, enhancing the AI's understanding. For installation, please refer to the official documentation for each tool. ⚠️ **Note**: Some workflows expect MCP tools to be available. Without them, you may experience:
- Slower code analysis and search operations
| Tool | Purpose | Official Source | - Reduced context quality in some scenarios
|---|---|---| - Fallback to less efficient traditional tools
| **Exa MCP** | For searching code and the web. | [exa-labs/exa-mcp-server](https://github.com/exa-labs/exa-mcp-server) | - Potential unexpected behavior in advanced workflows
| **Code Index MCP** | For indexing and searching the local codebase. | [johnhuang316/code-index-mcp](https://github.com/johnhuang316/code-index-mcp) |
| **Chrome DevTools MCP** | For interacting with web pages to extract layout and style information. | [ChromeDevTools/chrome-devtools-mcp](https://github.com/ChromeDevTools/chrome-devtools-mcp) |
- **Prerequisite**: Node.js and npm (or a compatible JavaScript runtime).
- **Verify**: After installation, check if the servers can be started (consult MCP documentation for details).
### Optional AI CLI Tools
CCW uses wrapper scripts to interact with underlying AI models. For these wrappers to function, the respective CLI tools must be installed and configured on your system.
- **Gemini CLI**: For analysis, documentation, and exploration.
- **Purpose**: Provides access to Google's Gemini models.
- **Installation**: Follow the official Google AI documentation to install and configure the Gemini CLI. Ensure the `gemini` command is available in your system's PATH.
- **Codex CLI**: For autonomous development and implementation.
- **Purpose**: Provides access to OpenAI's Codex models for code generation and modification.
- **Installation**: Follow the installation instructions for the specific Codex CLI tool used in your environment. Ensure the `codex` command is available in your system's PATH.
- **Qwen Code**: For architecture and code generation.
- **Purpose**: Provides access to Alibaba's Qwen models.
- **Installation**: Follow the official Qwen documentation to install and configure their CLI tool. Ensure the `qwen` command is available in your system's PATH.
## Verification
After installation, verify:
1. **Check installation:**
```bash
# Global
ls ~/.claude
# Local
ls ./.claude
```
2. **Test Claude Code:**
- Open Claude Code in your project
- Check that global `.claude` directory is recognized
- Verify workflow commands and DMS commands are available
- Test `/workflow` commands for agent coordination
- Test `/workflow version` to check version information
## Troubleshooting ## Troubleshooting
### PowerShell Execution Policy ### PowerShell Execution Policy (Windows)
If you get execution policy errors: If you get execution policy errors:
```powershell ```powershell
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
``` ```
### Workflow Commands Not Working ### Workflow Commands Not Working
- Ensure `.claude` directory exists in your project - Verify installation: `ls ~/.claude` (should show agents/, commands/, workflows/)
- Verify workflow.md and agent files are properly installed - Restart Claude Code after installation
- Check that Claude Code recognizes the configuration - Check `/workflow:session:list` command is recognized
### Permission Errors ### Permission Errors
- **Windows**: Run as Administrator - **Windows**: Run PowerShell as Administrator
- **Linux/macOS**: Use `sudo` if needed for global PowerShell installation - **Linux/macOS**: May need `sudo` for global PowerShell installation
## Support ## Support
- **Issues**: [GitHub Issues](https://github.com/catlog22/Claude-CCW/issues) - **Issues**: [GitHub Issues](https://github.com/catlog22/Claude-Code-Workflow/issues)
- **Getting Started**: [Quick Start Guide](GETTING_STARTED.md)
- **Documentation**: [Main README](README.md) - **Documentation**: [Main README](README.md)
- **Workflow Documentation**: [.claude/commands/workflow.md](.claude/commands/workflow.md)