关于 create-skill
create-skill 面向在代码仓库中构建完整技能目录的开发者和 Agent。它通过既定流程指导目录结构、文档、艺术资源、发现入口接入与验证。
主要功能
- 01检查仓库约定
- 02定义技能范围和元数据
- 03创建技能文件与艺术资源
- 04更新技能发现入口
- 05执行验证与差异检查
适用场景
- 01向仓库添加新技能
- 02准备技能元数据和艺术资源
- 03交付前检查技能包
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ tamdogood/ builder-essential-skills --skill create-skill安装后在 Claude Code 中输入/create-skill确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
README.mdagents/openai.yamlreferences/artwork.md详细介绍
创建技能
将技能创意转化为完整、易发现且可交付的技能文件夹。将技能说明、元数据、插图、README 接入和验证视为一个整体交付物。
工作流
-
了解仓库。 阅读
AGENTS.md、根目录的README.md、用途相近的最近现有技能,以及任何本地经验文件。编辑前,检查package.json、skills.sh.json、安装程序,以及现有的assets/skill-cards/和assets/skill-banners/规范。 -
明确约定。 从请求中提取技能 slug、用途、目标受众、触发短语、输入、输出和验收检查。将 slug 规范为小写连字符格式。保留用户的术语,但要在 frontmatter 描述中明确说明技能能力及其适用情形。
-
选择最精简实用的结构。 仅创建技能所需的资源:
- 用于核心工作流和路由规则的
skills/<slug>/SKILL.md。 - 用于展示元数据和明确的
$<slug>默认提示词的skills/<slug>/agents/openai.yaml。 - 用于渐进加载的详细领域指南的
skills/<slug>/references/。 - 仅在需要确定性、可重复自动化时使用
skills/<slug>/scripts/。 - 仅在技能会在输出中复用文件时使用
skills/<slug>/assets/。 - 用于记录此仓库中每个已发布技能的
skills/<slug>/README.md。
将
SKILL.md控制在 500 行以内。将深入规范和较长示例放入仅一层深的参考文件中,并在技能文件中直接链接。 - 用于核心工作流和路由规则的
-
编写技能。 使用祈使句式的指令。说明其他 Agent 无法安全推断的决策点、所需工具、文件路径、不变量、故障处理和验证命令。在
SKILL.md中采用简短工作流,并使用references/artwork.md等条件链接处理专门任务。 -
创建必需的插图。 在此仓库中,每个新技能都需要
assets/skill-cards/<slug>.svg,并且需要在根 README 的 选择技能 表格中添加对应行。当技能集合使用电影感横幅时,还要创建assets/skill-banners/<slug>.webp,并在根 README 和技能 README 中使用该横幅。创建任一资源前,请阅读 references/artwork.md。 -
接入所有发现入口。 更新所有明确列出技能的入口:根 README 卡片表、技能 README、
skills.sh.json分组,以及了解仓库时发现的任何注册表或安装程序允许列表。不要自行创建新的注册表文件。确认package.json已包含skills/和assets/目录树;只有在打包内容会因此遗漏新文件时才修改它。 -
交付前验证。 运行技能验证器、解析 SVG、检查渲染后的卡片和横幅、检查所有新增 README 链接、运行仓库测试套件,并运行
git diff --check。检查差异中是否存在过时名称、占位文本、缺失元数据、损坏的相对路径、未跟踪的必需资源,以及意外的无关改动。
技能内容要求
视情况加入以下章节:
- 范围和触发行为: 说明技能处理的内容以及不应处理的内容。
- 输入和输出: 说明预期文件、链接、用户决策和最终产物。
- 工作流: 给出最精简可靠的步骤,并明确分支条件。
- 资源: 说明何时阅读各参考文件或运行各脚本。
- 验证: 提供具体命令以及视觉或语义验收检查。
- 故障处理: 说明工具、依赖、参考资料或用户选择缺失时的处理方式。
已发布的技能中不得残留 TODO 标记、模板文本、臆测的工具名称或缺乏依据的声明。避免在 SKILL.md 中重复冗长的参考材料。
插画制作流程
使用内置图像生成工具制作新的栅格横幅。先检查两个或更多现有横幅,以及用户提供的任何参考图片。将参考图片视为风格和构图指导,而不是可供复制的内容。生成宽幅电影感场景;只有在工具能够可靠渲染时,才加入精确的标题文字。检查生成结果,并一次针对一个具体问题进行迭代。将最终项目资源保存为 WebP,并确保 SVG 卡片保持确定性且易于访问。
有关详细的视觉系统、提示词模板、构图规则、转换命令和审核清单,请阅读 references/artwork.md。
验证命令
在代码库根目录下,根据本地工具链调整以下命令:
python3 "${CODEX_HOME:-$HOME/.codex}/skills/.system/skill-creator/scripts/quick_validate.py" skills/<slug>
xmllint --noout assets/skill-cards/<slug>.svg
npm test
git diff --check
如果某条命令不可用,请使用代码库文档中说明的等效命令,并报告替代情况。在必需文件尚未纳入版本控制,或验证检查未通过时,不要宣称工作已完成。