app.md +180 −21
4 4
5ChatGPT Plus, Pro, Business, Edu, and Enterprise plans include Codex. Learn more about [what's included](https://developers.openai.com/codex/pricing).5ChatGPT Plus, Pro, Business, Edu, and Enterprise plans include Codex. Learn more about [what's included](https://developers.openai.com/codex/pricing).
6 6
77<PlatformSpecificContent>
88 <CodexScreenshot
99 slot="windows"
10 alt="Codex app for Windows showing a project sidebar, active thread, and review pane"
11 lightSrc="/images/codex/windows/codex-windows-light.webp"
12 darkSrc="/images/codex/windows/codex-windows-dark.webp"
13 variant="no-wallpaper"
14 maxHeight="300px"
15 />
16 <CodexScreenshot
17 alt="Codex app window with a project sidebar, active thread, and review pane"
18 lightSrc="/images/codex/app/app-screenshot-light.webp"
19 darkSrc="/images/codex/app/app-screenshot-dark.webp"
20 variant="no-wallpaper"
21 maxHeight="300px"
22 />
23</PlatformSpecificContent>
10 24
11## Getting started25## Getting started
12 26
1327The Codex app is available on macOS (Apple Silicon).The Codex app is available on macOS and Windows.
28
29Most Codex app features are available on both platforms. Platform-specific
30exceptions are noted in the relevant docs.
14 31
32<WorkflowSteps variant="headings">
151. Download and install the Codex app331. Download and install the Codex app
16 34
1735 Download the Codex app for Windows or macOS. Download the Codex app for macOS or Windows. Choose the Intel build if you're using an Intel-based Mac.
18 36
1937 [Download for macOS](https://persistent.oaistatic.com/codex-app-prod/Codex.dmg) <CodexAppDownloadCta client:load className="mb-4" />
20 38
39 <div class="text-sm">
21 [Get notified for Linux](https://openai.com/form/codex-app/)40 [Get notified for Linux](https://openai.com/form/codex-app/)
41 </div>
42
222. Open Codex and sign in432. Open Codex and sign in
23 44
24 Once you downloaded and installed the Codex app, open it and sign in with your ChatGPT account or an OpenAI API key.45 Once you downloaded and installed the Codex app, open it and sign in with your ChatGPT account or an OpenAI API key.
36 58
37 You can ask Codex anything about the project or your computer in general. Here are some examples:59 You can ask Codex anything about the project or your computer in general. Here are some examples:
38 60
3961- Tell me about this project <ExampleGallery>
4062- Build a classic Snake game in this repo. <ExampleTask
4163- Find and fix bugs in my codebase with minimal, high-confidence changes. client:load
4264 id="intro"
4365 If you need more inspiration, check out the [explore section](https://developers.openai.com/codex/explore). prompt="Tell me about this project"
66 iconName="brain"
67 />
68 <ExampleTask
69 client:load
70 id="snake-game"
71 shortDescription="Build a classic Snake game in this repo."
72 prompt={[
73 "Build a classic Snake game in this repo.",
74 "",
75 "Scope & constraints:",
76 "- Implement ONLY the classic Snake loop: grid movement, growing snake, food spawn, score, game-over, restart.",
77 "- Reuse existing project tooling/frameworks; do NOT add new dependencies unless truly required.",
78 "- Keep UI minimal and consistent with the repo’s existing styles (no new design systems, no extra animations).",
79 "",
80 "Implementation plan:",
81 "1) Inspect the repo to find the right place to add a small interactive game (existing pages/routes/components).",
82 "2) Implement game state (snake positions, direction, food, score, tick timer) with deterministic, testable logic.",
83 "3) Render: simple grid + snake + food; support keyboard controls (arrow keys/WASD) and on-screen controls if mobile is present in the repo.",
84 "4) Add basic tests for the core game logic (movement, collisions, growth, food placement) if the repo has a test runner.",
85 "",
86 "Deliverables:",
87 "- A small set of files/changes with clear names.",
88 "- Short run instructions (how to start dev server + where to navigate).",
89 "- A brief checklist of what to manually verify (controls, pause/restart, boundaries).",
90 ].join("\n")}
91 iconName="gamepad"
92 />
93 <ExampleTask
94 client:load
95 id="fix-bugs"
96 shortDescription="Find and fix bugs in my codebase with minimal, high-confidence changes."
97 prompt={[
98 "Find and fix bugs in my codebase with minimal, high-confidence changes.",
99 "",
100 "Method (grounded + disciplined):",
101 "1) Reproduce: run tests/lint/build (or follow the existing repo scripts). If I provided an error, reproduce that exact failure.",
102 "2) Localize: identify the smallest set of files/lines involved (stack traces, failing tests, logs).",
103 "3) Fix: implement the minimal change that resolves the issue without refactors or unrelated cleanup.",
104 "4) Prove: add/update a focused test (or a tight repro) that fails before and passes after.",
105 "",
106 "Constraints:",
107 "- Do NOT invent errors or pretend to run commands you cannot run.",
108 "- No scope drift: no new features, no UI embellishments, no style overhauls.",
109 "- If information is missing, state what you can confirm from the repo and what remains unknown.",
110 "",
111 "Output:",
112 "- Summary (3–6 sentences max): what was broken, why, and the fix.",
113 "- Then ≤5 bullets: What changed, Where (paths), Evidence (tests/logs), Risks, Next steps.",
114 ].join("\n")}
115 iconName="search"
116 />
117 </ExampleGallery>
118
119 If you need more inspiration, explore [Codex use cases](https://developers.openai.com/codex/use-cases).
44 If you're new to Codex, read the [best practices guide](https://developers.openai.com/codex/learn/best-practices).120 If you're new to Codex, read the [best practices guide](https://developers.openai.com/codex/learn/best-practices).
45 121
122</WorkflowSteps>
123
46---124---
47 125
48## Work with the Codex app126## Work with the Codex app
49 127
50128[### Multitask across projects<BentoContainer class="mt-6">
129 <BentoContent href="/codex/app/features#multitask-across-projects">
130
131### Multitask across projects
132
133Run project threads side by side and switch between them quickly.
134
135 </BentoContent>
136 <BentoContent href="/codex/app/worktrees">
137
138### Worktrees
139
140Keep parallel code changes isolated with built-in Git worktree support.
141
142 </BentoContent>
143 <BentoContent href="/codex/remote-connections">
144
145### Remote connections
146
147Use the ChatGPT mobile app to start, steer, approve, and review Codex work on a
148connected host.
149
150 </BentoContent>
151 <BentoContent href="/codex/app/computer-use">
152
153### Computer use
154
155Let Codex use macOS apps for GUI tasks, browser flows, and native app testing.
156
157 </BentoContent>
158 <BentoContent href="/codex/app/review">
159
160### Review and ship changes
161
162Inspect diffs, address PR feedback, stage files, commit, and push.
163
164 </BentoContent>
165 <BentoContent href="/codex/app/features#integrated-terminal">
166
167### Terminal and actions
168
169Run commands in each thread and launch repeatable project actions.
170
171 </BentoContent>
172 <BentoContent href="/codex/app/browser">
173
174### In-app browser
175
176Open rendered pages, leave comments, or let Codex operate local browser flows.
177
178 </BentoContent>
179 <BentoContent href="/codex/app/chrome-extension">
180
181### Chrome extension
182
183Add the Chrome plugin so Codex can use Chrome for signed-in browser tasks while you manage website approvals.
184
185 </BentoContent>
186 <BentoContent href="/codex/app/features#image-generation">
187
188### Image generation
189
190Generate or edit images in a thread while you work on the surrounding code and assets.
191
192 </BentoContent>
193 <BentoContent href="/codex/app/automations">
194
195### Automations
196
197Schedule recurring tasks, or wake up the same thread for ongoing checks.
198
199 </BentoContent>
200 <BentoContent href="/codex/app/features#skills-support">
201
202### Skills
203
204Reuse instructions and workflows across the app, CLI, and IDE Extension.
205
206 </BentoContent>
207 <BentoContent href="/codex/app/features#richer-outputs-and-artifacts">
51 208
52209Run multiple tasks in parallel and switch quickly between them.](https://developers.openai.com/codex/app/features#multitask-across-projects)[### Built-in Git tools### Sidebar and artifacts
53 210
54211Review diffs, comment inline, stage or revert chunks, and commit without leaving the app.](https://developers.openai.com/codex/app/features#built-in-git-tools)[### Worktrees for parallel tasksFollow plans, sources, task summaries, and generated file previews.
55 212
56213Isolate changes of multiple Codex threads using built-in Git worktree support.](https://developers.openai.com/codex/app/worktrees)[### Skills support </BentoContent>
214 <BentoContent href="/codex/plugins">
57 215
58216Give your Codex agent additional capabilities and reuse skills across App, CLI, and IDE Extension.](https://developers.openai.com/codex/app/features#skills-support)[### Automations### Plugins
59 217
60218Pair skills with automations to automate recurring tasks in the background. Codex adds findings to the inbox, or automatically archives runs if there’s nothing to report.](https://developers.openai.com/codex/app/automations)[### Built-in terminalConnect apps, skills, and MCP servers to extend what Codex can do.
61 219
62220Open a terminal per thread to test your changes, run dev servers, scripts, and custom commands.](https://developers.openai.com/codex/app/features#integrated-terminal)[### Local environments </BentoContent>
221 <BentoContent href="/codex/app/features#sync-with-the-ide-extension">
63 222
64223Define worktree setup scripts and common project actions for easy access.](https://developers.openai.com/codex/app/local-environments)[### Sync with the IDE extension### IDE Extension sync
65 224
66225Share Auto Context and active threads across app and IDE sessions.](https://developers.openai.com/codex/app/features#sync-with-the-ide-extension)[### MCP supportShare Auto Context and active threads across app and IDE sessions.
67 226
68227Connect your Codex agent to additional services using MCP.](https://developers.openai.com/codex/app/features#mcp-support) </BentoContent>
228</BentoContainer>
69 229
70---230---
71 231