claude-code-workflow 6.2.1 → 6.2.3

package/.claude/skills/command-guide/guides/index-structure.md

@@ -0,0 +1,326 @@
+# Index Structure Reference
+
+Complete documentation for command index files and their data structures.
+
+## Overview
+
+The command-guide skill uses 5 JSON index files to organize and query 69 commands across the Claude DMS3 workflow system.
+
+## Index Files
+
+### 1. `all-commands.json`
+
+**Purpose**: Complete catalog of all commands with full metadata
+
+**Use Cases**:
+- Full-text search across all commands
+- Detailed command queries
+- Batch operations
+- Reference lookup
+
+**Structure**:
+```json
+[
+  {
+    "name": "workflow:plan",
+    "description": "Orchestrate 5-phase planning workflow with quality gate",
+    "arguments": "[--agent] [--cli-execute] \"text description\"|file.md",
+    "category": "workflow",
+    "subcategory": "core",
+    "usage_scenario": "planning",
+    "difficulty": "Advanced",
+    "file_path": "workflow/plan.md"
+  },
+  ...
+]
+```
+
+**Fields**:
+- `name` (string): Command name (e.g., "workflow:plan")
+- `description` (string): Brief functional description
+- `arguments` (string): Parameter specification
+- `category` (string): Primary category (workflow/cli/memory/task)
+- `subcategory` (string|null): Secondary grouping if applicable
+- `usage_scenario` (string): Primary use case (planning/implementation/testing/etc.)
+- `difficulty` (string): Skill level (Beginner/Intermediate/Advanced)
+- `file_path` (string): Relative path to command file
+
+**Total Records**: 69 commands
+
+---
+
+### 2. `by-category.json`
+
+**Purpose**: Hierarchical organization by category and subcategory
+
+**Use Cases**:
+- Browse commands by category
+- Category-specific listings
+- Hierarchical navigation
+- Understanding command organization
+
+**Structure**:
+```json
+{
+  "workflow": {
+    "core": [
+      {
+        "name": "workflow:plan",
+        "description": "...",
+        ...
+      }
+    ],
+    "brainstorm": [...],
+    "session": [...],
+    "tools": [...],
+    "ui-design": [...]
+  },
+  "cli": {
+    "mode": [...],
+    "core": [...]
+  },
+  "memory": [...],
+  "task": [...]
+}
+```
+
+**Category Breakdown**:
+- **workflow** (46 commands):
+  - core: 11 commands
+  - brainstorm: 12 commands
+  - session: 4 commands
+  - tools: 9 commands
+  - ui-design: 10 commands
+- **cli** (9 commands):
+  - mode: 3 commands
+  - core: 6 commands
+- **memory** (8 commands)
+- **task** (4 commands)
+- **general** (2 commands)
+
+---
+
+### 3. `by-use-case.json`
+
+**Purpose**: Commands organized by practical usage scenarios
+
+**Use Cases**:
+- Task-oriented command discovery
+- "I want to do X" queries
+- Workflow planning
+- Learning paths
+
+**Structure**:
+```json
+{
+  "planning": [
+    {
+      "name": "workflow:plan",
+      "description": "...",
+      ...
+    },
+    ...
+  ],
+  "implementation": [...],
+  "testing": [...],
+  "documentation": [...],
+  "session-management": [...],
+  "general": [...]
+}
+```
+
+**Use Case Categories**:
+- **planning**: Architecture, task breakdown, design
+- **implementation**: Coding, development, execution
+- **testing**: Test generation, TDD, quality assurance
+- **documentation**: Docs generation, memory management
+- **session-management**: Workflow control, resumption
+- **general**: Utilities, versioning, prompt enhancement
+
+---
+
+### 4. `essential-commands.json`
+
+**Purpose**: Curated list of 10-15 most frequently used commands
+
+**Use Cases**:
+- Quick reference for beginners
+- Onboarding new users
+- Common workflow starters
+- Cheat sheet
+
+**Structure**:
+```json
+[
+  {
+    "name": "enhance-prompt",
+    "description": "Context-aware prompt enhancement",
+    "arguments": "\"user input to enhance\"",
+    "category": "general",
+    "subcategory": null,
+    "usage_scenario": "general",
+    "difficulty": "Intermediate",
+    "file_path": "enhance-prompt.md"
+  },
+  ...
+]
+```
+
+**Selection Criteria**:
+- Frequency of use in common workflows
+- Value for beginners
+- Core functionality coverage
+- Minimal overlap in capabilities
+
+**Current Count**: 14 commands
+
+**List**:
+1. `enhance-prompt` - Prompt enhancement
+2. `version` - Version info
+3. `cli:analyze` - Quick codebase analysis
+4. `cli:chat` - Direct CLI interaction
+5. `cli:execute` - Auto-execution
+6. `cli:mode:plan` - Planning mode
+7. `task:breakdown` - Task decomposition
+8. `task:create` - Create tasks
+9. `task:execute` - Execute tasks
+10. `workflow:execute` - Run workflows
+11. `workflow:plan` - Plan workflows
+12. `workflow:review` - Review implementation
+13. `workflow:tdd-plan` - TDD planning
+14. `workflow:test-gen` - Test generation
+
+---
+
+### 5. `command-relationships.json`
+
+**Purpose**: Mapping of command dependencies and common sequences
+
+**Use Cases**:
+- Next-step recommendations
+- Workflow pattern suggestions
+- Related command discovery
+- Smart navigation
+
+**Structure**:
+```json
+{
+  "workflow:plan": {
+    "related_commands": [
+      "workflow:execute",
+      "workflow:action-plan-verify"
+    ],
+    "next_steps": ["workflow:execute"],
+    "prerequisites": []
+  },
+  "workflow:execute": {
+    "related_commands": [
+      "workflow:status",
+      "workflow:resume",
+      "workflow:review"
+    ],
+    "next_steps": ["workflow:review", "workflow:status"],
+    "prerequisites": ["workflow:plan"]
+  },
+  ...
+}
+```
+
+**Fields**:
+- `related_commands` (array): Commonly used together
+- `next_steps` (array): Typical next commands
+- `prerequisites` (array): Usually run before this command
+
+**Relationship Types**:
+1. **Sequential**: A → B (plan → execute)
+2. **Alternatives**: A | B (execute OR codex-execute)
+3. **Built-in**: A includes B (plan auto-includes context-gather)
+
+---
+
+## Query Patterns
+
+### Pattern 1: Keyword Search
+```javascript
+// Search by keyword in name or description
+const results = allCommands.filter(cmd =>
+  cmd.name.includes(keyword) ||
+  cmd.description.toLowerCase().includes(keyword.toLowerCase())
+);
+```
+
+### Pattern 2: Category Browse
+```javascript
+// Get all commands in a category
+const workflowCommands = byCategory.workflow;
+const coreWorkflow = byCategory.workflow.core;
+```
+
+### Pattern 3: Use-Case Lookup
+```javascript
+// Find commands for specific use case
+const planningCommands = byUseCase.planning;
+```
+
+### Pattern 4: Related Commands
+```javascript
+// Get next steps after a command
+const nextSteps = commandRelationships["workflow:plan"].next_steps;
+```
+
+### Pattern 5: Essential Commands
+```javascript
+// Get beginner-friendly quick reference
+const quickStart = essentialCommands;
+```
+
+---
+
+## Maintenance
+
+### Regenerating Indexes
+
+When commands are added/modified/removed:
+
+```bash
+bash scripts/update-index.sh
+```
+
+The script will:
+1. Scan all .md files in commands/
+2. Extract metadata from YAML frontmatter
+3. Analyze command relationships
+4. Identify essential commands
+5. Generate all 5 index files
+
+### Validation Checklist
+
+After regeneration, verify:
+- [ ] All 5 JSON files are valid (no syntax errors)
+- [ ] Total command count matches (currently 69)
+- [ ] No missing fields in records
+- [ ] Category breakdown correct
+- [ ] Essential commands reasonable (10-15)
+- [ ] Relationships make logical sense
+
+---
+
+## Performance Considerations
+
+**Index Sizes**:
+- `all-commands.json`: ~28KB
+- `by-category.json`: ~31KB
+- `by-use-case.json`: ~29KB
+- `command-relationships.json`: ~7KB
+- `essential-commands.json`: ~5KB
+
+**Total**: ~100KB (fast to load)
+
+**Query Speed**:
+- In-memory search: < 1ms
+- File read + parse: < 50ms
+- Recommended: Load indexes once, cache in memory
+
+---
+
+**Last Updated**: 2025-01-06

package/.claude/skills/command-guide/guides/troubleshooting.md

@@ -0,0 +1,92 @@
+# 常见问题与解决方案
+
+在使用 Gemini CLI 的过程中，您可能会遇到一些问题。本指南旨在帮助您诊断和解决这些常见问题，确保您能顺利使用 CLI。
+
+## 1. 命令执行失败或未找到
+
+**问题描述**:
+- 您输入的命令没有响应，或者系统提示“命令未找到”。
+- 命令执行后出现错误信息，但您不理解其含义。
+
+**可能原因**:
+- 命令拼写错误。
+- CLI 未正确安装或环境变量配置不正确。
+- 命令所需的依赖项缺失。
+- 命令参数不正确或缺失。
+
+**解决方案**:
+1.  **检查拼写**: 仔细核对您输入的命令是否正确，包括命令名称和任何参数。
+2.  **查看帮助**: 使用 `gemini help` 或 `gemini [command-name] --help` 来查看命令的正确用法、可用参数和示例。
+3.  **验证安装**: 确保 Gemini CLI 已正确安装，并且其可执行文件路径已添加到系统的环境变量中。您可以尝试重新安装 CLI。
+4.  **检查日志**: CLI 通常会生成日志文件。查看这些日志可以提供更详细的错误信息，帮助您定位问题。
+5.  **更新 CLI**: 确保您使用的是最新版本的 Gemini CLI。旧版本可能存在已知错误，通过 `gemini version` 检查并更新。
+
+## 2. 权限问题
+
+**问题描述**:
+- CLI 尝试读取、写入或创建文件/目录时，提示“权限被拒绝”或类似错误。
+- 某些操作（如安装依赖、修改系统配置）失败。
+
+**可能原因**:
+- 当前用户没有足够的权限执行该操作。
+- 文件或目录被其他程序占用。
+
+**解决方案**:
+1.  **以管理员身份运行**: 尝试以管理员权限（Windows）或使用 `sudo`（Linux/macOS）运行您的终端或命令提示符。
+    ```bash
+    # Windows (在命令提示符或 PowerShell 中右键选择“以管理员身份运行”)
+    # Linux/macOS
+    sudo gemini [command]
+    ```
+2.  **检查文件/目录权限**: 确保您对目标文件或目录拥有读/写/执行权限。您可能需要使用 `chmod` (Linux/macOS) 或修改文件属性 (Windows) 来更改权限。
+3.  **关闭占用程序**: 确保没有其他程序正在使用您尝试访问的文件或目录。
+
+## 3. 配置问题
+
+**问题描述**:
+- CLI 行为异常，例如无法连接到 LLM 服务，或者某些功能无法正常工作。
+- 提示缺少 API 密钥或配置项。
+
+**可能原因**:
+- 配置文件（如 `.gemini.json` 或相关环境变量）设置不正确。
+- API 密钥过期或无效。
+- 网络连接问题导致无法访问外部服务。
+
+**解决方案**:
+1.  **检查配置文件**: 仔细检查 Gemini CLI 的配置文件（通常位于用户主目录或项目根目录）中的设置。确保所有路径、API 密钥和选项都正确无误。
+2.  **验证环境变量**: 确认所有必要的环境变量（如 `GEMINI_API_KEY`）都已正确设置。
+3.  **网络连接**: 检查您的网络连接是否正常，并确保没有防火墙或代理设置阻止 CLI 访问外部服务。
+4.  **重新初始化配置**: 对于某些配置问题，您可能需要使用 `gemini cli-init` 命令重新初始化 CLI 配置。
+    ```bash
+    gemini cli-init
+    ```
+
+## 4. 智能代理 (LLM) 相关问题
+
+**问题描述**:
+- 智能代理的响应质量不佳，不相关或不准确。
+- 代理响应速度慢，或提示达到速率限制。
+
+**可能原因**:
+- 提示不够清晰或缺乏上下文。
+- 选择了不适合当前任务的 LLM 模型。
+- LLM 服务提供商的速率限制或服务中断。
+
+**解决方案**:
+1.  **优化提示**: 尝试使用 `enhance-prompt` 命令来优化您的输入，提供更清晰、更具体的上下文信息。
+2.  **选择合适的工具**: 根据任务类型，使用 `--tool` 标志选择最合适的 LLM 模型（如 `codex` 适用于代码生成，`gemini` 适用于复杂推理）。
+    ```bash
+    gemini analyze --tool gemini "分析这个复杂算法"
+    ```
+3.  **检查 API 密钥和配额**: 确保您的 LLM 服务 API 密钥有效，并且没有超出使用配额。
+4.  **重试或等待**: 如果是速率限制或服务中断，请稍后重试或联系服务提供商。
+
+## 5. 寻求帮助
+
+如果以上解决方案都无法解决您的问题，您可以：
+
+-   **查阅官方文档**: 访问 Gemini CLI 的官方文档获取更全面的信息。
+-   **社区支持**: 在相关的开发者社区或论坛中提问。
+-   **提交问题**: 如果您认为是 CLI 的 bug，请在项目的问题跟踪器中提交详细的问题报告。
+
+希望本指南能帮助您解决遇到的问题，让您更好地利用 Gemini CLI！