quickstart.md +37 −21
1# Quickstart1# Quickstart
2 2
33Start using Codex in your IDE, CLI, or the cloudEvery ChatGPT plan includes Codex.
4
5ChatGPT Plus, Pro, Business, Edu, and Enterprise plans include Codex. Using Codex with your ChatGPT subscription gives you access to the latest Codex models and features.
6 4
7You can also use Codex with API credits by signing in with an OpenAI API key.5You can also use Codex with API credits by signing in with an OpenAI API key.
8 6
9For a limited time, **try Codex for free in ChatGPT Free and Go**, or enjoy
10**2x Codex rate limits** with Plus, Pro, Business and Enterprise
11subscriptions.
12
13## Setup7## Setup
14 8
159Choose an optionThe Codex app is available on macOS and Windows.
16
17AppRecommended (macOS only)IDE extensionCodex in your IDECLICodex in your terminalCloudCodex in your browser
18 10
1911The Codex app is available on macOS (Apple Silicon).Most Codex app features are available on both platforms. Platform-specific
12exceptions are noted in the relevant docs.
20 13
211. Download and install the Codex app141. Download and install the Codex app
22 15
2316 The Codex app is currently only available for macOS. Download the Codex app for macOS or Windows. Choose the Intel build if you're using an Intel-based Mac.
24 17
2518 [Download for macOS](https://persistent.oaistatic.com/codex-app-prod/Codex.dmg) [Download for macOS (Apple Silicon)](https://persistent.oaistatic.com/codex-app-prod/Codex.dmg)[Download for macOS (Intel)](https://persistent.oaistatic.com/codex-app-prod/Codex-latest-x64.dmg)
26 19
2720 [Get notified for Windows and Linux](https://openai.com/form/codex-app/) Need a different operating system?
21
22 [Download for Windows](https://get.microsoft.com/installer/download/9PLM9XGG6VKS?cid=website_cta_psi)
23
24 [Get notified for Linux](https://openai.com/form/codex-app/)
282. Open Codex and sign in252. Open Codex and sign in
29 26
30 Once you downloaded and installed the Codex app, open it and sign in with your ChatGPT account or an OpenAI API key.27 Once you downloaded and installed the Codex app, open it and sign in with your ChatGPT account or an OpenAI API key.
42 38
43 You can ask Codex anything about the project or your computer in general. Here are some examples:39 You can ask Codex anything about the project or your computer in general. Here are some examples:
44 40
4541 Tell me about this projectCopiedBuild a classic Snake game in this repo.CopiedFind and fix bugs in my codebase with minimal, high-confidence changes.Copied- Tell me about this project
42- Build a classic Snake game in this repo.
43- Find and fix bugs in my codebase with minimal, high-confidence changes.
46 44
4745 If you need more inspiration, check out the [explore section](https://developers.openai.com/codex/explore). If you need more inspiration, explore [Codex use cases](https://developers.openai.com/codex/use-cases).
4846 If you’re new to Codex, read the [best practices guide](https://developers.openai.com/codex/learn/best-practices).
49 [Learn more about the Codex app](https://developers.openai.com/codex/app)
50 47
51Install the Codex extension for your IDE.48Install the Codex extension for your IDE.
52 49
67 64
68 Codex starts in Agent mode by default, which lets it read files, run commands, and write changes in your project directory.65 Codex starts in Agent mode by default, which lets it read files, run commands, and write changes in your project directory.
69 66
7067 Tell me about this projectCopiedBuild a classic Snake game in this repo.CopiedFind and fix bugs in my codebase with minimal, high-confidence changes.Copied- Tell me about this project
68- Build a classic Snake game in this repo.
69- Find and fix bugs in my codebase with minimal, high-confidence changes.
714. Use Git checkpoints704. Use Git checkpoints
72 71
73 Codex can modify your codebase, so consider creating Git checkpoints before and after each task so you can easily revert changes if needed.72 Codex can modify your codebase, so consider creating Git checkpoints before and after each task so you can easily revert changes if needed.
73 If you’re new to Codex, read the [best practices guide](https://developers.openai.com/codex/learn/best-practices).
74 74
75 [Learn more about the Codex IDE extension](https://developers.openai.com/codex/ide)75 [Learn more about the Codex IDE extension](https://developers.openai.com/codex/ide)
76 76
96 96
97 Once authenticated, you can ask Codex to perform tasks in the current directory.97 Once authenticated, you can ask Codex to perform tasks in the current directory.
98 98
9999 Tell me about this projectCopiedBuild a classic Snake game in this repo.CopiedFind and fix bugs in my codebase with minimal, high-confidence changes.Copied- Tell me about this project
100- Build a classic Snake game in this repo.
101- Find and fix bugs in my codebase with minimal, high-confidence changes.
1004. Use Git checkpoints1024. Use Git checkpoints
101 103
102 Codex can modify your codebase, so consider creating Git checkpoints before and after each task so you can easily revert changes if needed.104 Codex can modify your codebase, so consider creating Git checkpoints before and after each task so you can easily revert changes if needed.
105 If you’re new to Codex, read the [best practices guide](https://developers.openai.com/codex/learn/best-practices).
103 106
104[Learn more about the Codex CLI](https://developers.openai.com/codex/cli)107[Learn more about the Codex CLI](https://developers.openai.com/codex/cli)
105 108
115 118
116 Once your environment is ready, launch coding tasks from the [Codex interface](https://chatgpt.com/codex). You can monitor progress in real time by viewing logs, or let tasks run in the background.119 Once your environment is ready, launch coding tasks from the [Codex interface](https://chatgpt.com/codex). You can monitor progress in real time by viewing logs, or let tasks run in the background.
117 120
118121 Tell me about this projectCopiedExplain the top failure modes of my application's architecture.CopiedFind and fix bugs in my codebase with minimal, high-confidence changes.Copied- Tell me about this project
122- Explain the top failure modes of my application's architecture.
123- Find and fix bugs in my codebase with minimal, high-confidence changes.
1194. Review changes and create a pull request1244. Review changes and create a pull request
120 125
121 When a task completes, review the proposed changes in the diff view. You can iterate on the results or create a pull request directly in your GitHub repository.126 When a task completes, review the proposed changes in the diff view. You can iterate on the results or create a pull request directly in your GitHub repository.
128 ```133 ```
129 134
130 [Learn more about Codex cloud](https://developers.openai.com/codex/cloud)135 [Learn more about Codex cloud](https://developers.openai.com/codex/cloud)
136
137## Next steps
138
139[Learn more about the Codex app
140
141Use the Codex app to work with your local projects.](https://developers.openai.com/codex/app)
142[Migrate to Codex
143
144 Move supported instruction files, MCP server configuration, skills, and
145subagents into Codex.](https://developers.openai.com/codex/migrate)