quickstart.md +18 −17
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
15Choose an option
16
17AppRecommended (macOS only)IDE extensionCodex in your IDECLICodex in your terminalCloudCodex in your browser
18
19The Codex app is available on macOS (Apple Silicon).9The Codex app is available on macOS (Apple Silicon).
20 10
211. Download and install the Codex app111. Download and install the Codex app
22 12
2313 The Codex app is currently only available for macOS. Download the Codex app for Windows or macOS.
24 14
25 [Download for macOS](https://persistent.oaistatic.com/codex-app-prod/Codex.dmg)15 [Download for macOS](https://persistent.oaistatic.com/codex-app-prod/Codex.dmg)
26 16
2717 [Get notified for Windows and Linux](https://openai.com/form/codex-app/) [Get notified for Linux](https://openai.com/form/codex-app/)
282. Open Codex and sign in182. Open Codex and sign in
29 19
30 Once you downloaded and installed the Codex app, open it and sign in with your ChatGPT account or an OpenAI API key.20 Once you downloaded and installed the Codex app, open it and sign in with your ChatGPT account or an OpenAI API key.
42 31
43 You can ask Codex anything about the project or your computer in general. Here are some examples:32 You can ask Codex anything about the project or your computer in general. Here are some examples:
44 33
4534 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
35- Build a classic Snake game in this repo.
36- Find and fix bugs in my codebase with minimal, high-confidence changes.
46 37
47 If you need more inspiration, check out the [explore section](https://developers.openai.com/codex/explore).38 If you need more inspiration, check out the [explore section](https://developers.openai.com/codex/explore).
39 If you’re new to Codex, read the [best practices guide](https://developers.openai.com/codex/learn/best-practices).
48 40
49 [Learn more about the Codex app](https://developers.openai.com/codex/app)41 [Learn more about the Codex app](https://developers.openai.com/codex/app)
50 42
67 59
68 Codex starts in Agent mode by default, which lets it read files, run commands, and write changes in your project directory.60 Codex starts in Agent mode by default, which lets it read files, run commands, and write changes in your project directory.
69 61
7062 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
63- Build a classic Snake game in this repo.
64- Find and fix bugs in my codebase with minimal, high-confidence changes.
714. Use Git checkpoints654. Use Git checkpoints
72 66
73 Codex can modify your codebase, so consider creating Git checkpoints before and after each task so you can easily revert changes if needed.67 Codex can modify your codebase, so consider creating Git checkpoints before and after each task so you can easily revert changes if needed.
68 If you’re new to Codex, read the [best practices guide](https://developers.openai.com/codex/learn/best-practices).
74 69
75 [Learn more about the Codex IDE extension](https://developers.openai.com/codex/ide)70 [Learn more about the Codex IDE extension](https://developers.openai.com/codex/ide)
76 71
96 91
97 Once authenticated, you can ask Codex to perform tasks in the current directory.92 Once authenticated, you can ask Codex to perform tasks in the current directory.
98 93
9994 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
95- Build a classic Snake game in this repo.
96- Find and fix bugs in my codebase with minimal, high-confidence changes.
1004. Use Git checkpoints974. Use Git checkpoints
101 98
102 Codex can modify your codebase, so consider creating Git checkpoints before and after each task so you can easily revert changes if needed.99 Codex can modify your codebase, so consider creating Git checkpoints before and after each task so you can easily revert changes if needed.
100 If you’re new to Codex, read the [best practices guide](https://developers.openai.com/codex/learn/best-practices).
103 101
104[Learn more about the Codex CLI](https://developers.openai.com/codex/cli)102[Learn more about the Codex CLI](https://developers.openai.com/codex/cli)
105 103
115 113
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.114 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 115
118116 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
117- Explain the top failure modes of my application's architecture.
118- Find and fix bugs in my codebase with minimal, high-confidence changes.
1194. Review changes and create a pull request1194. Review changes and create a pull request
120 120
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.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.