An unofficial OpenAI Codex guide for developers: quick start, core workflows, safety, configuration, and practical usage tips.
English · 中文
| Entry | Description |
|---|---|
| English Guide - Web Version | Recommended entry. Includes a left-side outline for quick navigation. |
| English Markdown Source | Markdown source for GitHub reading or editing. |
- Understand what Codex is and which development tasks it is good at.
- Choose between Codex App, CLI, IDE Extension, Cloud, GitHub, Slack, and Linear.
- Write effective prompts with goal, context, constraints, and done criteria.
- Learn Plan mode, Goal mode, threads, worktrees, and review workflows.
- Configure
config.toml,AGENTS.md, Skills, Plugins, MCP, Hooks, Rules, Automations, and Subagents. - See the August 10-18, 2026 official-doc update notes, including ChatGPT desktop, Voice, Work, Codex CLI 0.148.0, and availability caveats.
| Path | Purpose |
|---|---|
README.md |
English project homepage. |
README.zh-CN.md |
Chinese project homepage. |
AGENTS.md |
Per-session official Codex refresh, validation, and safe GitHub sync rules. |
docs/en-US.md |
English guide in Markdown. |
docs/zh-CN.md |
Chinese guide in Markdown. |
docs/en-US.html |
English web guide with a left-side outline. |
docs/zh-CN.html |
Chinese web guide with a left-side outline. |
assets/images/ |
Screenshots used by the Markdown guides and README. |
docs/assets/images/ |
Screenshot assets used by GitHub Pages. |
tools/generate_pages.py |
Generates the web pages with a left-side outline. |
docs/source-check.md |
Official documentation refresh and source-check notes. |
This repository is a learning companion, not a replacement for the official documentation.
- Codex overview
- Codex prompting
- Codex workflows
- Codex App
- Codex CLI
- Codex IDE Extension
- Configuration
- Agent approvals and security
- AGENTS.md
- Skills
- Plugins
- MCP
Source check: docs/source-check.md
The original guide text in this repository is released under the MIT License. OpenAI product names, trademarks, documentation, and screenshots remain subject to their respective owners' terms.