From ee3a420f60c514e474e6176fe8f7f6342dd88a95 Mon Sep 17 00:00:00 2001 From: catlog22 Date: Sun, 19 Oct 2025 09:44:48 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=AE=8C=E5=96=84=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E5=BC=95=E7=94=A8=E5=92=8C=E5=AE=89=E8=A3=85=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 主要变更： 1. README.md 和 README_CN.md - 添加 COMMAND_SPEC.md 引用链接 - 区分用户友好参考和技术规范 2. GETTING_STARTED.md - 添加 Skill 系统介绍章节 - 添加 UI 设计工作流介绍 - 包含 prompt-enhancer 使用示例 - 包含 explore-auto 和 imitate-auto 示例 3. INSTALL.md 和 INSTALL_CN.md - 添加推荐系统工具安装说明（ripgrep, jq） - 添加 MCP 工具安装说明（Exa, Code Index, Chrome DevTools） - 添加可选 CLI 工具说明（Gemini, Codex, Qwen） - 提供各平台安装命令和验证步骤 - 标注必需和可选工具 改进效果： - 用户可快速找到技术规范文档 - 新手指南更完整，覆盖高级功能 - 安装文档更详细，包含所有依赖工具 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude --- GETTING_STARTED.md | 41 +++++++++++++++++++++++++++++++++++++ INSTALL.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++ INSTALL_CN.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ README_CN.md | 2 ++ 5 files changed, 147 insertions(+) diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md index 21d5192f..bfaa9576 100644 --- a/GETTING_STARTED.md +++ b/GETTING_STARTED.md @@ -273,6 +273,47 @@ This command will: --- +## 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. + +### 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. +- **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. + +```bash +# Using a command that triggers the prompt-enhancer skill +/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. + +--- + +## Advanced Usage: UI Design Workflow + +CCW includes a powerful, multi-phase workflow for UI design and prototyping, capable of generating complete design systems and interactive prototypes from simple descriptions or reference images. + +### Key Commands + +- `/workflow:ui-design:explore-auto`: An exploratory workflow that generates multiple, distinct design variations based on a prompt. +- `/workflow:ui-design:imitate-auto`: A replication workflow that creates high-fidelity prototypes from reference URLs. + +### Example: Generating a UI from a Prompt + +You can generate multiple design options for a web page with a single command: + +```bash +# This command will generate 3 different style and layout variations for a login page. +/workflow:ui-design:explore-auto --prompt "A modern, clean login page for a SaaS application" --targets "login" --style-variants 3 --layout-variants 3 +``` + +After the workflow completes, it provides a `compare.html` file, allowing you to visually review and select the best design combination. + +--- + ## ❓ Troubleshooting - **Problem: Prompt shows "No active session found"** diff --git a/INSTALL.md b/INSTALL.md index 99b73695..dd33b618 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -188,6 +188,57 @@ cd Dmsflow # Use /workflow commands and memory system for development ``` +## Prerequisites & Recommended Tools + +To unlock the full potential of CCW, installing these additional tools is highly recommended. + +### System Tools (Recommended) + +These tools enhance file search and data processing capabilities. + +- **`ripgrep` (rg)**: A high-speed code search tool. + - **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. + - **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 tools provide advanced context retrieval from external sources, enhancing the AI's understanding. + +- **Prerequisite**: Node.js and npm (or a compatible JavaScript runtime). +- **Installation**: + ```bash + npm install -g @modelcontextprotocol/server-exa @modelcontextprotocol/server-code-index @modelcontextprotocol/server-chrome-devtools + ``` +- **Tools Included**: + - **Exa MCP**: For searching code and the web. + - **Code Index MCP**: For indexing and searching the local codebase. + - **Chrome DevTools MCP**: For interacting with web pages to extract layout and style information. +- **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: diff --git a/INSTALL_CN.md b/INSTALL_CN.md index 9fb76107..b1e4b94b 100644 --- a/INSTALL_CN.md +++ b/INSTALL_CN.md @@ -164,6 +164,57 @@ cd Dmsflow # 使用 /workflow 命令和内存系统进行开发 ``` +## 先决条件和推荐工具 + +为了充分发挥 CCW 的全部潜力，强烈建议安装这些额外工具。 + +### 系统工具 (推荐) + +这些工具增强了文件搜索和数据处理能力。 + +- **`ripgrep` (rg)**: 一款高速代码搜索工具。 + - **Windows**: `winget install BurntSushi.Ripper.MSVC` 或 `choco install ripgrep` + - **macOS**: `brew install ripgrep` + - **Linux**: `sudo apt-get install ripgrep` (Debian/Ubuntu) 或 `sudo dnf install ripgrep` (Fedora) + - **验证**: `rg --version` + +- **`jq`**: 一款命令行 JSON 处理器。 + - **Windows**: `winget install jqlang.jq` 或 `choco install jq` + - **macOS**: `brew install jq` + - **Linux**: `sudo apt-get install jq` (Debian/Ubuntu) 或 `sudo dnf install jq` (Fedora) + - **验证**: `jq --version` + +### 模型上下文协议 (MCP) 工具 (可选) + +MCP 工具从外部来源提供高级上下文检索，增强 AI 的理解能力。 + +- **先决条件**: Node.js 和 npm (或兼容的 JavaScript 运行时)。 +- **安装**: + ```bash + npm install -g @modelcontextprotocol/server-exa @modelcontextprotocol/server-code-index @modelcontextprotocol/server-chrome-devtools + ``` +- **包含的工具**: + - **Exa MCP**: 用于搜索代码和网络。 + - **Code Index MCP**: 用于索引和搜索本地代码库。 + - **Chrome DevTools MCP**: 用于与网页交互以提取布局和样式信息。 +- **验证**: 安装后，检查服务器是否可以启动 (具体请查阅 MCP 文档)。 + +### 可选的 AI CLI 工具 + +CCW 使用包装脚本与底层的 AI 模型进行交互。为了使这些包装器正常工作，必须在您的系统上安装和配置相应的 CLI 工具。 + +- **Gemini CLI**: 用于分析、文档和探索。 + - **用途**: 提供对 Google Gemini 模型的访问。 + - **安装**: 请遵循 Google AI 官方文档来安装和配置 Gemini CLI。确保 `gemini` 命令在您的系统 PATH 中可用。 + +- **Codex CLI**: 用于自主开发和实现。 + - **用途**: 提供对 OpenAI Codex 模型的访问，用于代码生成和修改。 + - **安装**: 请遵循您环境中使用的特定 Codex CLI 工具的安装说明。确保 `codex` 命令在您的系统 PATH 中可用。 + +- **Qwen Code**: 用于架构和代码生成。 + - **用途**: 提供对阿里巴巴通义千问模型的访问。 + - **安装**: 请遵循通义千问官方文档来安装和配置其 CLI 工具。确保 `qwen` 命令在您的系统 PATH 中可用。 + ## 验证 安装后，验证： diff --git a/README.md b/README.md index 0492be72..ed6473d5 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,8 @@ If the slash commands (e.g., `/workflow:*`) are recognized, the installation was CCW provides a rich set of commands for managing workflows, tasks, and interacting with AI tools. For a complete list and detailed descriptions of all available commands, please see the [**COMMAND_REFERENCE.md**](COMMAND_REFERENCE.md) file. +For a detailed technical specification of every command, see the [**COMMAND_SPEC.md**](COMMAND_SPEC.md). + --- ## 🚀 Getting Started diff --git a/README_CN.md b/README_CN.md index 97df0056..4d532c23 100644 --- a/README_CN.md +++ b/README_CN.md @@ -63,6 +63,8 @@ bash <(curl -fsSL https://raw.githubusercontent.com/catlog22/Claude-Code-Workflo CCW 提供了一套丰富的命令，用于管理工作流、任务以及与 AI 工具的交互。有关所有可用命令的完整列表和详细说明，请参阅 [**COMMAND_REFERENCE.md**](COMMAND_REFERENCE.md) 文件。 +有关每个命令的详细技术规范，请参阅 [**COMMAND_SPEC.md**](COMMAND_SPEC.md)。 + --- ## 🚀 快速入门