skill-creator by openai/skills
npx skills add https://github.com/openai/skills --skill skill-creator提供领域专业知识、工作流程和工具集成的文件及可选捆绑资源(脚本、参考资料、资产)
init_skill.py 初始化、编辑 SKILL.md 和资源、使用 quick_validate.py 验证、并根据使用情况迭代SKILL.md
此技能为创建有效的技能提供指导。
技能是模块化、自包含的文件夹,通过提供专业知识、工作流程和工具来扩展 Codex 的能力。可以将它们视为特定领域或任务的“入门指南”——它们将 Codex 从一个通用代理转变为配备有程序性知识的专业代理,这些知识是任何模型都无法完全掌握的。
上下文窗口是公共资源。技能与 Codex 所需的一切共享上下文窗口:系统提示、对话历史、其他技能的元数据以及实际的用户请求。
默认假设:Codex 已经非常智能。 只添加 Codex 尚未拥有的上下文。质疑每条信息:“Codex 真的需要这个解释吗?”以及“这段文字是否值得其令牌成本?”
优先选择简洁的示例,而非冗长的解释。
将具体程度与任务的脆弱性和可变性相匹配:
高自由度(基于文本的说明):当存在多种有效方法、决策取决于上下文或启发式方法指导时使用。
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者,精准高效
中等自由度(带参数的伪代码或脚本):当存在首选模式、允许一些变化或配置影响行为时使用。
低自由度(特定脚本,参数少):当操作脆弱且容易出错、一致性至关重要或必须遵循特定顺序时使用。
将 Codex 想象成探索一条路径:两侧是悬崖的狭窄桥梁需要特定的护栏(低自由度),而开阔的田野则允许多条路线(高自由度)。
每个技能都包含一个必需的 SKILL.md 文件和可选的捆绑资源:
skill-name/
├── SKILL.md (必需)
│ ├── YAML 前言元数据 (必需)
│ │ ├── name: (必需)
│ │ └── description: (必需)
│ └── Markdown 说明 (必需)
├── agents/ (推荐)
│ └── openai.yaml - 用于技能列表和标签的 UI 元数据
└── 捆绑资源 (可选)
├── scripts/ - 可执行代码 (Python/Bash/等)
├── references/ - 旨在按需加载到上下文中的文档
└── assets/ - 输出中使用的文件(模板、图标、字体等)
每个 SKILL.md 包含:
name 和 description 字段。这些是 Codex 用来决定何时使用该技能的唯一字段,因此清晰全面地描述技能是什么以及何时应该使用它非常重要。display_name、short_description 和 default_prompt--interface key=value 传递给 scripts/generate_openai_yaml.py 或 scripts/init_skill.py 来确定性生成agents/openai.yaml 是否仍与 SKILL.md 匹配;如果过时则重新生成scripts/)用于需要确定性可靠性或需要重复编写的任务的可执行代码(Python/Bash/等)。
scripts/rotate_pdf.pyreferences/)旨在按需加载到上下文中的文档和参考资料,以告知 Codex 的流程和思考。
references/finance.md,用于公司 NDA 模板的 references/mnda.md,用于公司政策的 references/policies.md,用于 API 规范的 references/api_docs.mdassets/)不打算加载到上下文中,而是在 Codex 产生的输出中使用的文件。
assets/logo.png,用于 PowerPoint 模板的 assets/slides.pptx,用于 HTML/React 样板代码的 assets/frontend-template/,用于字体的 assets/font.ttf技能应仅包含直接支持其功能的基本文件。请勿创建无关的文档或辅助文件,包括:
技能应仅包含 AI 代理完成手头工作所需的信息。它不应包含有关创建过程的辅助上下文、设置和测试程序、面向用户的文档等。创建额外的文档文件只会增加混乱和困惑。
技能使用三级加载系统来高效管理上下文:
保持 SKILL.md 主体精简,不超过 500 行,以最小化上下文膨胀。接近此限制时,将内容拆分为单独的文件。将内容拆分到其他文件时,从 SKILL.md 引用它们并清楚地描述何时读取它们非常重要,以确保技能的读者知道它们的存在以及何时使用它们。
关键原则: 当技能支持多种变体、框架或选项时,在 SKILL.md 中只保留核心工作流程和选择指南。将特定变体的详细信息(模式、示例、配置)移到单独的参考资料文件中。
模式 1:带有参考资料的高级指南
# PDF 处理
## 快速开始
使用 pdfplumber 提取文本:
[代码示例]
## 高级功能
- **表单填写**:完整指南请参阅 [FORMS.md](FORMS.md)
- **API 参考**:所有方法请参阅 [REFERENCE.md](REFERENCE.md)
- **示例**:常见模式请参阅 [EXAMPLES.md](EXAMPLES.md)
Codex 仅在需要时加载 FORMS.md、REFERENCE.md 或 EXAMPLES.md。
模式 2:特定领域组织
对于包含多个领域的技能,按领域组织内容以避免加载无关上下文:
bigquery-skill/
├── SKILL.md (概述和导航)
└── reference/
├── finance.md (收入、计费指标)
├── sales.md (机会、销售管道)
├── product.md (API 使用、功能)
└── marketing.md (活动、归因)
当用户询问销售指标时,Codex 只读取 sales.md。
同样,对于支持多个框架或变体的技能,按变体组织:
cloud-deploy/
├── SKILL.md (工作流程 + 提供商选择)
└── references/
├── aws.md (AWS 部署模式)
├── gcp.md (GCP 部署模式)
└── azure.md (Azure 部署模式)
当用户选择 AWS 时,Codex 只读取 aws.md。
模式 3:条件性细节
显示基本内容,链接到高级内容:
# DOCX 处理
## 创建文档
使用 docx-js 创建新文档。请参阅 [DOCX-JS.md](DOCX-JS.md)。
## 编辑文档
对于简单编辑,直接修改 XML。
**对于修订跟踪**:请参阅 [REDLINING.md](REDLINING.md)
**对于 OOXML 详细信息**:请参阅 [OOXML.md](OOXML.md)
Codex 仅在用户需要这些功能时读取 REDLINING.md 或 OOXML.md。
重要指南:
技能创建涉及以下步骤:
按顺序执行这些步骤,只有在有明确理由不适用时才跳过。
plan-mode)。gh-address-comments、linear-address-issue)。仅当技能的使用模式已经清晰理解时才跳过此步骤。即使在使用现有技能时,它仍然有价值。
要创建一个有效的技能,需要清楚地理解技能将如何使用的具体示例。这种理解可以来自直接的用户示例,也可以来自经过用户反馈验证的生成示例。
例如,在构建图像编辑器技能时,相关的问题包括:
为了避免让用户不知所措,避免在单个消息中提出太多问题。从最重要的问题开始,并根据需要跟进以获得更好的效果。
当对技能应支持的功能有清晰的认识时,结束此步骤。
为了将具体示例转化为有效的技能,通过以下方式分析每个示例:
示例:当构建 pdf-editor 技能来处理诸如“帮我旋转这个 PDF”的查询时,分析显示:
scripts/rotate_pdf.py 脚本会很有帮助示例:当设计一个 frontend-webapp-builder 技能来处理诸如“为我构建一个待办事项应用”或“为我构建一个跟踪步数的仪表板”的查询时,分析显示:
assets/hello-world/ 模板会很有帮助示例:当构建 big-query 技能来处理诸如“今天有多少用户登录?”的查询时,分析显示:
references/schema.md 文件会很有帮助为了确定技能的内容,分析每个具体示例,创建一个要包含的可复用资源列表:脚本、参考资料和资产。
此时,是时候实际创建技能了。
仅当正在开发的技能已经存在时才跳过此步骤。在这种情况下,继续下一步。
从头创建新技能时,始终运行 init_skill.py 脚本。该脚本方便地生成一个新的模板技能目录,自动包含技能所需的一切,使技能创建过程更加高效和可靠。
用法:
scripts/init_skill.py <skill-name> --path <output-directory> [--resources scripts,references,assets] [--examples]
示例:
scripts/init_skill.py my-skill --path skills/public
scripts/init_skill.py my-skill --path skills/public --resources scripts,references
scripts/init_skill.py my-skill --path skills/public --resources scripts --examples
该脚本:
--interface key=value 传递的代理生成的 display_name、short_description 和 default_prompt 创建 agents/openai.yaml--resources 可选创建资源目录--examples 时可选添加示例文件初始化后,根据需要自定义 SKILL.md 并添加资源。如果使用了 --examples,请替换或删除占位符文件。
通过阅读技能生成 display_name、short_description 和 default_prompt,然后将它们作为 --interface key=value 传递给 init_skill.py 或使用以下命令重新生成:
scripts/generate_openai_yaml.py <path/to/skill-folder> --interface key=value
仅在用户明确提供时才包含其他可选界面字段。有关完整字段描述和示例,请参阅 references/openai_yaml.md。
编辑(新生成或现有的)技能时,请记住,技能是为另一个 Codex 实例使用而创建的。包含对 Codex 有益且非显而易见的信息。考虑哪些程序性知识、领域特定细节或可复用资产将帮助另一个 Codex 实例更有效地执行这些任务。
开始实施时,从上面确定的可复用资源开始:scripts/、references/ 和 assets/ 文件。请注意,此步骤可能需要用户输入。例如,在实现 brand-guidelines 技能时,用户可能需要提供品牌资产或模板以存储在 assets/ 中,或提供文档以存储在 references/ 中。
添加的脚本必须通过实际运行来测试,以确保没有错误并且输出符合预期。如果有许多类似的脚本,只需要测试一个代表性样本,以确保它们都能正常工作,同时平衡完成时间。
如果使用了 --examples,请删除技能不需要的任何占位符文件。只创建实际需要的资源目录。
写作指南: 始终使用祈使句/不定式形式。
编写包含 name 和 description 的 YAML 前言:
name:技能名称description:这是技能的主要触发机制,帮助 Codex 理解何时使用该技能。
docx 技能的描述示例:“全面的文档创建、编辑和分析,支持修订跟踪、评论、格式保留和文本提取。当 Codex 需要处理专业文档(.docx 文件)时使用,用于:(1) 创建新文档,(2) 修改或编辑内容,(3) 处理修订跟踪,(4) 添加评论,或任何其他文档任务”不要在 YAML 前言中包含任何其他字段。
编写使用技能及其捆绑资源的说明。
技能开发完成后,验证技能文件夹以尽早发现基本问题:
scripts/quick_validate.py <path/to/skill-folder>
验证脚本检查 YAML 前言格式、必填字段和命名规则。如果验证失败,请修复报告的问题并再次运行该命令。
测试技能后,用户可能会请求改进。这通常发生在使用技能后不久,用户对技能的表现有新鲜的上下文。
迭代工作流程:
每周安装次数
508
仓库
GitHub 星标数
15.3K
首次出现
2026年1月20日
安全审计
安装于
codex439
opencode399
gemini-cli387
github-copilot376
cursor352
amp349
file and optional bundled resources (scripts, references, assets) that provide domain expertise, workflows, and tool integrations
init_skill.py, edit SKILL.md and resources, validate with quick_validate.py, and iterate based on usageSKILL.md
This skill provides guidance for creating effective skills.
Skills are modular, self-contained folders that extend Codex's capabilities by providing specialized knowledge, workflows, and tools. Think of them as "onboarding guides" for specific domains or tasks—they transform Codex from a general-purpose agent into a specialized agent equipped with procedural knowledge that no model can fully possess.
The context window is a public good. Skills share the context window with everything else Codex needs: system prompt, conversation history, other Skills' metadata, and the actual user request.
Default assumption: Codex is already very smart. Only add context Codex doesn't already have. Challenge each piece of information: "Does Codex really need this explanation?" and "Does this paragraph justify its token cost?"
Prefer concise examples over verbose explanations.
Match the level of specificity to the task's fragility and variability:
High freedom (text-based instructions) : Use when multiple approaches are valid, decisions depend on context, or heuristics guide the approach.
Medium freedom (pseudocode or scripts with parameters) : Use when a preferred pattern exists, some variation is acceptable, or configuration affects behavior.
Low freedom (specific scripts, few parameters) : Use when operations are fragile and error-prone, consistency is critical, or a specific sequence must be followed.
Think of Codex as exploring a path: a narrow bridge with cliffs needs specific guardrails (low freedom), while an open field allows many routes (high freedom).
Every skill consists of a required SKILL.md file and optional bundled resources:
skill-name/
├── SKILL.md (required)
│ ├── YAML frontmatter metadata (required)
│ │ ├── name: (required)
│ │ └── description: (required)
│ └── Markdown instructions (required)
├── agents/ (recommended)
│ └── openai.yaml - UI metadata for skill lists and chips
└── Bundled Resources (optional)
├── scripts/ - Executable code (Python/Bash/etc.)
├── references/ - Documentation intended to be loaded into context as needed
└── assets/ - Files used in output (templates, icons, fonts, etc.)
Every SKILL.md consists of:
name and description fields. These are the only fields that Codex reads to determine when the skill gets used, thus it is very important to be clear and comprehensive in describing what the skill is, and when it should be used.display_name, short_description, and default_prompt by reading the skill--interface key=value to scripts/generate_openai_yaml.py or scripts/init_skill.pyagents/openai.yaml still matches SKILL.md; regenerate if stalescripts/)Executable code (Python/Bash/etc.) for tasks that require deterministic reliability or are repeatedly rewritten.
scripts/rotate_pdf.py for PDF rotation tasksreferences/)Documentation and reference material intended to be loaded as needed into context to inform Codex's process and thinking.
references/finance.md for financial schemas, references/mnda.md for company NDA template, references/policies.md for company policies, references/api_docs.md for API specificationsassets/)Files not intended to be loaded into context, but rather used within the output Codex produces.
assets/logo.png for brand assets, assets/slides.pptx for PowerPoint templates, assets/frontend-template/ for HTML/React boilerplate, assets/font.ttf for typographyA skill should only contain essential files that directly support its functionality. Do NOT create extraneous documentation or auxiliary files, including:
The skill should only contain the information needed for an AI agent to do the job at hand. It should not contain auxiliary context about the process that went into creating it, setup and testing procedures, user-facing documentation, etc. Creating additional documentation files just adds clutter and confusion.
Skills use a three-level loading system to manage context efficiently:
Keep SKILL.md body to the essentials and under 500 lines to minimize context bloat. Split content into separate files when approaching this limit. When splitting out content into other files, it is very important to reference them from SKILL.md and describe clearly when to read them, to ensure the reader of the skill knows they exist and when to use them.
Key principle: When a skill supports multiple variations, frameworks, or options, keep only the core workflow and selection guidance in SKILL.md. Move variant-specific details (patterns, examples, configuration) into separate reference files.
Pattern 1: High-level guide with references
# PDF Processing
## Quick start
Extract text with pdfplumber:
[code example]
## Advanced features
- **Form filling**: See [FORMS.md](FORMS.md) for complete guide
- **API reference**: See [REFERENCE.md](REFERENCE.md) for all methods
- **Examples**: See [EXAMPLES.md](EXAMPLES.md) for common patterns
Codex loads FORMS.md, REFERENCE.md, or EXAMPLES.md only when needed.
Pattern 2: Domain-specific organization
For Skills with multiple domains, organize content by domain to avoid loading irrelevant context:
bigquery-skill/
├── SKILL.md (overview and navigation)
└── reference/
├── finance.md (revenue, billing metrics)
├── sales.md (opportunities, pipeline)
├── product.md (API usage, features)
└── marketing.md (campaigns, attribution)
When a user asks about sales metrics, Codex only reads sales.md.
Similarly, for skills supporting multiple frameworks or variants, organize by variant:
cloud-deploy/
├── SKILL.md (workflow + provider selection)
└── references/
├── aws.md (AWS deployment patterns)
├── gcp.md (GCP deployment patterns)
└── azure.md (Azure deployment patterns)
When the user chooses AWS, Codex only reads aws.md.
Pattern 3: Conditional details
Show basic content, link to advanced content:
# DOCX Processing
## Creating documents
Use docx-js for new documents. See [DOCX-JS.md](DOCX-JS.md).
## Editing documents
For simple edits, modify the XML directly.
**For tracked changes**: See [REDLINING.md](REDLINING.md)
**For OOXML details**: See [OOXML.md](OOXML.md)
Codex reads REDLINING.md or OOXML.md only when the user needs those features.
Important guidelines:
Skill creation involves these steps:
Follow these steps in order, skipping only if there is a clear reason why they are not applicable.
plan-mode).gh-address-comments, linear-address-issue).Skip this step only when the skill's usage patterns are already clearly understood. It remains valuable even when working with an existing skill.
To create an effective skill, clearly understand concrete examples of how the skill will be used. This understanding can come from either direct user examples or generated examples that are validated with user feedback.
For example, when building an image-editor skill, relevant questions include:
To avoid overwhelming users, avoid asking too many questions in a single message. Start with the most important questions and follow up as needed for better effectiveness.
Conclude this step when there is a clear sense of the functionality the skill should support.
To turn concrete examples into an effective skill, analyze each example by:
Example: When building a pdf-editor skill to handle queries like "Help me rotate this PDF," the analysis shows:
scripts/rotate_pdf.py script would be helpful to store in the skillExample: When designing a frontend-webapp-builder skill for queries like "Build me a todo app" or "Build me a dashboard to track my steps," the analysis shows:
assets/hello-world/ template containing the boilerplate HTML/React project files would be helpful to store in the skillExample: When building a big-query skill to handle queries like "How many users have logged in today?" the analysis shows:
references/schema.md file documenting the table schemas would be helpful to store in the skillTo establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, references, and assets.
At this point, it is time to actually create the skill.
Skip this step only if the skill being developed already exists. In this case, continue to the next step.
When creating a new skill from scratch, always run the init_skill.py script. The script conveniently generates a new template skill directory that automatically includes everything a skill requires, making the skill creation process much more efficient and reliable.
Usage:
scripts/init_skill.py <skill-name> --path <output-directory> [--resources scripts,references,assets] [--examples]
Examples:
scripts/init_skill.py my-skill --path skills/public
scripts/init_skill.py my-skill --path skills/public --resources scripts,references
scripts/init_skill.py my-skill --path skills/public --resources scripts --examples
The script:
agents/openai.yaml using agent-generated display_name, short_description, and default_prompt passed via --interface key=value--resources--examples is setAfter initialization, customize the SKILL.md and add resources as needed. If you used --examples, replace or delete placeholder files.
Generate display_name, short_description, and default_prompt by reading the skill, then pass them as --interface key=value to init_skill.py or regenerate with:
scripts/generate_openai_yaml.py <path/to/skill-folder> --interface key=value
Only include other optional interface fields when the user explicitly provides them. For full field descriptions and examples, see references/openai_yaml.md.
When editing the (newly-generated or existing) skill, remember that the skill is being created for another instance of Codex to use. Include information that would be beneficial and non-obvious to Codex. Consider what procedural knowledge, domain-specific details, or reusable assets would help another Codex instance execute these tasks more effectively.
To begin implementation, start with the reusable resources identified above: scripts/, references/, and assets/ files. Note that this step may require user input. For example, when implementing a brand-guidelines skill, the user may need to provide brand assets or templates to store in assets/, or documentation to store in references/.
Added scripts must be tested by actually running them to ensure there are no bugs and that the output matches what is expected. If there are many similar scripts, only a representative sample needs to be tested to ensure confidence that they all work while balancing time to completion.
If you used --examples, delete any placeholder files that are not needed for the skill. Only create resource directories that are actually required.
Writing Guidelines: Always use imperative/infinitive form.
Write the YAML frontmatter with name and description:
name: The skill namedescription: This is the primary triggering mechanism for your skill, and helps Codex understand when to use the skill.
docx skill: "Comprehensive document creation, editing, and analysis with support for tracked changes, comments, formatting preservation, and text extraction. Use when Codex needs to work with professional documents (.docx files) for: (1) Creating new documents, (2) Modifying or editing content, (3) Working with tracked changes, (4) Adding comments, or any other document tasks"Do not include any other fields in YAML frontmatter.
Write instructions for using the skill and its bundled resources.
Once development of the skill is complete, validate the skill folder to catch basic issues early:
scripts/quick_validate.py <path/to/skill-folder>
The validation script checks YAML frontmatter format, required fields, and naming rules. If validation fails, fix the reported issues and run the command again.
After testing the skill, users may request improvements. Often this happens right after using the skill, with fresh context of how the skill performed.
Iteration workflow:
Weekly Installs
508
Repository
GitHub Stars
15.3K
First Seen
Jan 20, 2026
Security Audits
Gen Agent Trust HubPassSocketPassSnykPass
Installed on
codex439
opencode399
gemini-cli387
github-copilot376
cursor352
amp349
agent-browser 浏览器自动化工具 - Vercel Labs 命令行网页操作与测试
138,300 周安装
SQL优化模式实战指南:索引策略与查询计划分析提升数据库性能
7,700 周安装
SwiftUI Pro代码审查工具 - 自动检查Swift/SwiftUI代码规范、性能与无障碍性
7,800 周安装
重构方法降低认知复杂度 - GitHub Copilot 代码优化技巧
7,600 周安装
Kotlin Spring Boot 最佳实践指南:构建高质量后端应用
7,600 周安装
Dataverse Python 高级模式:生产级SDK代码,含错误处理、批量操作与Pandas集成
7,600 周安装
Boost Prompt - AI 提示词优化助手 | GitHub Copilot 增强工具 | 提升编程效率
7,600 周安装