app/commands.md +113 −11
56more input. To define the goal with Codex first, start with `/plan`, then set56more input. To define the goal with Codex first, start with `/plan`, then set
57the refined goal with `/goal`.57the refined goal with `/goal`.
58 58
59If `/goal` doesn’t appear in the slash command list, enable `features.goals`
60in `config.toml`:
61
62```
63[features]
64goals = true
65```
66
67You can also run `codex features enable goals` from the CLI or ask Codex to run it.
68
5969
60 70
61When a goal is active, the app shows its progress above the composer. Use the71When a goal is active, the app shows its progress above the composer. Use the
65 75
66For guidance on writing effective goals, see [Goal mode](https://developers.openai.com/codex/prompting#goal-mode).76For guidance on writing effective goals, see [Goal mode](https://developers.openai.com/codex/prompting#goal-mode).
67 77
6878## Deeplinks## Deep links
69 79
70The Codex app registers the `codex://` URL scheme so links can open specific parts of the app directly.80The Codex app registers the `codex://` URL scheme so links can open specific parts of the app directly.
71 81
7282| Deeplink | Opens | Supported query parameters |### Common links
83
84Use these links when you just need to open a common app destination. The sections below list the full reference by link type.
85
86| Deep link | Opens |
87| --- | --- |
88| `codex://threads/new` | A new local thread. |
89| `codex://threads/<thread-id>` | A local thread. `<thread-id>` must be the thread’s session UUID. |
90| `codex://settings` | Settings. |
91| `codex://skills` | Skills. |
92| `codex://automations` | Automations with the create flow open. |
93
94### Threads
95
96Use these links when you need to open an existing local thread or start a new one.
97
98| Deep link | Opens |
99| --- | --- |
100| `codex://threads/<thread-id>` | A local thread. `<thread-id>` must be the thread’s session UUID. |
101| `codex://threads/new` | A new local thread. |
102
103For `codex://threads/new`, add any of these query parameters as needed; you can combine them in the same URL.
104
105| Query parameter | Required | What it does |
73| --- | --- | --- |106| --- | --- | --- |
74107| `codex://settings` | Settings. | None. || `prompt=<text>` | No | Sets the initial composer text. |
75108| `codex://skills` | Skills. | None. || `path=<absolute-path>` | No | Opens the new thread in a local workspace. `path` must be an absolute path to a local directory. When valid, Codex uses that directory as the active workspace. |
76109| `codex://automations` | Inbox in automation create mode. | None. || `originUrl=<git-remote-url>` | No | Matches one of your current workspace roots by Git remote URL. If `path` is also present, Codex resolves `path` first. |
77| `codex://threads/<thread-id>` | A local thread. `<thread-id>` must be a UUID. | None. |
78| `codex://new` | A new thread. | Optional: `prompt`, `originUrl`, `path`. |
79 110
80111For new-thread deeplinks:Example: [Show me some fun stats about how I’ve been using Codex](codex://threads/new?prompt=Show%20me%20some%20fun%20stats%20about%20how%20I%27ve%20been%20using%20Codex)
81 112
82113- `prompt` sets the initial composer text.### Settings
83114- `path` must be an absolute path to a local directory and, when valid, makes that directory the active workspace for the new thread.
84115- `originUrl` tries to match one of your current workspace roots by Git remote URL. If both `path` and `originUrl` are present, Codex resolves `path` first.Use these links when you need to open Settings or a specific settings page.
116
117| Deep link | Opens |
118| --- | --- |
119| `codex://settings` | Settings. |
120| `codex://settings/browser-use` | Browser use settings. |
121| `codex://settings/computer-use/google-chrome` | Google Chrome settings for computer use. |
122| `codex://settings/connections` | Remote connections settings. |
123
124### Skills
125
126Use these links when you need to open Skills.
127
128| Deep link | Opens |
129| --- | --- |
130| `codex://skills` | Skills. |
131
132### Automations
133
134Use these links when you need to open Automations.
135
136| Deep link | Opens |
137| --- | --- |
138| `codex://automations` | Automations with the create flow open. |
139
140### Plugins
141
142Plugin 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).
143
144#### Plugin detail
145
146| Deep link | Opens |
147| --- | --- |
148| `codex://plugins/<plugin-id>` | A plugin detail page. |
149
150`<plugin-id>` must identify the plugin. For an OpenAI-curated plugin, use the form `<plugin-name>@openai-curated`.
151
152Codex-generated plugin links can also include these query parameters. Omit both when you handwrite a link.
153
154| Query parameter | Required | What it does |
155| --- | --- | --- |
156| `hostId=<host-id>` | No | Identifies the Codex host that owns the plugin context, such as `local` or one of your configured remote connections. Codex provides these IDs. |
157| `source=manage` | No | Preserves the app’s plugin-management entry point. It is not admin-only. |
158
159Example: [Open the OpenAI Developers plugin](codex://plugins/openai-developers@openai-curated)
160
161#### Local plugin
162
163For local or repo marketplace setup, see [Build plugins](https://developers.openai.com/codex/plugins/build#build-your-own-curated-plugin-list).
164
165| Deep link | Opens |
166| --- | --- |
167| `codex://plugins/<plugin-name>?marketplacePath=<absolute-marketplace-path>` | A local plugin detail page from a local marketplace. |
168
169| Query parameter | Required | What it does |
170| --- | --- | --- |
171| `marketplacePath=<absolute-marketplace-path>` | Yes | Absolute path to the local `marketplace.json`, for example `/Users/alex/.agents/plugins/marketplace.json`. |
172| `mode=share` | No | Opens the share flow for that local plugin. |
173
174### Pets
175
176Use these links to open the pet install flow when that feature is enabled.
177
178| Deep link | Opens |
179| --- | --- |
180| `codex://pets/install?name=<pet-name>&imageUrl=<https-image-url>` | The pet install flow. |
181
182| Query parameter | Required | What it does |
183| --- | --- | --- |
184| `name=<pet-name>` | Yes | Sets the pet name. |
185| `imageUrl=<https-image-url>` | Yes | Sets the pet image URL. `imageUrl` must be HTTPS. |
186| `description=<text>` | No | Sets the optional pet description. |
85 187
86## See also188## See also
87 189