关于 codex-docs
Codex Docs 是 OpenAI Codex 文档的本地镜像,内容每 3 小时由 GitHub Action 更新。它面向查询 Codex 产品与配置的用户,提供主题索引和按需查阅流程。
主要功能
- 01本地保存 Codex 文档
- 02每 3 小时自动刷新
- 03提供主题索引与来源清单
- 04按主题查找对应文档
适用场景
- 01查询 Codex CLI 行为与配置
- 02查找 Codex 的 MCP 或 hooks 文档
- 03了解技能、子 Agent 与沙箱
- 04按主题定位文档并引用来源
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ mehmetbaykar/ codex-docs-skill --skill codex-docs安装后在 Claude Code 中输入/codex-docs确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
agents/openai.yamlreferences/administration.mdagent-approvals-security.mdagent-configuration__agents-md.mdagent-configuration__rules.mdagent-configuration__speed.mdagent-configuration__subagents.mdamazon-bedrock.mdannotations-extensibility.mdapp-server.mdapp.mdappshots.mdartifacts-viewer.mdauth.mdautomations.mdbrowser.mdbuild-plugins.mdbuild-skills.mdchangelog.mdchrome-extension.mdcli-customization.mdcloud__internet-access.mdcloud.mdcode-review.mdreferences/_raw/administration.mdconfiguration.mddevelopers.mdfeatures.mdglossary.mdsecurity-administration.md详细介绍
Codex 文档
OpenAI Codex 文档的本地镜像,每 3 小时由 GitHub Action 更新一次。清理后的 Markdown 文件位于 references/;自动生成的主题列表位于 references/INDEX.md;包含上游 URL 的逐文件清单位于 references/docs_manifest.json。
范围
在询问 Codex 专属产品和配置问题时使用此技能,包括 CLI 行为、codex.toml、斜杠命令、Codex 钩子、技能、MCP、子 Agent、AGENTS.md、提示词、沙盒、云环境、模型、定价、安全、迁移和用例方案。如果问题涉及 Claude Code 钩子、Cursor、通用 OpenAI API、ChatGPT、GPT 模型或其他非 Codex 产品,则不适用此技能。
工作流
- 如果用户提供了主题,将其规范化为 slug:
- 转为小写,去掉开头的
/docs/或/codex/,去掉首尾斜杠 - 用
__连接嵌套片段(例如,cli features->cli__features,agent-configuration agents-md->agent-configuration__agents-md)
- 转为小写,去掉开头的
- 如果
references/<slug>.md存在,直接读取该文件。不要先 grep 整个references/目录树——结合索引和定向读取速度更快,也更省上下文。 - 如果没有完全匹配的文件,读取
references/INDEX.md并选择最接近的主题。如果 仍然有歧义,列出候选项并询问用户。 - 如果用户没有提供主题,读取
references/INDEX.md并展示可用主题。
回答格式
- 开头直接回答用户的问题,并以读取的文件为依据。
- 如果文档中出现命令或配置键的原文,引用简短片段。
- 结尾使用
Source: <upstream URL>,URL 取自文件 frontmatter 中的original_url或references/docs_manifest.json。
更新与回退
镜像由上游 CI 每 3 小时刷新一次;如果内容被冻结,CI 会失败而不是提交冻结内容。如果本地内容看起来已过时、与用户提供的信息矛盾或为空:
- 建议用户运行
npx skills update codex-docs。 - 查看
references/docs_manifest.json中的文件条目:status为stale表示上次运行时无法访问上游。 - 通过
references/docs_manifest.json中的original_url核对规范 URL,并将其作为后续参考来源提供。 - 如果某个特定页面的 MDX 清理失败,未修改的源文件会保存在
references/_raw/<slug>.md——将其作为回退方案读取。
示例
| 用户提问 | 读取文件 |
|---|---|
| “Codex 钩子如何工作?” | references/hooks.md |
| “有哪些 CLI 标志和斜杠命令?” | references/developer-commands.md |
| “可以在 config.toml 中设置哪些内容?” | references/config-file__config-reference.md |
| “云环境如何工作?” | references/environments__cloud-environment.md |
| “应该如何编写 AGENTS.md?” | references/agent-configuration__agents-md.md |
| 没有主题或主题不明确 | references/INDEX.md |
评论
支持 Markdown