cli.md +76 −35
3Codex CLI is OpenAI's coding agent that you can run locally from your terminal. It can read, change, and run code on your machine in the selected directory.3Codex CLI is OpenAI's coding agent that you can run locally from your terminal. It can read, change, and run code on your machine in the selected directory.
4It's [open source](https://github.com/openai/codex) and built in Rust for speed and efficiency.4It's [open source](https://github.com/openai/codex) and built in Rust for speed and efficiency.
5 5
66Codex is included with ChatGPT Plus, Pro, Business, Edu, and Enterprise plans. Learn more about [what’s included](https://developers.openai.com/codex/pricing).ChatGPT Plus, Pro, Business, Edu, and Enterprise plans include Codex. Learn more about [what's included](https://developers.openai.com/codex/pricing).
7
8<YouTubeEmbed
9 title="Codex CLI overview"
10 videoId="iqNzfK4_meQ"
11 class="max-w-md"
12/>
13<br />
7 14
8## CLI setup15## CLI setup
9 16
1017Choose your package manager<CliSetupSteps client:load />
11 18
1219npmHomebrewThe Codex CLI is available on macOS, Windows, and Linux. On Windows, run Codex
20 natively in PowerShell with the Windows sandbox, or use WSL2 when you need a
21 Linux-native environment. For setup details, see the{" "}
22 <a href="/codex/windows">Windows setup guide</a>.
13 23
14241. 1If you're new to Codex, read the [best practices guide](https://developers.openai.com/codex/learn/best-practices).
15 25
1626 ### Install---
17 27
1828 Install the Codex CLI with npm.## Work with the Codex CLI
19 29
2030 npm install command<BentoContainer>
31 <BentoContent href="/codex/cli/features#running-in-interactive-mode">
21 32
2233 npm i -g @openai/codexCopy### Run Codex interactively
232. 2
24 34
2535 ### RunRun `codex` to start an interactive terminal UI (TUI) session.
26 36
2737 Run Codex in a terminal. It can inspect your repository, edit files, and run commands. </BentoContent>
38 <BentoContent href="/codex/cli/features#models-reasoning">
28 39
2940 Run Codex command### Control model and reasoning
30 41
3142 codexCopyUse `/model` to switch between GPT-5.4, GPT-5.3-Codex, and other available models, or adjust reasoning levels.
32 43
3344 The first time you run Codex, you'll be prompted to sign in. Authenticate with your ChatGPT account or an API key. </BentoContent>
45 <BentoContent href="/codex/cli/features#image-inputs">
34 46
3547 See the [pricing page](https://developers.openai.com/codex/pricing) if you're not sure which plans include Codex access.### Image inputs
363. 3
37 48
3849 ### UpgradeAttach screenshots or design specs so Codex reads them alongside your prompt.
39 50
4051 New versions of the Codex CLI are released regularly. See the [changelog](https://developers.openai.com/codex/changelog) for release notes. To upgrade with npm, run: </BentoContent>
52 <BentoContent href="/codex/cli/features#image-generation">
41 53
4254 npm upgrade command### Image generation
43 55
4456 npm i -g @openai/codex@latestCopyGenerate or edit images directly in the CLI, and attach references when you want Codex to iterate on an existing asset.
45 57
4658The Codex CLI is available on macOS and Linux. Windows support is </BentoContent>
47experimental. For the best Windows experience, use Codex in a WSL workspace
48and follow our [Windows setup guide](https://developers.openai.com/codex/windows).
49 59
60 <BentoContent href="/codex/cli/features#running-local-code-review">
50 61
5162## Work with the Codex CLI### Run local code review
63
64Get your code reviewed by a separate Codex agent before you commit or push your changes.
65
66 </BentoContent>
67
68 <BentoContent href="/codex/subagents">
69
70### Use subagents
71
72Use subagents to parallelize complex tasks.
73
74 </BentoContent>
75
76 <BentoContent href="/codex/cli/features#web-search">
77
78### Web search
79
80Use Codex to search the web and get up-to-date information for your task.
81
82 </BentoContent>
83
84 <BentoContent href="/codex/cli/features#working-with-codex-cloud">
85
86### Codex Cloud tasks
87
88Launch a Codex Cloud task, choose environments, and apply the resulting diffs without leaving your terminal.
89
90 </BentoContent>
52 91
5392[### Run Codex interactively <BentoContent href="/codex/noninteractive">
54 93
5594Run `codex` to start an interactive terminal UI (TUI) session.](https://developers.openai.com/codex/cli/features#running-in-interactive-mode)[### Control model and reasoning### Scripting Codex
56 95
5796Use `/model` to switch between GPT-5.4, GPT-5.3-Codex, and other available models, or adjust reasoning levels.](https://developers.openai.com/codex/cli/features#models-reasoning)[### Image inputsAutomate repeatable workflows by scripting Codex with the `exec` command.
58 97
5998Attach screenshots or design specs so Codex reads them alongside your prompt.](https://developers.openai.com/codex/cli/features#image-inputs)[### Run local code review </BentoContent>
99 <BentoContent href="/codex/mcp">
60 100
61101Get your code reviewed by a separate Codex agent before you commit or push your changes.](https://developers.openai.com/codex/cli/features#running-local-code-review)[### Use multi-agent### Model Context Protocol
62 102
63103Enable experimental multi-agent collaboration and parallelize complex tasks.](https://developers.openai.com/codex/multi-agent)[### Web searchGive Codex access to additional third-party tools and context with Model Context Protocol (MCP).
64 104
65105Use Codex to search the web and get up-to-date information for your task.](https://developers.openai.com/codex/cli/features#web-search)[### Codex Cloud tasks </BentoContent>
66 106
67107Launch a Codex Cloud task, choose environments, and apply the resulting diffs without leaving your terminal.](https://developers.openai.com/codex/cli/features#working-with-codex-cloud)[### Scripting Codex <BentoContent href="/codex/cli/features#approval-modes">
68 108
69109Automate repeatable workflows by scripting Codex with the `exec` command.](https://developers.openai.com/codex/sdk#using-codex-cli-programmatically)[### Model Context Protocol### Approval modes
70 110
71111Give Codex access to additional third-party tools and context with Model Context Protocol (MCP).](https://developers.openai.com/codex/mcp)[### Approval modesChoose the approval mode that matches your comfort level before Codex edits or runs commands.
72 112
73113Choose the approval mode that matches your comfort level before Codex edits or runs commands.](https://developers.openai.com/codex/cli/features#approval-modes) </BentoContent>
114</BentoContainer>