codex-docs について
Codex DocsはOpenAI Codexのドキュメントをローカルに保存したミラーで、GitHub Actionにより3時間ごとに更新されます。Codexの製品や設定について調べる人向けに、トピック索引と対象を絞った検索手順を備えています。
主な機能
- 01Codexドキュメントをローカル保存
- 023時間ごとに更新
- 03トピック索引と出典マニフェスト
- 04トピック別に文書を参照
活用シーン
- 01Codex CLIの動作や設定を確認
- 02CodexのMCPやhooksの文書を検索
- 03スキル、サブエージェント、サンドボックスを調査
- 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 ドキュメント
3 時間ごとの GitHub
Action によって最新の状態に保たれる、OpenAI Codex ドキュメントのローカルミラーです。整形済みの Markdown は references/ に、トピックの自動生成リストは references/INDEX.md に、各ファイルのマニフェストと上流 URL は references/docs_manifest.json にあります。
対象範囲
CLI の動作、codex.toml、スラッシュコマンド、Codex のフック、スキル、MCP、サブエージェント、AGENTS.md、プロンプト、サンドボックス化、クラウド環境、モデル、料金、セキュリティ、移行、ユースケースのレシピなど、Codex 固有の製品や設定に関する質問では、このスキルを使用してください。質問が Claude Code のフック、Cursor、一般的な OpenAI API、ChatGPT、GPT モデル、または Codex 以外の製品に関するものであれば、このスキルは適用されません。
ワークフロー
- ユーザーがトピックを指定した場合は、スラッグに正規化します。
- 小文字にし、先頭の
/docs/または/codex/を取り除き、前後のスラッシュを除去します - ネストされたセグメントを
__でつなぎます(例:cli features->cli__features、agent-configuration agents-md->agent-configuration__agents-md)
- 小文字にし、先頭の
references/<slug>.mdが存在する場合は、そのファイルを直接読みます。最初にreferences/ツリー全体を grep してはいけません。インデックスと対象を絞った読み込みのほうが速く、 コンテキストの使用量も少なくなります。- 完全一致するものがない場合は、
references/INDEX.mdを読み、最も近いトピックを選びます。まだ あいまいな場合は、候補を列挙して確認を求めます。 - ユーザーがトピックを指定していない場合は、
references/INDEX.mdを読み、利用可能なトピックを提示します。
回答形式
- 読み込んだファイルに基づき、ユーザーの質問に直接答えるところから始めます。
- ドキュメント内にそのまま記載されている場合は、短い抜粋(コマンド、設定キー)を引用します。
- ファイルのフロントマターまたは
references/docs_manifest.jsonにあるoriginal_urlを使い、最後にSource: <upstream URL>を記載します。
最新性とフォールバック
ミラーは上流 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 |