Documentation 2026-06-09 18:50 UTC to 2026-06-10 07:38 UTC

94 94 

95## Deep links95## Deep links

96 96 

97The Codex app registers the `codex://` URL scheme so links can open specific parts of the app directly.97The Codex app registers the `codex://` URL scheme so links can open specific parts of the app directly. Encode query string values before adding them to a URL.

98 98 

99### Common links99### Supported links

100 100 

101Use these links when you just need to open a common app destination. The sections below list the full reference by link type.101Use these canonical forms when you create links. The sections below list the full reference by link type.

102 102 

103| Deep link | Opens |103| Deep link | Opens |

104| --- | --- |104| --- | --- |

105| `codex://threads/new` | A new local thread. |105| `codex://threads/new` | A new local thread. |

106| `codex://new?<query>` | A new local thread with at least one new-thread query parameter. |

106| `codex://threads/<thread-id>` | A local thread. `<thread-id>` must be the thread’s session UUID. |107| `codex://threads/<thread-id>` | A local thread. `<thread-id>` must be the thread’s session UUID. |

107| `codex://settings` | Settings. |108| `codex://settings` | Settings. |

108| `codex://skills` | Skills. |109| `codex://skills` | Skills. |

109| `codex://automations` | Automations with the create flow open. |110| `codex://automations` | Automations with the create flow open. |

111| `codex://plugins/install/<plugin-name>?marketplace=<marketplace-name>` | The install flow for a plugin from a known marketplace. |

112| `codex://plugins/<plugin-id>` | A plugin detail page. |

113| `codex://plugins/<plugin-name>?marketplacePath=<absolute-marketplace-path>` | A local plugin detail page from a local marketplace. |

114| `codex://pets/install?name=<pet-name>&imageUrl=<https-image-url>` | The pet install flow. |

110 115 

111### Threads116### Threads

112 117 

116| --- | --- |121| --- | --- |

117| `codex://threads/<thread-id>` | A local thread. `<thread-id>` must be the thread’s session UUID. |122| `codex://threads/<thread-id>` | A local thread. `<thread-id>` must be the thread’s session UUID. |

118| `codex://threads/new` | A new local thread. |123| `codex://threads/new` | A new local thread. |

124| `codex://threads/new?<query>` | A new local thread with optional query parameters. |

125| `codex://new?<query>` | A new local thread. Include at least one of `prompt`, `path`, or `originUrl`; otherwise the link does nothing. |

119 126 

120For `codex://threads/new`, add any of these query parameters as needed; you can combine them in the same URL.127For `codex://threads/new` or `codex://new`, add any of these query parameters as needed; you can combine them in the same URL.

121 128 

122| Query parameter | Required | What it does |129| Query parameter | Required | What it does |

123| --- | --- | --- |130| --- | --- | --- |

138| `codex://settings/computer-use/google-chrome` | Google Chrome settings for computer use. |145| `codex://settings/computer-use/google-chrome` | Google Chrome settings for computer use. |

139| `codex://settings/connections` | Remote connections settings. |146| `codex://settings/connections` | Remote connections settings. |

140 147 

148Unsupported `codex://settings/...` paths open the main Settings page.

149 

141### Skills150### Skills

142 151 

143Use these links when you need to open Skills.152Use these links when you need to open Skills.

156 165 

157### Plugins166### Plugins

158 167 

159Plugin links use different forms depending on whether you are opening a plugin, installing from a marketplace, or working from a local `marketplace.json`. For plugin basics, see [Plugins](https://developers.openai.com/codex/plugins). For local or repo marketplace setup, see [Build plugins](https://developers.openai.com/codex/plugins/build#build-your-own-curated-plugin-list).168Plugin links use different forms depending on whether you are installing from a marketplace, opening a plugin, or working from a local `marketplace.json`. For plugin basics, see [Plugins](https://developers.openai.com/codex/plugins). For local or repo marketplace setup, see [Build plugins](https://developers.openai.com/codex/plugins/build#build-your-own-curated-plugin-list).

169 

170#### Plugin install

171 

172Use this form to open the install flow for a plugin from a marketplace that Codex already knows about.

173 

174| Deep link | Opens |

175| --- | --- |

176| `codex://plugins/install/<plugin-name>?marketplace=<marketplace-name>` | The plugin detail or install flow for a plugin. |

177 

178| Query parameter | Required | What it does |

179| --- | --- | --- |

180| `marketplace=<marketplace-name>` | Yes | Identifies the marketplace. For an OpenAI-curated plugin, use `openai-curated`. |

181 

182The install link accepts only the `marketplace` query parameter. If Codex cannot find the requested marketplace or plugin, it opens the Plugins page instead.

160 183 

161#### Plugin detail184#### Plugin detail

162 185 

64 64 

65Run `codex` to start an interactive terminal UI (TUI) session.](https://developers.openai.com/codex/cli/features#running-in-interactive-mode)[### Control model and reasoning65Run `codex` to start an interactive terminal UI (TUI) session.](https://developers.openai.com/codex/cli/features#running-in-interactive-mode)[### Control model and reasoning

66 66 

67Use `/model` to switch between GPT-5.4, GPT-5.3-Codex, and other available models, or adjust reasoning levels.](https://developers.openai.com/codex/cli/features#models-reasoning)[### Image inputs67Use `/model` to switch between GPT-5.4, GPT-5.3-Codex, and other available models, or adjust reasoning levels.](https://developers.openai.com/codex/cli/features#models-and-reasoning)[### Image inputs

68 68 

69Attach screenshots or design specs so Codex reads them alongside your prompt.](https://developers.openai.com/codex/cli/features#image-inputs)[### Image generation69Attach screenshots or design specs so Codex reads them alongside your prompt.](https://developers.openai.com/codex/cli/features#image-inputs)[### Image generation

70 70 

84allowed_sandbox_modes = ["read-only", "workspace-write"]84allowed_sandbox_modes = ["read-only", "workspace-write"]

85```85```

86 86 

87### Disable AppShots

88 

89To disable AppShots for managed users, set the top-level `allow_appshots` requirement:

90 

91```

92allow_appshots = false

93```

94 

95Codex treats only `allow_appshots = false` as disabling AppShots. If the key is omitted, AppShots remains unconstrained by requirements and uses normal product availability checks. App-server clients that read effective requirements through `configRequirements/read` receive the same restriction as `allowAppshots`; an omitted or `null` `allowAppshots` value does not disable AppShots.

96 

87### Control available permission profiles97### Control available permission profiles

88 98 

89Use `allowed_permission_profiles` to control which built-in and custom99Use `allowed_permission_profiles` to control which built-in and custom

43 43 

44Installed plugins can also bundle lifecycle config through their plugin44Installed plugins can also bundle lifecycle config through their plugin

45manifest or a default `hooks/hooks.json` file. See [Build45manifest or a default `hooks/hooks.json` file. See [Build

46plugins](https://developers.openai.com/codex/plugins/build#bundled-mcp-servers-and-lifecycle-config) for the46plugins](https://developers.openai.com/codex/plugins/build#bundled-mcp-servers-and-lifecycle-hooks) for the

47plugin packaging rules.47plugin packaging rules.

48 48 

49In practice, the four most useful locations are:49In practice, the four most useful locations are:

27can limit edits to selected workspace roots.27can limit edits to selected workspace roots.

28 28 

29Local permission profiles are supported on macOS, Linux, WSL, and native29Local permission profiles are supported on macOS, Linux, WSL, and native

30Windows. Platform-specific enforcement details and caveats are covered in30Windows. See [Scope and enforcement](#scope-and-enforcement) for platform-specific

31[Security limitations](#security-limitations).31details and caveats.

32 32 

33For Codex cloud network settings, see [Internet Access](https://developers.openai.com/codex/cloud/internet-access).33For Codex cloud network settings, see [Internet Access](https://developers.openai.com/codex/cloud/internet-access).

34 34 

38 38 

39Related links39Related links

40 40 

41[`/goal` in CLI slash commands](https://developers.openai.com/codex/cli/slash-commands#set-a-goal-with-goal) [Codex workflows](https://developers.openai.com/codex/workflows) [Run code migrations](https://developers.openai.com/codex/use-cases/code-migrations) [Iterate on difficult problems](https://developers.openai.com/codex/use-cases/iterate-on-difficult-problems)41[`/goal` in CLI slash commands](https://developers.openai.com/codex/cli/slash-commands#set-or-view-a-task-goal-with-goal) [Codex workflows](https://developers.openai.com/codex/workflows) [Run code migrations](https://developers.openai.com/codex/use-cases/code-migrations) [Iterate on difficult problems](https://developers.openai.com/codex/use-cases/iterate-on-difficult-problems)

42 42 

43## Best for43## Best for

44 44 

85 85 

86This works best as a tight loop: one visual note, one focused edit, one browser check, then the next note.86This works best as a tight loop: one visual note, one focused edit, one browser check, then the next note.

87 87 

88You can use the [Codex Spark model](https://developers.openai.com/codex/models#gpt-53-codex-spark) for this88You can use the [Codex Spark model](https://developers.openai.com/codex/models) for this task. It is

89task. It is available on Pro plans.89available on Pro plans.

90 90 

91## Pick your model91## Pick your model

92 92 

111## Move from mock to prototype111## Move from mock to prototype

112 112 

113Use the final mock image that you want Codex to implement. Re-attach this image in a new turn rather than continuing the conversation directly.113Use the final mock image that you want Codex to implement. Re-attach this image in a new turn rather than continuing the conversation directly.

114You can then ask Codex to implement the mock – optionally using the [Build Web Apps plugin](https://developers.openai.com/codex/plugins/build-web-apps) if you’re building a web app – to turn it into a working prototype:114You can then ask Codex to implement the mock – optionally using the [Build Web Apps plugin](https://github.com/openai/plugins/tree/main/plugins/build-web-apps) if you’re building a web app – to turn it into a working prototype:

115 115 

116Use this image as a reference and implement in this repository this feature. Use this conversation as context to help you implement it with the right constraints. Minimize the creation of new components: explore the codebase and reuse existing components and design system when possible.116Use this image as a reference and implement in this repository this feature. Use this conversation as context to help you implement it with the right constraints. Minimize the creation of new components: explore the codebase and reuse existing components and design system when possible.

117 117 

103 103 

104## Require proof to verify the result104## Require proof to verify the result

105 105 

106A useful operations run includes an artifact that you or a teammate can inspect, such as a result CSV, a log file, a dashboard link, a screenshot, a PR check, or any other proof that the operation was successful. When using the Codex app, you can inspect this [artifact](https://developers.openai.com/codex/app/artifacts) directly in the artifact viewer after the run to verify the result.106A useful operations run includes an artifact that you or a teammate can inspect, such as a result CSV, a log file, a dashboard link, a screenshot, a PR check, or any other proof that the operation was successful. When using the Codex app, you can inspect this [artifact](https://developers.openai.com/codex/app/features#artifact-viewer) directly in the artifact viewer after the run to verify the result.

107 107 

108## Turn the run into a reusable workflow108## Turn the run into a reusable workflow

109 109