# CLI 技能创建者 ## 概述此技能指导创建命令行界面 (CLI) 工具的综合技能。它提供了一个系统的工作流程，用于通过多个来源（帮助文本、手册页、GitHub 存储库、在线研究）内省 CLI 工具、提取心理模型和命令模式，并使用技能创建者技能将发现组织到有效的技能文档中。 ## 何时使用此技能当用户执行以下操作时调用此技能： * 要求为 CLI 工具创建技能（例如，“为 docker 创建技能”、“文档 kubectl”） * 索取全面的 CLI 文档或指南 * 想要了解 CLI 工具的思维模型和结构 * 需要整理CLI知识以便一致使用 * 询问如何系统地记录命令行工具 ## 核心工作流程创建 CLI 技能遵循一个系统的七步流程，该流程收集全面的信息，然后将其组织到技能文档中。 ### 第 1 步：CLI 识别和可用性检查 **目标：** * 验证 CLI 工具是否已安装或可访问 * 确定工具版本和变体 * 确定文档来源 * 评估开源可用性 **行动：** 1. **检查安装和版本** --版本其中 2. **识别工具特性** * 姓名和正式名称（如果不同） * 当前版本 * 主要目的/领域 * 开源或专有 3. **查找文档来源** * 官方网站/文档 * GitHub 存储库（如果开源） * 手册页可用性 * 社区资源 **输出：** 工具配置文件，包括版本、用途和可用的文档源。 ### 步骤 2：全面的帮助文本自省 **目标：** * 映射命令层次和结构 * 提取所有命令、子命令和标志 * 从帮助文本中捕获示例 * 识别命令模式（动词-名词、名词-动词、扁平） **参考：** 加载 `references/help-text-patterns.md` 以获得详细的解析指导。 **行动：** 1. **提取顶级帮助** --help -h 帮助 #（无参数，如果适用） 2. **映射命令层次结构** * 识别所有子命令 * 确定嵌套深度 * 注意命令组织模式 3. **记录每个命令/子命令** # 对于每个发现的命令 <命令> --help <命令> <子命令> --help 4. **提取关键信息** * 命令用途及说明 * 必需参数与可选参数 * 标志及其描述 * 使用示例 * 默认行为 5. **识别模式** * 标志命名约定 * 论证模式 * 输出格式选项 * 跨命令的通用选项 **输出：** 具有层次结构的结构化命令参考、记录的所有命令、提取的示例以及识别的模式。 ### 步骤 3：GitHub 存储库分析（如果开源） **目标：** * 了解实施模式 * 查找真实世界的使用示例 * 识别常见的用户痛点 * 发现未记录的功能或陷阱 **参考：** 加载 `references/help-text-patterns.md` 部分“GitHub 存储库分析”以获得详细指导。 **行动：** 1. **克隆存储库**（如果可访问且大小合理） git clone --深度 1 https://github.com// 2. **检查文档结构** * README.md - 快速入门，核心概念 * docs/ 或 doc/ - 详细文档 * 示例/ - 用法示例 * CONTRIBUTING.md - 开发模式 * man/ - 手册页来源 3. **分析代码结构** * 使用的 CLI 框架（Cobra、Click、Commander、Clap 等） * 命令文件组织 * 主要入口点 * 子命令的实现 4. **审查使用模式测试** * 集成测试显示常见的工作流程 * 单元测试揭示边缘情况 * 测试装置显示示例输入 * 断言揭示了预期的输出 5. **地雷问题和讨论** * 搜索 `label:question` \- 常见用户问题 * 搜索 `label:documentation` \- 文档间隙 * 查找“我如何...”- 工作流程问题 * 查找重复问题-常见痛点 6. **检查 shell 完成情况**（显示命令结构） * 完成/或脚本/目录 * Shell 完成文件显示所有命令/标志 **输出：** 实施见解、实际使用示例、常见痛点和未记录的行为。 ### 步骤 4：手动页面解析（如果可用） **目标：** * 提取全面的命令文档 * 捕获正式语法描述 * 识别相关命令 * 注意历史背景或设计原理 **参考：** 加载 `references/help-text-patterns.md` 部分“手册页解析”以获得详细指导。 **行动：** 1. **检查手册页可用性** man man -k # 搜索相关页面 2. **提取关键部分** * NAME - 命令标识 * 概要 - 形式语法 * 描述 - 详细解释 * 选项 - 综合标志文档 * 示例 - 使用示例 * 另请参阅 - 相关命令 * 错误 - 已知问题 3. **导出进行分析** # 导出为纯文本 man | col -b > man_.txt # 提取特定部分 man | grep -A 50“^选项” man | grep -A 30“^示例” 4. **检查子命令手册页** man -<子命令> **输出：** 正式的命令文档、全面的选项描述以及手册页中的使用示例。 ### 第 5 步：在线研究和最佳实践 **目标：** * 发现社区最佳实践 * 查找常见的工作流程和模式 * 确定与其他工具的集成点 * 从教程和指南中学习 **行动：** 1. **搜索官方文档** * 官网文档 * API 文档（如果 CLI 包装了 API） * 架构指南 * 最佳实践指南 2. **查找社区资源** * 有关高级用法的博客文章 * 教程网站（Medium、Dev.to 等） * 视频教程（YouTube） * 会议演讲 3. **查看问答网站** * Stack Overflow 常见问题 * 红迪讨论 * GitHub 讨论 * 特定工具的论坛 4. **识别集成模式** * 它如何与 Git 一起工作？ * CI/CD 集成模式 * 编辑器/IDE 集成 * 配套工具 5. **寻找比较** *“X vs Y”文章（揭示优点/差异） * 迁移指南（揭示心智模型差异） *“Awesome X”列表（揭示生态系统） **输出：** 社区最佳实践、通用工作流程、集成模式和生态系统理解。 ### 步骤 6：材料组织和结构设计 **目标：** * 将发现综合成连贯的心理模型 * 识别命令结构模式 * 按用户任务/工作流程组织内容 * 确定技能结构（基于工作流程、基于命令等） **参考：** 加载 `references/skill-templates.md` 以获取指导。 **行动：** 1. **提取核心心智模型** * 基本概念是什么？（资源、行动、状态） * 该工具希望用户如何思考？ * 它使用了什么抽象？ * 命令层次结构哲学是什么？ 2. **识别命令结构模式** * Flat（单级命令） * 名词-动词（资源-动作） * 动词-名词（动作-资源） * 混合（混合模式） 3. **映射常见工作流程** * 最常见的 5-10 项任务是什么？ * 入门工作流程是什么？ * 什么是高级工作流程？ * 哪些操作有风险/具有破坏性？ 4. **按类别组织调查结果** * 核心概念和术语 * 命令参考（按逻辑分组） * 工作流程模式（编号供参考） * 配置和设置 * 整合模式 * 解决常见问题 5. **选择技能结构**（加载 `references/skill-templates.md`） * **基于工作流**：适用于顺序的、面向流程的工具 * **基于命令**：适用于具有许多离散操作的工具 * **混合**：组合模式（最常见） 6. **决定什么放在哪里** * **skill.md** ：概述、核心概念、常用操作、何时加载参考 * **references/_reference.md** ：完整的命令参考，所有工作流程，详细示例 * 如果需要的话，其他参考文件（例如，对于 GraphQL API、专门功能） **输出：** 按用户任务/工作流程组织的结构化内容大纲、清晰的心智模型摘要和技能结构计划。 ### 第 7 步：调用技能创建者技能 **目标：** * 生成技能目录结构 * 创建skill.md和参考文档 * 分发的打包技巧 * 验证完整性 **行动：** 1. **为技能创造者准备结构化简介** 将所有收集到的材料整理成一份综合简介，包括： * **CLI 配置文件** * 名称、版本、用途 * 命令结构模式 * 开源状态和 GitHub URL * **核心心智模型** * 基本概念（2-5个关键概念） * 用户应该如何看待该工具 * 关键术语和定义 * **命令参考资料** * 按类别/领域组织 * 所有命令都带有语法和示例 * 常用标志和选项 * 命令关系 * **工作流程模式** * 5-10个常用工作流程 * 逐步执行命令 * 何时使用每种模式 * **集成点** * 与之配合使用的其他工具 * CI/CD 集成 * 文件格式、协议 * **配置** * 配置文件位置 * 按键设置 * 环境变量 * **故障排除** * 常见问题及解决方案 * 诊断命令 * 错误模式 2. **调用技能创造者技能** 使用技能工具调用技能创建器：技能：技能创造者提示：为创建一个具有以下结构和内容的技能： [提供第 1 步中完整的结构化概要] 使用[基于工作流/基于命令/混合]方法构建技能。 Skill.md 应包括： - 概述以及何时使用此技能 - 核心概念：[列出关键概念] - 按[类别结构]组织的常见操作 - 参考参考文献/中的综合命令参考使用以下命令创建引用/_reference.md： - 完整的心智模型解释 - 由[组织方案]组织的完整命令参考 - 工作流程模式 1-N - 配置、集成和故障排除部分遵循 gh、graphite 和 erk 等现有 CLI 技能的模式。 3. **查看生成的技能** * 检查skill.md结构和清晰度 * 验证参考文档的完整性 * 确保示例准确 * 如果可能的话测试命令 4. **如果需要则迭代** * 细化不清楚的部分 * 添加缺少的示例 * 改善组织 * 填补文档中的空白 5. **打包技巧**（如果准备好分发） python 脚本/package_skill.py .claude/skills/ **输出：** 完整的、打包的技能可供使用和分发。 ## CLI 自省技术 ### 帮助文本解析策略 **渐进式帮助发现：** 1.从顶层帮助入手，了解整体结构 2. 枚举所有子命令 3. 获取每个子命令的帮助 4. 识别嵌套子命令 5. 记录所有发现的命令 **信息提取：** * **命令语法**：用法行显示必需与可选 * **描述** ：每个命令/标志的作用 * **示例**：从帮助文本中逐字复制 * **默认值** ：注意标志的默认值 * **别名** ：注意缩写形式（例如，“-h”代表“--help”） **模式识别：** * 标志命名：单字母与长格式一致性 * 参数约定：`<必需>` vs `[可选]` * 子命令组织：按域/资源分组 * 输出选项：`--json`、`--plain`、`--format` 加载“references/help-text-patterns.md”以获得全面的解析指导，包括正则表达式模式、格式变化和特殊情况。 ### GitHub 分析策略 **快速侦察：** * README.md 概述 * 文档目录结构 * 示例目录 * 贡献指南 **深度分析：** * 命令执行文件（揭示结构） * 测试文件（揭示使用模式） * 问题（揭示痛点） * 讨论（揭示社区问题） **框架检测：** 不同的 CLI 框架以不同的方式揭示结构： * **Cobra (Go)** ：`cmd/` 目录，每个命令包含文件 * **Click (Python)** ：函数上的装饰器 * **Commander (Node.js)** ：流畅的 API 链 * **Clap (Rust)** ：结构定义或构建器模式加载“references/help-text-patterns.md”部分“GitHub存储库分析”以获取详细的代码阅读策略。 ### 心智模型提取 **反省时问这些问题：** 1. **核心抽象**：此 CLI 操作的主要“事物”是什么？ 2. **动作模式**：它支持哪些动词/动作？ 3. **状态管理**：它跟踪状态吗？在哪里？ 4. **层次结构**：概念之间是否存在父子关系？ 5. **工作流程**：常见的操作顺序是什么？ **寻找明确的心理模型解释：** * 自述文件“它是如何工作的”部分 * 文档“概念”页面 * 架构图 * 设计原理文件 **从命令结构推断：** * 名词-动词表明以资源为导向的模型 * 动词-名词表明以行动为导向的模型 * 扁平结构意味着简单、单一用途的工具 * 深度嵌套建议复杂的领域模型 ## 技能结构指导 ### 选择正确的结构加载“references/skill-templates.md”以获取完整的模板和示例。 **基于工作流程**（何时使用）： * 清晰的顺序流程 * 大多数任务都遵循类似的步骤 * 入门重点很重要 * 示例：部署工具、CI/CD 工具 **基于命令**（使用时）： * 许多离散、独立的操作 * 用户需要命令参考 * 操作不遵循固定顺序 * 示例：文件操作工具、实用程序 **混合**（最常见的情况下使用）： * 通用工作流程和离散操作的混合 * 需要入门和综合参考 * 示例：gh、docker、kubectl、git ### 内容分布：skill.md 与references/ **skill.md 应包含：** * 清晰描述触发技能使用 * 工具用途概述 * 核心概念（2-5个关键概念） * 何时加载参考文献 * 常用操作（高层指导） * 工作流程决策指导 * 集成概述 **references/_reference.md 应包含：** * 综合心智模型 * 完整命令参考 * 所有工作流程模式（编号） * 完整的配置文档 * 详细的故障排除 * 集成细节 * 高级用法 **其他参考文件（需要时）：** * 专门 API 的单独文件（例如 GraphQL） * 大型模式引用的单独文件 * 用于扩展配置选项的单独文件 ### 组织命令参考 **最佳实践：** 1. **按域/资源分组**（不按字母顺序排列） * 将相关命令分组在一起 * 匹配用户心理模型 * 示例：“拉取请求命令”、“发出命令” 2. **按使用频率排序** * 最常用的操作优先 * 稍后提供高级功能 * 匹配渐进式学习 3. **每个命令包含：** * 目的（一句话） * 带有占位符的语法 * 关键标志（并非详尽无遗，链接到帮助） * 2-3个例子（从简单到复杂） * 相关命令 4. **使用一致的格式：** * 命令的代码块 * 标志参考表 * 编号的工作流程 * 清除章节标题 ### 编写有效的工作流程模式 **图案结构：** ### 模式 N：<描述性名称> **用例：** 何时使用此工作流程 **步骤：** 1. <步骤名称> <说明> ````bash <命令> 2. **完整示例：** # <场景> <完整工作流程> **变化：**替代方法 **模式最佳实践：** - 从最常见的工作流程开始 - 展示真实的例子（不是 foo/bar） - 包括预期输出 - 注意副作用或状态变化 - 链接到相关模式 - 提及先决条件加载“references/skill-templates.md”以获取完整的工作流模式模板和示例。 ## 与技能创建器集成该技能收集并组织 CLI 材料，然后委托给技能创建者来生成实际技能。 **工作流程：** 1. **cli-skill-creator**：反思 CLI，提取模式，组织材料 2. **交接**：向技能创建者提供结构化简介 3. **skill-creator**：生成技能文件、验证、打包 **结构化摘要格式：** 为技能创造者提供： - CLI 配置文件（名称、版本、用途、结构模式） - 核心心智模型（概念、术语） - 整理指挥参考资料 - 工作流程模式 - 整合点 - 配置和故障排除 **调用：** 使用技能工具：技能：技能创造者创建使用以下材料的技能：[完整的结构化简介] 使用[基于工作流/基于命令/混合]结构。遵循 gh/graphite/erk 技能的模式。 **这种方法的优点：** - 将内省与生成分开 - 利用技能创建者的验证和包装 - 与其他技能保持一致 - 允许迭代细化 ## 针对不同 CLI 类型的提示 ### 现代子命令 CLI（gh、docker、kubectl） **重点：** - 清晰的命令层次结构 - 工作流程模式（最重要） - 与生态系统整合 - 渐进的例子 **结构：** 混合（工作流程 + 命令参考） ### 简单实用 CLI（jq、curl、grep） **重点：** - 核心功能说明 - 常见用例 - 管道和成分 - 旗帜组合 **结构：** 基于命令或简单的工作流程 ### API-Wrapper CLI（aws、gcloud、heroku） **重点：** - API映射 - 身份验证模式 - JSON 输出处理 - 速率限制 **结构：** 基于命令，具有工作流模式 ### 旧版 CLI（tar、find、sed） **重点：** - 现代使用模式（并非所有历史选项） - 常见问题 - 现代替代品背景 - 安全警告 **结构：** 基于工作流（引导远离危险模式） ## 质量检查表在最终确定 CLI 技能之前： - [ ] 捕获所有主要命令和子命令 - [ ] 记录了 5-10 个常见工作流程模式 - [ ] 清晰提取核心心智模型 - [ ] 按用户任务组织（不按字母顺序） - [ ] 包括带有输出的实际示例 - [ ] 注意到的集成点 - [ ] 记录常见问题 - [ ] 验证命令确实有效 - [ ] 记录的 CLI 版本 - [ ] 链接至权威文档 - [ ] 遵循 gh/graphite/erk 技能结构 - [ ] Skill.md 简洁（<300 行） - [ ] 参考文献/包含全面的详细信息 ## 常见陷阱 **避免：** 1. **按字母顺序组织** - 按任务/领域组织 2. **详尽的标志文档** - 链接到帮助，仅显示常见标志 3. **缺少心智模型** - 始终解释如何思考该工具 4. **没有工作流程模式** - 用户需要面向任务的指导 5. **未经测试的示例** - 验证所有命令是否实际工作 6. **版本无关** - 注意记录了哪个版本 7. **缺少集成点** - 记录它如何与其他工具配合使用 8. **技能描述不佳** - 具体说明何时使用技能 ## 资源 ###参考资料/ 该技能包括两个综合参考文档： - **help-text-patterns.md** - 解析帮助文本、手册页和 GitHub 存储库的实用指南。内省 CLI 工具以进行全面信息提取时加载。 - **skill-templates.md** - 用于技能结构、命令参考、工作流程和部分的可重用模板。在组织材料和构建技能文档时加载。 **加载策略：** - 在自省步骤中加载`help-text-patterns.md`（步骤2-4） - 在组织和结构设计期间加载`skill-templates.md`（第6步）这些参考文献确保遵循现代最佳实践，创建一致、全面的 CLI 技能。

CLI 技能创建者

包含技能