quickstart.md +12 −10
1# Quickstart1# Quickstart
2 2
3Start using Codex in your IDE, CLI, or the cloud
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.3ChatGPT 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.
12 10
13## Setup11## Setup
14 12
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).13The Codex app is available on macOS (Apple Silicon).
20 14
211. Download and install the Codex app151. Download and install the Codex app
42 36
43 You can ask Codex anything about the project or your computer in general. Here are some examples:37 You can ask Codex anything about the project or your computer in general. Here are some examples:
44 38
4539 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
40- Build a classic Snake game in this repo.
41- Find and fix bugs in my codebase with minimal, high-confidence changes.
46 42
47 If you need more inspiration, check out the [explore section](https://developers.openai.com/codex/explore).43 If you need more inspiration, check out the [explore section](https://developers.openai.com/codex/explore).
48 44
67 63
68 Codex starts in Agent mode by default, which lets it read files, run commands, and write changes in your project directory.64 Codex starts in Agent mode by default, which lets it read files, run commands, and write changes in your project directory.
69 65
7066 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
67- Build a classic Snake game in this repo.
68- Find and fix bugs in my codebase with minimal, high-confidence changes.
714. Use Git checkpoints694. Use Git checkpoints
72 70
73 Codex can modify your codebase, so consider creating Git checkpoints before and after each task so you can easily revert changes if needed.71 Codex can modify your codebase, so consider creating Git checkpoints before and after each task so you can easily revert changes if needed.
96 94
97 Once authenticated, you can ask Codex to perform tasks in the current directory.95 Once authenticated, you can ask Codex to perform tasks in the current directory.
98 96
9997 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
98- Build a classic Snake game in this repo.
99- Find and fix bugs in my codebase with minimal, high-confidence changes.
1004. Use Git checkpoints1004. Use Git checkpoints
101 101
102 Codex can modify your codebase, so consider creating Git checkpoints before and after each task so you can easily revert changes if needed.102 Codex can modify your codebase, so consider creating Git checkpoints before and after each task so you can easily revert changes if needed.
115 115
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.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.
117 117
118118 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
119- Explain the top failure modes of my application's architecture.
120- Find and fix bugs in my codebase with minimal, high-confidence changes.
1194. Review changes and create a pull request1214. Review changes and create a pull request
120 122
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.123 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.