OpenAI - Codex Docs Changes

app.md +4 −10

Details

1# Codex app1# Codex app

2 2

~~3Your Codex command center~~

5The Codex app is a focused desktop experience for working on Codex threads in parallel, with built-in worktree support, automations, and Git functionality.3The Codex app is a focused desktop experience for working on Codex threads in parallel, with built-in worktree support, automations, and Git functionality.

6 4

7ChatGPT 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).

8 6

9![Codex app window with a project sidebar, active thread, and review pane](/images/codex/app/app-screenshot-light.webp) ![Codex app window with a project sidebar, active thread, and review pane](/images/codex/app/app-screenshot-dark.webp)7![Codex app window with a project sidebar, active thread, and review pane](/images/codex/app/app-screenshot-light.webp)

11![Codex app window with a project sidebar, active thread, and review pane](/images/codex/app/app-screenshot-light.webp) ![Codex app window with a project sidebar, active thread, and review pane](/images/codex/app/app-screenshot-dark.webp)

12 8

13## Getting started9## Getting started

14 10

38 34

39 You can ask Codex anything about the project or your computer in general. Here are some examples:35 You can ask Codex anything about the project or your computer in general. Here are some examples:

40 36

41 ![](https://developers.openai.com/codex/colorcons/brain.png)Tell me about this projectCopied![](https://developers.openai.com/codex/colorcons/gamepad.png)Build a classic Snake game in this repo.Copied![](https://developers.openai.com/codex/colorcons/search.png)Find and fix bugs in my codebase with minimal, high-confidence changes.Copied37- Tell me about this project

38- Build a classic Snake game in this repo.

39- Find and fix bugs in my codebase with minimal, high-confidence changes.

42 40

43 If you need more inspiration, check out the [explore section](https://developers.openai.com/codex/explore).41 If you need more inspiration, check out the [explore section](https://developers.openai.com/codex/explore).

44 42

69---67---

70 68

71Need help? Visit the [troubleshooting guide](https://developers.openai.com/codex/app/troubleshooting).69Need help? Visit the [troubleshooting guide](https://developers.openai.com/codex/app/troubleshooting).

~~73[Next~~

~~75Features](https://developers.openai.com/codex/app/features)~~

app-server.md +0 −2

Details

1# Codex App Server1# Codex App Server

2 2

~~3Embed Codex into your product with the app-server protocol~~

5Codex app-server is the interface Codex uses to power rich clients (for example, the Codex VS Code extension). Use it when you want a deep integration inside your own product: authentication, conversation history, approvals, and streamed agent events. The app-server implementation is open source in the Codex GitHub repository ([openai/codex/codex-rs/app-server](https://github.com/openai/codex/tree/main/codex-rs/app-server)). See the [Open Source](https://developers.openai.com/codex/open-source) page for the full list of open-source Codex components.3Codex app-server is the interface Codex uses to power rich clients (for example, the Codex VS Code extension). Use it when you want a deep integration inside your own product: authentication, conversation history, approvals, and streamed agent events. The app-server implementation is open source in the Codex GitHub repository ([openai/codex/codex-rs/app-server](https://github.com/openai/codex/tree/main/codex-rs/app-server)). See the [Open Source](https://developers.openai.com/codex/open-source) page for the full list of open-source Codex components.

6 4

7If you are automating jobs or running Codex in CI, use the5If you are automating jobs or running Codex in CI, use the

app/automations.md +1 −11

Details

1# Automations1# Automations

2 2

~~3Schedule recurring Codex tasks~~

5Automate recurring tasks in the background. Codex adds findings to the inbox, or automatically archives the task if there's nothing to report. You can combine automations with [skills](https://developers.openai.com/codex/skills) for more complex tasks.3Automate recurring tasks in the background. Codex adds findings to the inbox, or automatically archives the task if there's nothing to report. You can combine automations with [skills](https://developers.openai.com/codex/skills) for more complex tasks.

6 4

7Automations run locally in the Codex app. The app needs to be running, and the5Automations run locally in the Codex app. The app needs to be running, and the

12checkout. In non-version-controlled projects, automations run directly in the10checkout. In non-version-controlled projects, automations run directly in the

13project directory.11project directory.

14 12

15![Automation creation form with schedule and prompt fields](/images/codex/app/create-automation-light.webp) ![Automation creation form with schedule and prompt fields](/images/codex/app/create-automation-dark.webp)13![Automation creation form with schedule and prompt fields](/images/codex/app/create-automation-light.webp)

17![Automation creation form with schedule and prompt fields](/images/codex/app/create-automation-light.webp) ![Automation creation form with schedule and prompt fields](/images/codex/app/create-automation-dark.webp)

18 14

19## Managing tasks15## Managing tasks

20 16

174```markdown170```markdown

175Check my commits from the last 24h and submit a $recent-code-bugfix.171Check my commits from the last 24h and submit a $recent-code-bugfix.

176```172```

~~177~~

178[Previous

~~179~~

180Review](https://developers.openai.com/codex/app/review)[Next

~~181~~

182Worktrees](https://developers.openai.com/codex/app/worktrees)

app/commands.md +0 −8

Details

1# Codex app commands1# Codex app commands

2 2

~~3Reference for Codex app commands and keyboard shortcuts~~

5Use these commands and keyboard shortcuts to navigate the Codex app.3Use these commands and keyboard shortcuts to navigate the Codex app.

6 4

7## Keyboard shortcuts5## Keyboard shortcuts

54 52

55- [Features](https://developers.openai.com/codex/app/features)53- [Features](https://developers.openai.com/codex/app/features)

56- [Settings](https://developers.openai.com/codex/app/settings)54- [Settings](https://developers.openai.com/codex/app/settings)

~~58[Previous~~

~~60Local Environments](https://developers.openai.com/codex/app/local-environments)[Next~~

~~62Troubleshooting](https://developers.openai.com/codex/app/troubleshooting)~~

app/features.md +9 −35

Details

1# Codex app features1# Codex app features

2 2

~~3What you can do with the Codex app~~

5The Codex app is a focused desktop experience for working on Codex threads in parallel,3The Codex app is a focused desktop experience for working on Codex threads in parallel,

6with built-in worktree support, automations, and Git functionality.4with built-in worktree support, automations, and Git functionality.

7 5

19distinct projects into separate app projects so the [sandbox](https://developers.openai.com/codex/security)17distinct projects into separate app projects so the [sandbox](https://developers.openai.com/codex/security)

20only includes the files for that project.18only includes the files for that project.

21 19

22![Codex app showing multiple projects in the sidebar and threads in the main pane](/images/codex/app/multitask-light.webp) ![Codex app showing multiple projects in the sidebar and threads in the main pane](/images/codex/app/multitask-dark.webp)20![Codex app showing multiple projects in the sidebar and threads in the main pane](/images/codex/app/multitask-light.webp)

24![Codex app showing multiple projects in the sidebar and threads in the main pane](/images/codex/app/multitask-light.webp) ![Codex app showing multiple projects in the sidebar and threads in the main pane](/images/codex/app/multitask-dark.webp)

25 21

26## Skills support22## Skills support

27 23

29IDE Extension. You can also view and explore new skills that your team has25IDE Extension. You can also view and explore new skills that your team has

30created across your different projects by clicking Skills in the sidebar.26created across your different projects by clicking Skills in the sidebar.

31 27

32![Skills picker showing available skills in the Codex app](/images/codex/app/skill-selector-light.webp) ![Skills picker showing available skills in the Codex app](/images/codex/app/skill-selector-dark.webp)28![Skills picker showing available skills in the Codex app](/images/codex/app/skill-selector-light.webp)

34![Skills picker showing available skills in the Codex app](/images/codex/app/skill-selector-light.webp) ![Skills picker showing available skills in the Codex app](/images/codex/app/skill-selector-dark.webp)

35 29

36## Automations30## Automations

37 31

39such as evaluating errors in your telemetry and submitting fixes or creating reports on recent33such as evaluating errors in your telemetry and submitting fixes or creating reports on recent

40codebase changes.34codebase changes.

41 35

42![Automation creation form with schedule and prompt fields](/images/codex/app/create-automation-light.webp) ![Automation creation form with schedule and prompt fields](/images/codex/app/create-automation-dark.webp)36![Automation creation form with schedule and prompt fields](/images/codex/app/create-automation-light.webp)

44![Automation creation form with schedule and prompt fields](/images/codex/app/create-automation-light.webp) ![Automation creation form with schedule and prompt fields](/images/codex/app/create-automation-dark.webp)

45 37

46## Modes38## Modes

47 39

55 47

56For the full glossary and concepts, explore the [concepts section](https://developers.openai.com/codex/prompting).48For the full glossary and concepts, explore the [concepts section](https://developers.openai.com/codex/prompting).

57 49

58![New thread composer with Local, Worktree, and Cloud mode options](/images/codex/app/modes-light.webp) ![New thread composer with Local, Worktree, and Cloud mode options](/images/codex/app/modes-dark.webp)50![New thread composer with Local, Worktree, and Cloud mode options](/images/codex/app/modes-light.webp)

60![New thread composer with Local, Worktree, and Cloud mode options](/images/codex/app/modes-light.webp) ![New thread composer with Local, Worktree, and Cloud mode options](/images/codex/app/modes-dark.webp)

61 51

62## Built-in Git tools52## Built-in Git tools

63 53

71 61

72For more advanced Git tasks, use the [integrated terminal](#integrated-terminal).62For more advanced Git tasks, use the [integrated terminal](#integrated-terminal).

73 63

~~74![Git diff and commit panel with a commit message field](/images/codex/app/git-commit-light.webp) ![Git diff and commit panel with a commit message field](/images/codex/app/git-commit-dark.webp)~~64![Git diff and commit panel with a commit message field](/images/codex/app/git-commit-light.webp)

~~76![Git diff and commit panel with a commit message field](/images/codex/app/git-commit-light.webp) ![Git diff and commit panel with a commit message field](/images/codex/app/git-commit-dark.webp)~~

77 65

78## Worktree support66## Worktree support

79 67

88 76

89[Learn more about using worktrees in the Codex app.](https://developers.openai.com/codex/app/worktrees)77[Learn more about using worktrees in the Codex app.](https://developers.openai.com/codex/app/worktrees)

90 78

91![Worktree thread view showing branch actions and worktree details](/images/codex/app/worktree-light.webp) ![Worktree thread view showing branch actions and worktree details](/images/codex/app/worktree-dark.webp)79![Worktree thread view showing branch actions and worktree details](/images/codex/app/worktree-light.webp)

93![Worktree thread view showing branch actions and worktree details](/images/codex/app/worktree-light.webp) ![Worktree thread view showing branch actions and worktree details](/images/codex/app/worktree-dark.webp)

94 80

95## Integrated terminal81## Integrated terminal

96 82

113Note that <kbd>Cmd</kbd>+<kbd>K</kbd> opens the command palette in the Codex99Note that <kbd>Cmd</kbd>+<kbd>K</kbd> opens the command palette in the Codex

114app. It doesn't clear the terminal. To clear the terminal use <kbd>Ctrl</kbd>+<kbd>L</kbd>.100app. It doesn't clear the terminal. To clear the terminal use <kbd>Ctrl</kbd>+<kbd>L</kbd>.

115 101

116![Integrated terminal drawer open beneath a Codex thread](/images/codex/app/integrated-terminal-light.webp) ![Integrated terminal drawer open beneath a Codex thread](/images/codex/app/integrated-terminal-dark.webp)102![Integrated terminal drawer open beneath a Codex thread](/images/codex/app/integrated-terminal-light.webp)

~~117~~

118![Integrated terminal drawer open beneath a Codex thread](/images/codex/app/integrated-terminal-light.webp) ![Integrated terminal drawer open beneath a Codex thread](/images/codex/app/integrated-terminal-dark.webp)

119 103

120## Voice dictation104## Voice dictation

121 105

122Use your voice to prompt Codex. Hold <kbd>Ctrl</kbd>+<kbd>M</kbd> while the composer is visible and start talking. Your voice will be transcribed. Edit the transcribed prompt or hit send to have Codex start work.106Use your voice to prompt Codex. Hold <kbd>Ctrl</kbd>+<kbd>M</kbd> while the composer is visible and start talking. Your voice will be transcribed. Edit the transcribed prompt or hit send to have Codex start work.

123 107

124![Voice dictation indicator in the composer with a transcribed prompt](/images/codex/app/voice-dictation-light.webp) ![Voice dictation indicator in the composer with a transcribed prompt](/images/codex/app/voice-dictation-dark.webp)108![Voice dictation indicator in the composer with a transcribed prompt](/images/codex/app/voice-dictation-light.webp)

~~125~~

126![Voice dictation indicator in the composer with a transcribed prompt](/images/codex/app/voice-dictation-light.webp) ![Voice dictation indicator in the composer with a transcribed prompt](/images/codex/app/voice-dictation-dark.webp)

127 109

128## Floating pop-out window110## Floating pop-out window

129 111

134You can also toggle the pop-out window to stay on top when you want it to remain116You can also toggle the pop-out window to stay on top when you want it to remain

135visible across your workflow.117visible across your workflow.

136 118

137![Pop-out window preview in light mode](/images/codex/app/popover-light.webp) ![Pop-out window preview in light mode](/images/codex/app/popover-dark.webp)119![Pop-out window preview in light mode](/images/codex/app/popover-light.webp)

~~138~~

139![Pop-out window preview in light mode](/images/codex/app/popover-light.webp) ![Pop-out window preview in light mode](/images/codex/app/popover-dark.webp)

140 120

141---121---

142 122

216- [Automations](https://developers.openai.com/codex/app/automations)196- [Automations](https://developers.openai.com/codex/app/automations)

217- [Local environments](https://developers.openai.com/codex/app/local-environments)197- [Local environments](https://developers.openai.com/codex/app/local-environments)

218- [Worktrees](https://developers.openai.com/codex/app/worktrees)198- [Worktrees](https://developers.openai.com/codex/app/worktrees)

~~219~~

220[Previous

~~221~~

222Overview](https://developers.openai.com/codex/app)[Next

~~223~~

224Settings](https://developers.openai.com/codex/app/settings)

app/local-environments.md +1 −11

Details

1# Local environments1# Local environments

2 2

~~3Configure common actions and setup scripts for worktrees~~

5Local environments let you configure setup steps for worktrees as well as common actions for a project.3Local environments let you configure setup steps for worktrees as well as common actions for a project.

6 4

7You configure your local environments through the [Codex app settings](codex://settings) pane. You can check the generated file into your project's Git repository to share with others.5You configure your local environments through the [Codex app settings](codex://settings) pane. You can check the generated file into your project's Git repository to share with others.

31 29

32Actions are helpful to keep you from typing common actions like triggering a build for your project or starting a development server. For one-off quick debugging you can use the integrated terminal directly.30Actions are helpful to keep you from typing common actions like triggering a build for your project or starting a development server. For one-off quick debugging you can use the integrated terminal directly.

33 31

~~34![Project actions list shown in Codex app settings](/images/codex/app/actions-light.webp) ![Project actions list shown in Codex app settings](/images/codex/app/actions-dark.webp)~~32![Project actions list shown in Codex app settings](/images/codex/app/actions-light.webp)

~~36![Project actions list shown in Codex app settings](/images/codex/app/actions-light.webp) ![Project actions list shown in Codex app settings](/images/codex/app/actions-dark.webp)~~

37 33

38For example, for a Node.js project you might create a "Run" action that contains the following script:34For example, for a Node.js project you might create a "Run" action that contains the following script:

39 35

44If the commands for your action are platform-specific, define platform-specific scripts for macOS, Windows, and Linux.40If the commands for your action are platform-specific, define platform-specific scripts for macOS, Windows, and Linux.

45 41

46To identify your actions, choose an icon associated with each action.42To identify your actions, choose an icon associated with each action.

~~48[Previous~~

~~50Worktrees](https://developers.openai.com/codex/app/worktrees)[Next~~

~~52Commands](https://developers.openai.com/codex/app/commands)~~

app/review.md +1 −11

Details

1# Review1# Review

2 2

~~3Review and iterate with Codex on changes inside the app~~

5The review pane helps you understand what Codex changed, give targeted feedback, and decide what to keep.3The review pane helps you understand what Codex changed, give targeted feedback, and decide what to keep.

6 4

7It only works for projects that live inside a Git repository. If your project5It only works for projects that live inside a Git repository. If your project

57If you use `/review` to run a code review, comments will show up directly55If you use `/review` to run a code review, comments will show up directly

58inline in the review pane.56inline in the review pane.

59 57

60![Inline code review comments displayed in the review pane](/images/codex/app/inline-code-review-light.webp) ![Inline code review comments displayed in the review pane](/images/codex/app/inline-code-review-dark.webp)58![Inline code review comments displayed in the review pane](/images/codex/app/inline-code-review-light.webp)

62![Inline code review comments displayed in the review pane](/images/codex/app/inline-code-review-light.webp) ![Inline code review comments displayed in the review pane](/images/codex/app/inline-code-review-dark.webp)

63 59

64## Staging and reverting files60## Staging and reverting files

65 61

81Git can represent both staged and unstaged changes in the same file. When that77Git can represent both staged and unstaged changes in the same file. When that

82happens, it can look like the pane is showing “the same file twice” across78happens, it can look like the pane is showing “the same file twice” across

83staged and unstaged views. That's normal Git behavior.79staged and unstaged views. That's normal Git behavior.

~~85[Previous~~

~~87Settings](https://developers.openai.com/codex/app/settings)[Next~~

~~89Automations](https://developers.openai.com/codex/app/automations)~~

app/settings.md +0 −8

Details

1# Codex app settings1# Codex app settings

2 2

~~3Configure Codex app behavior and preferences~~

5Use the settings panel to tune how the Codex app behaves, how it opens files,3Use the settings panel to tune how the Codex app behaves, how it opens files,

6and how it connects to tools. Open [**Settings**](codex://settings) from the app menu or4and how it connects to tools. Open [**Settings**](codex://settings) from the app menu or

7press <kbd>Cmd</kbd>+<kbd>,</kbd>.5press <kbd>Cmd</kbd>+<kbd>,</kbd>.

54 52

55The **Archived threads** section lists archived chats with dates and project53The **Archived threads** section lists archived chats with dates and project

56context. Use **Unarchive** to restore a thread.54context. Use **Unarchive** to restore a thread.

~~58[Previous~~

~~60Features](https://developers.openai.com/codex/app/features)[Next~~

~~62Review](https://developers.openai.com/codex/app/review)~~

app/troubleshooting.md +0 −6

Details

1# Troubleshooting1# Troubleshooting

2 2

~~3FAQ and fixes for common Codex app issues~~

5## Frequently Asked Questions3## Frequently Asked Questions

6 4

7### Files appear in the side panel that Codex didn't edit5### Files appear in the side panel that Codex didn't edit

134**Fonts aren't rendering correctly**132**Fonts aren't rendering correctly**

135 133

136Codex uses the same font for the review pane, integrated terminal and any other code displayed inside the app. You can configure the font inside the [Settings](codex://settings) pane as **Code font**.134Codex uses the same font for the review pane, integrated terminal and any other code displayed inside the app. You can configure the font inside the [Settings](codex://settings) pane as **Code font**.

~~137~~

138[Previous

~~139~~

140Commands](https://developers.openai.com/codex/app/commands)

app/worktrees.md +2 −14

Details

1# Worktrees1# Worktrees

2 2

~~3Leverage Git worktrees within the Codex app to let Codex work in parallel~~

5In the Codex app, worktrees let Codex run multiple independent tasks in the same project without interfering with each other. For Git repositories, [automations](https://developers.openai.com/codex/app/automations) run on dedicated background worktrees so they don’t conflict with your ongoing work. In non-version-controlled projects, automations run directly in the project directory. You can also start threads on a worktree manually.3In the Codex app, worktrees let Codex run multiple independent tasks in the same project without interfering with each other. For Git repositories, [automations](https://developers.openai.com/codex/app/automations) run on dedicated background worktrees so they don’t conflict with your ongoing work. In non-version-controlled projects, automations run directly in the project directory. You can also start threads on a worktree manually.

6 4

7## What's a worktree5## What's a worktree

55 53

56You can open your IDE to the worktree using the "Open" button in the header, use the integrated terminal, or anything else that you need to do from the worktree directory.54You can open your IDE to the worktree using the "Open" button in the header, use the integrated terminal, or anything else that you need to do from the worktree directory.

57 55

58![Worktree thread view with branch controls and worktree details](/images/codex/app/worktree-light.webp) ![Worktree thread view with branch controls and worktree details](/images/codex/app/worktree-dark.webp)56![Worktree thread view with branch controls and worktree details](/images/codex/app/worktree-light.webp)

60![Worktree thread view with branch controls and worktree details](/images/codex/app/worktree-light.webp) ![Worktree thread view with branch controls and worktree details](/images/codex/app/worktree-dark.webp)

61 57

62Remember, if you create a branch on a worktree, you can't check it out in any other worktree, including your local checkout.58Remember, if you create a branch on a worktree, you can't check it out in any other worktree, including your local checkout.

63 59

74- **Overwrite**: Makes the destination checkout match the source checkout’s files and commit history.70- **Overwrite**: Makes the destination checkout match the source checkout’s files and commit history.

75- **Apply**: Calculates the source changes since the nearest shared commit and applies that patch onto the destination checkout, preserving destination commit history while bringing over source code changes (not source commits).71- **Apply**: Calculates the source changes since the nearest shared commit and applies that patch onto the destination checkout, preserving destination commit history while bringing over source code changes (not source commits).

76 72

77![Sync worktree dialog with options to apply or pull changes](/images/codex/app/sync-worktree-light.webp) ![Sync worktree dialog with options to apply or pull changes](/images/codex/app/sync-worktree-dark.webp)73![Sync worktree dialog with options to apply or pull changes](/images/codex/app/sync-worktree-light.webp)

79![Sync worktree dialog with options to apply or pull changes](/images/codex/app/sync-worktree-light.webp) ![Sync worktree dialog with options to apply or pull changes](/images/codex/app/sync-worktree-dark.webp)

80 74

81You can create multiple worktrees and sync them to the same feature branch to split up your work into parallel threads.75You can create multiple worktrees and sync them to the same feature branch to split up your work into parallel threads.

82 76

151is cleaned up. However, Codex saves a snapshot of the worktree prior to145is cleaned up. However, Codex saves a snapshot of the worktree prior to

152cleaning it up and offers to restore it if you reopen the thread associated146cleaning it up and offers to restore it if you reopen the thread associated

153with it.147with it.

~~154~~

155[Previous

~~156~~

157Automations](https://developers.openai.com/codex/app/automations)[Next

~~158~~

159Local Environments](https://developers.openai.com/codex/app/local-environments)

auth.md +0 −2

Details

1# Authentication1# Authentication

2 2

~~3Sign-in methods for Codex~~

5## OpenAI authentication3## OpenAI authentication

6 4

7Codex supports two ways to sign in when using OpenAI models:5Codex supports two ways to sign in when using OpenAI models:

cli.md +0 −6

Details

1# Codex CLI1# Codex CLI

2 2

~~3Pair with Codex in your terminal~~

5Codex 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.

6It'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.

7 5

74Give Codex access to additional third-party tools and context with Model Context Protocol (MCP).](https://developers.openai.com/codex/mcp)[### Approval modes72Give Codex access to additional third-party tools and context with Model Context Protocol (MCP).](https://developers.openai.com/codex/mcp)[### Approval modes

75 73

76Choose the approval mode that matches your comfort level before Codex edits or runs commands.](https://developers.openai.com/codex/cli/features#approval-modes)74Choose the approval mode that matches your comfort level before Codex edits or runs commands.](https://developers.openai.com/codex/cli/features#approval-modes)

~~78[Next~~

~~80Features](https://developers.openai.com/codex/cli/features)~~

cli/features.md +0 −8

Details

1# Codex CLI features1# Codex CLI features

2 2

~~3Overview of functionality in the Codex terminal client~~

5Codex supports workflows beyond chat. Use this guide to learn what each one unlocks and when to use it.3Codex supports workflows beyond chat. Use this guide to learn what each one unlocks and when to use it.

6 4

7## Running in interactive mode5## Running in interactive mode

192- Launch Codex from any directory using `codex --cd <path>` to set the working root without running `cd` first. The active path appears in the TUI header.190- Launch Codex from any directory using `codex --cd <path>` to set the working root without running `cd` first. The active path appears in the TUI header.

193- Expose more writable roots with `--add-dir` (for example, `codex --cd apps/frontend --add-dir ../backend --add-dir ../shared`) when you need to coordinate changes across more than one project.191- Expose more writable roots with `--add-dir` (for example, `codex --cd apps/frontend --add-dir ../backend --add-dir ../shared`) when you need to coordinate changes across more than one project.

194- Make sure your environment is already set up before launching Codex so it doesn't spend tokens probing what to activate. For example, source your Python virtual environment (or other language environments), start any required daemons, and export the environment variables you expect to use ahead of time.192- Make sure your environment is already set up before launching Codex so it doesn't spend tokens probing what to activate. For example, source your Python virtual environment (or other language environments), start any required daemons, and export the environment variables you expect to use ahead of time.

~~195~~

196[Previous

~~197~~

198Overview](https://developers.openai.com/codex/cli)[Next

~~199~~

200Command Line Options](https://developers.openai.com/codex/cli/reference)

cli/reference.md +0 −8

Details

1# Command line options1# Command line options

2 2

~~3Options and flags for the Codex terminal client~~

5## How to read this reference3## How to read this reference

6 4

7This page catalogs every documented Codex CLI command and flag. Use the interactive tables to search by key or description. Each section indicates whether the option is stable or experimental and calls out risky combinations.5This page catalogs every documented Codex CLI command and flag. Use the interactive tables to search by key or description. Each section indicates whether the option is stable or experimental and calls out risky combinations.

1477- [Config basics](https://developers.openai.com/codex/config-basic): persist defaults like the model and provider.1475- [Config basics](https://developers.openai.com/codex/config-basic): persist defaults like the model and provider.

1478- [Advanced Config](https://developers.openai.com/codex/config-advanced): profiles, providers, sandbox tuning, and integrations.1476- [Advanced Config](https://developers.openai.com/codex/config-advanced): profiles, providers, sandbox tuning, and integrations.

1479- [AGENTS.md](https://developers.openai.com/codex/guides/agents-md): conceptual overview of Codex agent capabilities and best practices.1477- [AGENTS.md](https://developers.openai.com/codex/guides/agents-md): conceptual overview of Codex agent capabilities and best practices.

~~1480~~

1481[Previous

~~1482~~

1483Features](https://developers.openai.com/codex/cli/features)[Next

~~1484~~

1485Slash commands](https://developers.openai.com/codex/cli/slash-commands)

cli/slash-commands.md +0 −6

Details

1# Slash commands in Codex CLI1# Slash commands in Codex CLI

2 2

~~3Control Codex during interactive sessions~~

5Slash commands give you fast, keyboard-first control over Codex. Type `/` in the composer to open the slash popup, choose a command, and Codex will perform actions such as switching models, adjusting permissions, or summarizing long conversations without leaving the terminal.3Slash commands give you fast, keyboard-first control over Codex. Type `/` in the composer to open the slash popup, choose a command, and Codex will perform actions such as switching models, adjusting permissions, or summarizing long conversations without leaving the terminal.

6 4

7This guide shows you how to:5This guide shows you how to:

2321. Type `/quit` (or `/exit`) and press Enter.2301. Type `/quit` (or `/exit`) and press Enter.

233 231

234Expected: Codex exits immediately. Save or commit any important work first.232Expected: Codex exits immediately. Save or commit any important work first.

~~235~~

236[Previous

~~237~~

238Command Line Options](https://developers.openai.com/codex/cli/reference)

cloud.md +0 −6

Details

1# Codex web1# Codex web

2 2

~~3Delegate to Codex in the cloud~~

5Codex is OpenAI's coding agent that can read, edit, and run code. It helps you build faster, fix bugs, and understand unfamiliar code. With Codex cloud, Codex can work on tasks in the background (including in parallel) using its own cloud environment.3Codex is OpenAI's coding agent that can read, edit, and run code. It helps you build faster, fix bugs, and understand unfamiliar code. With Codex cloud, Codex can work on tasks in the background (including in parallel) using its own cloud environment.

6 4

7## Codex web setup5## Codex web setup

27Tag `@codex` on issues and pull requests to spin up tasks and propose changes directly from GitHub.](https://developers.openai.com/codex/integrations/github)[### Control internet access25Tag `@codex` on issues and pull requests to spin up tasks and propose changes directly from GitHub.](https://developers.openai.com/codex/integrations/github)[### Control internet access

28 26

29Decide whether Codex can reach the public internet from cloud environments, and when to enable it.](https://developers.openai.com/codex/cloud/internet-access)27Decide whether Codex can reach the public internet from cloud environments, and when to enable it.](https://developers.openai.com/codex/cloud/internet-access)

~~31[Next~~

~~33Environments](https://developers.openai.com/codex/cloud/environments)~~

cloud/environments.md +0 −8

Details

1# Cloud environments1# Cloud environments

2 2

~~3Customize dependencies and tools for Codex~~

5Use environments to control what Codex installs and runs during cloud tasks. For example, you can add dependencies, install tools like linters and formatters, and set environment variables.3Use environments to control what Codex installs and runs during cloud tasks. For example, you can add dependencies, install tools like linters and formatters, and set environment variables.

6 4

7Configure environments in [Codex settings](https://chatgpt.com/codex/settings/environments).5Configure environments in [Codex settings](https://chatgpt.com/codex/settings/environments).

83Internet access is available during the setup script phase to install dependencies. During the agent phase, internet access is off by default, but you can configure limited or unrestricted access. See [agent internet access](https://developers.openai.com/codex/cloud/internet-access).81Internet access is available during the setup script phase to install dependencies. During the agent phase, internet access is off by default, but you can configure limited or unrestricted access. See [agent internet access](https://developers.openai.com/codex/cloud/internet-access).

84 82

85Environments run behind an HTTP/HTTPS network proxy for security and abuse prevention purposes. All outbound internet traffic passes through this proxy.83Environments run behind an HTTP/HTTPS network proxy for security and abuse prevention purposes. All outbound internet traffic passes through this proxy.

~~87[Previous~~

~~89Overview](https://developers.openai.com/codex/cloud)[Next~~

~~91Internet Access](https://developers.openai.com/codex/cloud/internet-access)~~

cloud/internet-access.md +0 −6

Details

1# Agent internet access1# Agent internet access

2 2

~~3Control internet access for Codex cloud tasks~~

5By default, Codex blocks internet access during the agent phase. Setup scripts still run with internet access so you can install dependencies. You can enable agent internet access per environment when you need it.3By default, Codex blocks internet access during the agent phase. Setup scripts still run with internet access so you can install dependencies. You can enable agent internet access per environment when you need it.

6 4

7## Risks of agent internet access5## Risks of agent internet access

141visualstudio.com139visualstudio.com

142yarnpkg.com140yarnpkg.com

143```141```

~~144~~

145[Previous

~~146~~

147Environments](https://developers.openai.com/codex/cloud/environments)

codex.md +1 −5

Details

1# Codex1# Codex

2 2

~~3One agent for everywhere you code~~3![Codex app showing a project sidebar, thread list, and review pane](/images/codex/app/codex-app-basic-light.webp)

5![Codex app showing a project sidebar, thread list, and review pane](/images/codex/app/codex-app-basic-light.webp) ![Codex app showing a project sidebar, thread list, and review pane](/images/codex/app/codex-app-basic-dark.webp)

7![Codex app showing a project sidebar, thread list, and review pane](/images/codex/app/codex-app-basic-light.webp) ![Codex app showing a project sidebar, thread list, and review pane](/images/codex/app/codex-app-basic-dark.webp)

8 4

9Codex is OpenAI's coding agent for software development. ChatGPT Plus, Pro, Business, Edu, and Enterprise plans include Codex. It can help you:5Codex is OpenAI's coding agent for software development. ChatGPT Plus, Pro, Business, Edu, and Enterprise plans include Codex. It can help you:

10 6

concepts/cyber-safety.md +0 −2

Details

1# Cyber Safety1# Cyber Safety

2 2

~~3Cybersecurity safeguards and trusted access for Codex users~~

5[GPT-5.3-Codex](https://openai.com/index/introducing-gpt-5-3-codex/) is the first model we are treating as High cybersecurity capability under our [Preparedness Framework](https://cdn.openai.com/pdf/18a02b5d-6b67-4cec-ab64-68cdfbddebcd/preparedness-framework-v2.pdf), which requires additional safeguards. These safeguards include training the model to refuse clearly malicious requests like stealing credentials.3[GPT-5.3-Codex](https://openai.com/index/introducing-gpt-5-3-codex/) is the first model we are treating as High cybersecurity capability under our [Preparedness Framework](https://cdn.openai.com/pdf/18a02b5d-6b67-4cec-ab64-68cdfbddebcd/preparedness-framework-v2.pdf), which requires additional safeguards. These safeguards include training the model to refuse clearly malicious requests like stealing credentials.

6 4

7In addition to safety training, automated classifier-based monitors detect signals of suspicious cyber activity and route high-risk traffic to a less cyber-capable model (GPT-5.2). We expect a very small portion of traffic to be affected by these mitigations, and are working to refine our policies, classifiers, and in-product notifications.5In addition to safety training, automated classifier-based monitors detect signals of suspicious cyber activity and route high-risk traffic to a less cyber-capable model (GPT-5.2). We expect a very small portion of traffic to be affected by these mitigations, and are working to refine our policies, classifiers, and in-product notifications.

config-advanced.md +0 −2

Details

1# Advanced Configuration1# Advanced Configuration

2 2

~~3More advanced configuration options for Codex local clients~~

5Use these options when you need more control over providers, policies, and integrations. For a quick start, see [Config basics](https://developers.openai.com/codex/config-basic).3Use these options when you need more control over providers, policies, and integrations. For a quick start, see [Config basics](https://developers.openai.com/codex/config-basic).

6 4

7## Profiles5## Profiles

config-basic.md +0 −2

Details

1# Config basics1# Config basics

2 2

~~3Learn the basics of configuring your local Codex client~~

5Codex reads configuration details from more than one location. Your personal defaults live in `~/.codex/config.toml`, and you can add project overrides with `.codex/config.toml` files. For security, Codex loads project config files only when you trust the project.3Codex reads configuration details from more than one location. Your personal defaults live in `~/.codex/config.toml`, and you can add project overrides with `.codex/config.toml` files. For security, Codex loads project config files only when you trust the project.

6 4

7## Codex configuration file5## Codex configuration file

config-reference.md +0 −2

Details

1# Configuration Reference1# Configuration Reference

2 2

~~3Complete reference for Codex config.toml and requirements.toml~~

5Use this page as a searchable reference for Codex configuration files. For conceptual guidance and examples, start with [Config basics](https://developers.openai.com/codex/config-basic) and [Advanced Config](https://developers.openai.com/codex/config-advanced).3Use this page as a searchable reference for Codex configuration files. For conceptual guidance and examples, start with [Config basics](https://developers.openai.com/codex/config-basic) and [Advanced Config](https://developers.openai.com/codex/config-advanced).

6 4

7## `config.toml`5## `config.toml`

config-sample.md +0 −2

Details

1# Sample Configuration1# Sample Configuration

2 2

~~3A complete example config.toml you can copy and adapt~~

5Use this example configuration as a starting point. It includes most keys Codex reads from `config.toml`, along with defaults and short notes.3Use this example configuration as a starting point. It includes most keys Codex reads from `config.toml`, along with defaults and short notes.

6 4

7For explanations and guidance, see:5For explanations and guidance, see:

custom-prompts.md +0 −2

Details

1# Custom Prompts1# Custom Prompts

2 2

~~3Deprecated. Use skills for reusable prompts~~

5Custom prompts are deprecated. Use [skills](https://developers.openai.com/codex/skills) for reusable3Custom prompts are deprecated. Use [skills](https://developers.openai.com/codex/skills) for reusable

6 instructions that Codex can invoke explicitly or implicitly.4 instructions that Codex can invoke explicitly or implicitly.

7 5

enterprise/admin-setup.md +0 −2

Details

1# Admin Setup1# Admin Setup

2 2

~~3Set up Codex for your ChatGPT Enterprise workspace~~

5This guide is for ChatGPT Enterprise admins who want to set up Codex for their workspace.3This guide is for ChatGPT Enterprise admins who want to set up Codex for their workspace.

6 4

7## Enterprise-grade security and privacy5## Enterprise-grade security and privacy

enterprise/governance.md +0 −2

Details

1# Governance1# Governance

2 2

~~3Governance guidance for managing Codex in your organization~~

5# Governance and Observability3# Governance and Observability

6 4

7Codex gives enterprise teams visibility into adoption and impact, plus the auditability needed for security and compliance programs. Use the self-serve dashboard for day-to-day tracking, the Analytics API for programmatic reporting, and the Compliance API to export detailed logs into your governance stack.5Codex gives enterprise teams visibility into adoption and impact, plus the auditability needed for security and compliance programs. Use the self-serve dashboard for day-to-day tracking, the Analytics API for programmatic reporting, and the Compliance API to export detailed logs into your governance stack.

explore.md +22 −5

Details

1# Explore – Codex1# Explore – Codex

2 2

~~3Get ideas on what you can build with Codex~~

5## Get started3## Get started

6 4

7![](https://developers.openai.com/codex/colorcons/gamepad.png)Build a classic Snake game in this repo.Copied![](https://developers.openai.com/codex/colorcons/search.png)Find and fix bugs in my codebase with minimal, high-confidence changes.Copied![](https://developers.openai.com/codex/colorcons/sparkles.png)Propose and implement one high-leverage viral feature for my app.Copied![](https://developers.openai.com/codex/colorcons/tab-layout.png)Create a dashboard for ….Copied![](https://developers.openai.com/codex/colorcons/wand.png)Create an interactive prototype based on my meeting notes.Copied![](https://developers.openai.com/codex/colorcons/briefcase.png)Analyze a sales call and implement the highest-impact missing features.Copied![](https://developers.openai.com/codex/colorcons/brain.png)Explain the top failure modes of my application's architecture.Copied![](https://developers.openai.com/codex/colorcons/book.png)Write a bedtime story for a 5-year-old about my system's architecture.Copied5- Build a classic Snake game in this repo.

6- Find and fix bugs in my codebase with minimal, high-confidence changes.

7- Propose and implement one high-leverage viral feature for my app.

8- Create a dashboard for ….

9- Create an interactive prototype based on my meeting notes.

10- Analyze a sales call and implement the highest-impact missing features.

11- Explain the top failure modes of my application's architecture.

12- Write a bedtime story for a 5-year-old about my system's architecture.

8 13

9## Use skills14## Use skills

10 15

11![](https://developers.openai.com/codex/colorcons/poem.png)Create a one-page $pdf that summarizes this app.Copied![](https://developers.openai.com/codex/colorcons/design.png)Implement designs from my Figma file in this codebase using $figma-implement-design.Copied![](https://developers.openai.com/codex/colorcons/rocket.png)Deploy this project to Vercel with $vercel-deploy and a safe, minimal setup.Copied![](https://developers.openai.com/codex/colorcons/maps.png)Create a $doc with a 6-week roadmap for my app.Copied![](https://developers.openai.com/codex/colorcons/video.png)Analyze my codebase and create an investor/influencer-style ad concept for it using $sora.Copied![](https://developers.openai.com/codex/colorcons/tab-search.png)$gh-fix-ci iterate on my PR until CI is green.Copied![](https://developers.openai.com/codex/colorcons/medical.png)Monitor incoming bug reports on $sentry and attempt fixes.Copied![](https://developers.openai.com/codex/colorcons/child.png)Generate a $pdf bedtime story children's book.Copied![](https://developers.openai.com/codex/colorcons/connectors.png)Query my database and create a $spreadsheet with my top 10 customers.Copied16- Create a one-page $pdf that summarizes this app.

17- Implement designs from my Figma file in this codebase using $figma-implement-design.

18- Deploy this project to Vercel with $vercel-deploy and a safe, minimal setup.

19- Create a $doc with a 6-week roadmap for my app.

20- Analyze my codebase and create an investor/influencer-style ad concept for it using $sora.

21- $gh-fix-ci iterate on my PR until CI is green.

22- Monitor incoming bug reports on $sentry and attempt fixes.

23- Generate a $pdf bedtime story children's book.

24- Query my database and create a $spreadsheet with my top 10 customers.

12 25

13## Create automations26## Create automations

14 27

15Automate recurring tasks. Codex adds findings to the inbox and archives runs with nothing to report.28Automate recurring tasks. Codex adds findings to the inbox and archives runs with nothing to report.

16 29

17![](https://developers.openai.com/codex/colorcons/calendar.png)Scan recent commits for likely bugs and propose minimal fixes.Copied![](https://developers.openai.com/codex/colorcons/book.png)Draft release notes from merged PRs.Copied![](https://developers.openai.com/codex/colorcons/chat.png)Summarize yesterday’s git activity for standup.Copied![](https://developers.openai.com/codex/colorcons/trends.png)Summarize CI failures and flaky tests.Copied![](https://developers.openai.com/codex/colorcons/trophy.png)Create a small classic game with minimal scope.Copied30- Scan recent commits for likely bugs and propose minimal fixes.

31- Draft release notes from merged PRs.

32- Summarize yesterday’s git activity for standup.

33- Summarize CI failures and flaky tests.

34- Create a small classic game with minimal scope.

Details

1# Codex IDE extension1# Codex IDE extension

2 2

~~3Pair with Codex in your IDE~~

5Codex is OpenAI's coding agent that can read, edit, and run code. It helps you build faster, squash bugs, and understand unfamiliar code. With the Codex VS Code extension, you can use Codex side by side in your IDE or delegate tasks to Codex Cloud.3Codex is OpenAI's coding agent that can read, edit, and run code. It helps you build faster, squash bugs, and understand unfamiliar code. With the Codex VS Code extension, you can use Codex side by side in your IDE or delegate tasks to Codex Cloud.

6 4

90Use slash commands to control how Codex behaves and quickly change common settings from chat.](https://developers.openai.com/codex/ide/slash-commands)[### Extension settings88Use slash commands to control how Codex behaves and quickly change common settings from chat.](https://developers.openai.com/codex/ide/slash-commands)[### Extension settings

91 89

92Tune Codex to your workflow with editor settings for models, approvals, and other defaults.](https://developers.openai.com/codex/ide/settings)90Tune Codex to your workflow with editor settings for models, approvals, and other defaults.](https://developers.openai.com/codex/ide/settings)

~~94[Next~~

~~96Features](https://developers.openai.com/codex/ide/features)~~

ide/commands.md +0 −8

Details

1# Codex IDE extension commands1# Codex IDE extension commands

2 2

~~3Reference for Codex IDE extension commands and keyboard shortcuts~~

5Use these commands to control Codex from the VS Code Command Palette. You can also bind them to keyboard shortcuts.3Use these commands to control Codex from the VS Code Command Palette. You can also bind them to keyboard shortcuts.

6 4

7## Assign a key binding5## Assign a key binding

23| `chatgpt.implementTodo` | - | Ask Codex to address the selected TODO comment |21| `chatgpt.implementTodo` | - | Ask Codex to address the selected TODO comment |

24| `chatgpt.newCodexPanel` | - | Create a new Codex panel |22| `chatgpt.newCodexPanel` | - | Create a new Codex panel |

25| `chatgpt.openSidebar` | - | Opens the Codex sidebar panel |23| `chatgpt.openSidebar` | - | Opens the Codex sidebar panel |

~~27[Previous~~

~~29Settings](https://developers.openai.com/codex/ide/settings)[Next~~

~~31Slash commands](https://developers.openai.com/codex/ide/slash-commands)~~

ide/features.md +0 −8

Details

1# Codex IDE extension features1# Codex IDE extension features

2 2

~~3What you can do with the Codex IDE extension~~

5The Codex IDE extension gives you access to Codex directly in VS Code, Cursor, Windsurf, and other VS Code-compatible editors. It uses the same agent as the Codex CLI and shares the same configuration.3The Codex IDE extension gives you access to Codex directly in VS Code, Cursor, Windsurf, and other VS Code-compatible editors. It uses the same agent as the Codex CLI and shares the same configuration.

6 4

7## Prompting Codex5## Prompting Codex

72## See also70## See also

73 71

74- [Codex IDE extension settings](https://developers.openai.com/codex/ide/settings)72- [Codex IDE extension settings](https://developers.openai.com/codex/ide/settings)

~~76[Previous~~

~~78Overview](https://developers.openai.com/codex/ide)[Next~~

~~80Settings](https://developers.openai.com/codex/ide/settings)~~

ide/settings.md +0 −8

Details

1# Codex IDE extension settings1# Codex IDE extension settings

2 2

~~3Reference for Codex IDE extension settings~~

5Use these settings to customize the Codex IDE extension.3Use these settings to customize the Codex IDE extension.

6 4

7## Change a setting5## Change a setting

25| `chatgpt.runCodexInWindowsSubsystemForLinux` | Windows only: Run Codex in WSL when Windows Subsystem for Linux (WSL) is available. Recommended for improved sandbox security and better performance. Codex agent mode on Windows currently requires WSL. Changing this setting reloads VS Code to apply the change. |23| `chatgpt.runCodexInWindowsSubsystemForLinux` | Windows only: Run Codex in WSL when Windows Subsystem for Linux (WSL) is available. Recommended for improved sandbox security and better performance. Codex agent mode on Windows currently requires WSL. Changing this setting reloads VS Code to apply the change. |

~~27[Previous~~

~~29Features](https://developers.openai.com/codex/ide/features)[Next~~

~~31IDE Commands](https://developers.openai.com/codex/ide/commands)~~

ide/slash-commands.md +0 −6

Details

1# Codex IDE extension slash commands1# Codex IDE extension slash commands

2 2

~~3Reference for slash commands in the Codex IDE extension~~

5Slash commands let you control Codex without leaving the chat input. Use them to check status, switch between local and cloud mode, or send feedback.3Slash commands let you control Codex without leaving the chat input. Use them to check status, switch between local and cloud mode, or send feedback.

6 4

7## Use a slash command5## Use a slash command

21| `/local` | Switch to local mode to run the task in your workspace. |19| `/local` | Switch to local mode to run the task in your workspace. |

22| `/review` | Start code review mode to review uncommitted changes or compare against a base branch. |20| `/review` | Start code review mode to review uncommitted changes or compare against a base branch. |

23| `/status` | Show the thread ID, context usage, and rate limits. |21| `/status` | Show the thread ID, context usage, and rate limits. |

~~25[Previous~~

~~27IDE Commands](https://developers.openai.com/codex/ide/commands)~~

integrations/github.md +0 −2

Details

1# Use Codex in GitHub1# Use Codex in GitHub

2 2

~~3Run Codex code review in pull requests~~

5Use Codex to review pull requests without leaving GitHub. Add a pull request comment with `@codex review`, and Codex replies with a standard GitHub code review.3Use Codex to review pull requests without leaving GitHub. Add a pull request comment with `@codex review`, and Codex replies with a standard GitHub code review.

6 4

7## Set up code review5## Set up code review

integrations/linear.md +3 −5

Details

1# Use Codex in Linear1# Use Codex in Linear

2 2

~~3Run Codex tasks from Linear issues~~

5Use Codex in Linear to delegate work from issues. Assign an issue to Codex or mention `@Codex` in a comment, and Codex creates a cloud task and replies with progress and results.3Use Codex in Linear to delegate work from issues. Assign an issue to Codex or mention `@Codex` in a comment, and Codex creates a cloud task and replies with progress and results.

6 4

7Codex in Linear is available on paid plans (see [Pricing](https://developers.openai.com/codex/pricing)).5Codex in Linear is available on paid plans (see [Pricing](https://developers.openai.com/codex/pricing)).

22 20

23After you install the integration, you can assign issues to Codex the same way you assign them to teammates. Codex starts work and posts updates back to the issue.21After you install the integration, you can assign issues to Codex the same way you assign them to teammates. Codex starts work and posts updates back to the issue.

24 22

25![Assigning Codex to a Linear issue (light mode)](/images/codex/integrations/linear-assign-codex-light.webp)![Assigning Codex to a Linear issue (dark mode)](/images/codex/integrations/linear-assign-codex-dark.webp)23![Assigning Codex to a Linear issue (light mode)](/images/codex/integrations/linear-assign-codex-light.webp)

26 24

27### Mention `@Codex` in comments25### Mention `@Codex` in comments

28 26

29You can also mention `@Codex` in comment threads to delegate work or ask questions. After Codex replies, follow up in the thread to continue the same session.27You can also mention `@Codex` in comment threads to delegate work or ask questions. After Codex replies, follow up in the thread to continue the same session.

30 28

31![Mentioning Codex in a Linear issue comment (light mode)](/images/codex/integrations/linear-comment-light.webp)![Mentioning Codex in a Linear issue comment (dark mode)](/images/codex/integrations/linear-comment-dark.webp)29![Mentioning Codex in a Linear issue comment (light mode)](/images/codex/integrations/linear-comment-light.webp)

32 30

33After Codex starts working on an issue, it [chooses an environment and repo](#how-codex-chooses-an-environment-and-repo) to work in.31After Codex starts working on an issue, it [chooses an environment and repo](#how-codex-chooses-an-environment-and-repo) to work in.

34To pin a specific repo, include it in your comment, for example: `@Codex fix this in openai/codex`.32To pin a specific repo, include it in your comment, for example: `@Codex fix this in openai/codex`.

58Linear assigns new issues that enter triage to Codex automatically.56Linear assigns new issues that enter triage to Codex automatically.

59When you use triage rules, Codex runs tasks using the account of the issue creator.57When you use triage rules, Codex runs tasks using the account of the issue creator.

60 58

61![Screenshot of an example triage rule assigning everything to Codex and labeling it in the "Triage" status (light mode)](/images/codex/integrations/linear-triage-rule-light.webp)![Screenshot of an example triage rule assigning everything to Codex and labeling it in the "Triage" status (dark mode)](/images/codex/integrations/linear-triage-rule-dark.webp)59![Screenshot of an example triage rule assigning everything to Codex and labeling it in the "Triage" status (light mode)](/images/codex/integrations/linear-triage-rule-light.webp)

62 60

63## Data usage, privacy, and security61## Data usage, privacy, and security

64 62

integrations/slack.md +0 −2

Details

1# Use Codex in Slack1# Use Codex in Slack

2 2

~~3Ask Codex to run tasks from channels and threads~~

5Use Codex in Slack to kick off coding tasks from channels and threads. Mention `@Codex` with a prompt, and Codex creates a cloud task and replies with the results.3Use Codex in Slack to kick off coding tasks from channels and threads. Mention `@Codex` with a prompt, and Codex creates a cloud task and replies with the results.

6 4

7![Codex Slack integration in action](/images/codex/integrations/slack-example.png)5![Codex Slack integration in action](/images/codex/integrations/slack-example.png)

mcp.md +0 −2

Details

1# Model Context Protocol1# Model Context Protocol

2 2

~~3Give Codex access to third-party tools and context~~

5Model Context Protocol (MCP) connects models to tools and context. Use it to give Codex access to third-party documentation, or to let it interact with developer tools like your browser or Figma.3Model Context Protocol (MCP) connects models to tools and context. Use it to give Codex access to third-party documentation, or to let it interact with developer tools like your browser or Figma.

6 4

7Codex supports MCP servers in both the CLI and the IDE extension.5Codex supports MCP servers in both the CLI and the IDE extension.

models.md +0 −2

Details

1# Codex Models1# Codex Models

2 2

~~3Meet the AI models that power Codex~~

5## Recommended models3## Recommended models

6 4

7![gpt-5.3-codex](/images/codex/codex-wallpaper-1.webp)5![gpt-5.3-codex](/images/codex/codex-wallpaper-1.webp)

multi-agent.md +0 −2

Details

1# Multi-agents1# Multi-agents

2 2

~~3Use experimental multi-agent collaboration in Codex CLI~~

5Codex can run multi-agent workflows by spawning specialized agents in parallel and then collecting their results in one response. This can be particularly helpful for complex tasks that are highly parallel, such as codebase exploration or implementing a multi-step feature plan.3Codex can run multi-agent workflows by spawning specialized agents in parallel and then collecting their results in one response. This can be particularly helpful for complex tasks that are highly parallel, such as codebase exploration or implementing a multi-step feature plan.

6 4

7With multi-agent workflows you can also define your own set of agents with different model configurations and instructions depending on the agent.5With multi-agent workflows you can also define your own set of agents with different model configurations and instructions depending on the agent.

noninteractive.md +0 −2

Details

1# Non-interactive mode1# Non-interactive mode

2 2

~~3Use `codex exec` to run Codex in scripts and CI~~

5Non-interactive mode lets you run Codex from scripts (for example, continuous integration (CI) jobs) without opening the interactive TUI.3Non-interactive mode lets you run Codex from scripts (for example, continuous integration (CI) jobs) without opening the interactive TUI.

6You invoke it with `codex exec`.4You invoke it with `codex exec`.

7 5

open-source.md +0 −2

Details

1# Open Source1# Open Source

2 2

~~3Open-source components of Codex and where to collaborate~~

5OpenAI develops key parts of Codex in the open. That work lives on GitHub so you can follow progress, report issues, and contribute improvements.3OpenAI develops key parts of Codex in the open. That work lives on GitHub so you can follow progress, report issues, and contribute improvements.

6 4

7## Open-source components5## Open-source components

overview.md +1 −5

Details

1# Codex1# Codex

2 2

~~3One agent for everywhere you code~~3![Codex app showing a project sidebar, thread list, and review pane](/images/codex/app/codex-app-basic-light.webp)

8 4

9Codex is OpenAI’s coding agent for software development. ChatGPT Plus, Pro, Business, Edu, and Enterprise plans include Codex. It can help you:5Codex is OpenAI’s coding agent for software development. ChatGPT Plus, Pro, Business, Edu, and Enterprise plans include Codex. It can help you:

10 6

prompting.md +0 −2

Details

1# Prompting1# Prompting

2 2

~~3Interacting with the Codex agent~~

5## Prompts3## Prompts

6 4

7You interact with Codex by sending prompts (user messages) that describe what you want it to do.5You interact with Codex by sending prompts (user messages) that describe what you want it to do.

quickstart.md +12 −10

Details

1# Quickstart1# Quickstart

2 2

~~3Start using Codex in your IDE, CLI, or the cloud~~

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~~

~~17AppRecommended (macOS only)IDE extensionCodex in your IDECLICodex in your terminalCloudCodex in your browser~~

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

45 ![](https://developers.openai.com/codex/colorcons/brain.png)Tell me about this projectCopied![](https://developers.openai.com/codex/colorcons/gamepad.png)Build a classic Snake game in this repo.Copied![](https://developers.openai.com/codex/colorcons/search.png)Find and fix bugs in my codebase with minimal, high-confidence changes.Copied39- 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

70 ![](https://developers.openai.com/codex/colorcons/brain.png)Tell me about this projectCopied![](https://developers.openai.com/codex/colorcons/gamepad.png)Build a classic Snake game in this repo.Copied![](https://developers.openai.com/codex/colorcons/search.png)Find and fix bugs in my codebase with minimal, high-confidence changes.Copied66- 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

99 ![](https://developers.openai.com/codex/colorcons/brain.png)Tell me about this projectCopied![](https://developers.openai.com/codex/colorcons/gamepad.png)Build a classic Snake game in this repo.Copied![](https://developers.openai.com/codex/colorcons/search.png)Find and fix bugs in my codebase with minimal, high-confidence changes.Copied97- 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

118 ![](https://developers.openai.com/codex/colorcons/brain.png)Tell me about this projectCopied![](https://developers.openai.com/codex/colorcons/brain.png)Explain the top failure modes of my application's architecture.Copied![](https://developers.openai.com/codex/colorcons/search.png)Find and fix bugs in my codebase with minimal, high-confidence changes.Copied118- 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.

rules.md +0 −2

Details

1# Rules1# Rules

2 2

~~3Control which commands Codex can run outside the sandbox~~

5Use rules to control which commands Codex can run outside the sandbox.3Use rules to control which commands Codex can run outside the sandbox.

6 4

7Rules are experimental and may change.5Rules are experimental and may change.

sdk.md +0 −2

Details

1# Codex SDK1# Codex SDK

2 2

~~3Programmatically control local Codex agents~~

5If you use Codex through the Codex CLI, the IDE extension, or Codex Web, you can also control it programmatically.3If you use Codex through the Codex CLI, the IDE extension, or Codex Web, you can also control it programmatically.

6 4

7Use the SDK when you need to:5Use the SDK when you need to:

security.md +0 −2

Details

1# Codex Security1# Codex Security

2 2

~~3How to securely operate and manage Codex agents~~

5Codex helps protect your code and data and reduces the risk of misuse.3Codex helps protect your code and data and reduces the risk of misuse.

6 4

7By default, the agent runs with network access turned off. Locally, Codex uses an OS-enforced sandbox that limits what it can touch (typically to the current workspace), plus an approval policy that controls when it must stop and ask you before acting.5By default, the agent runs with network access turned off. Locally, Codex uses an OS-enforced sandbox that limits what it can touch (typically to the current workspace), plus an approval policy that controls when it must stop and ask you before acting.

skills.md +0 −2

Details

1# Agent Skills1# Agent Skills

2 2

~~3Give Codex new capabilities and expertise~~

5Use agent skills to extend Codex with task-specific capabilities. A skill packages instructions, resources, and optional scripts so Codex can follow a workflow reliably. You can share skills across teams or with the community. Skills build on the [open agent skills standard](https://agentskills.io).3Use agent skills to extend Codex with task-specific capabilities. A skill packages instructions, resources, and optional scripts so Codex can follow a workflow reliably. You can share skills across teams or with the community. Skills build on the [open agent skills standard](https://agentskills.io).

6 4

7Skills are available in the Codex CLI, IDE extension, and Codex app.5Skills are available in the Codex CLI, IDE extension, and Codex app.

videos.md +0 −2

Details

1# Videos1# Videos

~~3Learn how to use Codex with demos, walkthroughs, and talks~~

windows.md +0 −2

Details

1# Windows1# Windows

2 2

~~3Tips for running Codex on Windows~~

5The easiest way to use Codex on Windows is to [set up the IDE extension](https://developers.openai.com/codex/ide) or [install the CLI](https://developers.openai.com/codex/cli) and run it from PowerShell.3The easiest way to use Codex on Windows is to [set up the IDE extension](https://developers.openai.com/codex/ide) or [install the CLI](https://developers.openai.com/codex/cli) and run it from PowerShell.

6 4

7When you run Codex natively on Windows, the agent mode uses an experimental Windows sandbox to block filesystem writes outside the working folder and prevent network access without your explicit approval. [Learn more below](#windows-experimental-sandbox).5When you run Codex natively on Windows, the agent mode uses an experimental Windows sandbox to block filesystem writes outside the working folder and prevent network access without your explicit approval. [Learn more below](#windows-experimental-sandbox).

workflows.md +0 −2

Details

1# Workflows1# Workflows

2 2

~~3Development usage patterns with Codex~~

5Codex works best when you treat it like a teammate with explicit context and a clear definition of "done."3Codex works best when you treat it like a teammate with explicit context and a clear definition of "done."

6This page gives end-to-end workflow examples for the Codex IDE extension, the Codex CLI, and Codex cloud.4This page gives end-to-end workflow examples for the Codex IDE extension, the Codex CLI, and Codex cloud.

7 5

OpenAI - Codex Docs Changes 2026-02-19 20:37 UTC → 2026-02-19 20:53 UTC