OpenAI Codex Documentation
Reference for OpenAI Codex — AI coding agent available as CLI, desktop app, cloud, and IDE extension.
CRITICAL: grep references/ for detailed docs before answering.
Quick Start
# Install
npm install -g @openai/codex
# Interactive mode
codex "Explain this codebase"
# Non-interactive (CI/scripts)
codex exec "Fix all lint errors"
codex exec --json "List all TODO comments"
Key Concepts
| Concept | Description |
|---|---|
| Approval modes | Auto, Read-only, Full Access — control what Codex can do |
| Sandbox | Filesystem/network isolation for safe execution |
| Rules | Starlark-based execution policies (.codex/rules/) |
| Skills | Task-specific capabilities (.agents/skills/) |
| AGENTS.md | Custom system prompts per repo/directory |
| config.toml | User/project config (~/.codex/config.toml) |
| MCP | Model Context Protocol server integration |
| Multi-agent | Spawn sub-agents for parallel work |
Key Topics
CLI
references/cli/features.md— Interactive mode, sessions, model selectionreferences/cli/reference.md— CLI command referencereferences/cli/slash-commands.md—/model,/review,/plan,/permissions, etc.references/noninteractive.md—codex execfor CI/scripts
Configuration
references/config-basic.md— config.toml basicsreferences/config-advanced.md— Advanced configurationreferences/config-reference.md— Full config referencereferences/config-sample.md— Sample config file
Security & Sandbox
references/concepts/sandboxing.md— Sandbox modesreferences/rules.md— Execution policy rules (Starlark)references/agent-approvals-security.md— Approval systemreferences/security/— Security setup, threat model, FAQ
Customization
references/skills.md— Agent Skills systemreferences/guides/agents-md.md— AGENTS.md custom promptsreferences/custom-prompts.md— Custom prompts (deprecated, use skills)references/prompting.md— Prompting best practices
App & IDE
references/app/— Codex desktop app (features, automations, worktrees)references/ide/— VS Code extension (features, commands, settings)references/cloud/— Codex Cloud environments
Integrations
references/mcp.md— MCP server configurationreferences/integrations/github.md— GitHub integrationreferences/integrations/linear.md— Linear integrationreferences/integrations/slack.md— Slack integrationreferences/github-action.md— GitHub Action for CI
Enterprise
references/enterprise/admin-setup.md— Admin setupreferences/enterprise/managed-configuration.md— Managed configreferences/enterprise/governance.md— Governance policies
References
references/— 64 doc files from developers.openai.com/codexreferences/cli/— CLI features, reference, slash commandsreferences/app/— Desktop app docsreferences/ide/— IDE extension docsreferences/security/— Security & sandbox docsreferences/enterprise/— Enterprise administration