config-basic.md +28 −20
11The CLI and IDE extension share the same configuration layers. You can use them to:11The CLI and IDE extension share the same configuration layers. You can use them to:
12 12
13- Set the default model and provider.13- Set the default model and provider.
1414- Configure [approval policies and sandbox settings](https://developers.openai.com/codex/security).- Configure [approval policies and sandbox settings](https://developers.openai.com/codex/agent-approvals-security#sandbox-and-approvals).
15- Configure [MCP servers](https://developers.openai.com/codex/mcp).15- Configure [MCP servers](https://developers.openai.com/codex/mcp).
16 16
17## Configuration precedence17## Configuration precedence
33 33
34On managed machines, your organization may also enforce constraints via34On managed machines, your organization may also enforce constraints via
35 `requirements.toml` (for example, disallowing `approval_policy = "never"` or35 `requirements.toml` (for example, disallowing `approval_policy = "never"` or
3636`sandbox_mode = "danger-full-access"`). See [Security](https://developers.openai.com/codex/security). `sandbox_mode = "danger-full-access"`). See [Managed
37 configuration](https://developers.openai.com/codex/enterprise/managed-configuration) and [Admin-enforced
38 requirements](https://developers.openai.com/codex/enterprise/managed-configuration#admin-enforced-requirements-requirementstoml).
37 39
38## Common configuration options40## Common configuration options
39 41
44Choose the model Codex uses by default in the CLI and IDE.46Choose the model Codex uses by default in the CLI and IDE.
45 47
46```toml48```toml
4749model = "gpt-5.2"model = "gpt-5.4"
48```50```
49 51
50#### Approval prompts52#### Approval prompts
55approval_policy = "on-request"57approval_policy = "on-request"
56```58```
57 59
60For behavior differences between `untrusted`, `on-request`, and `never`, see [Run without approval prompts](https://developers.openai.com/codex/agent-approvals-security#run-without-approval-prompts) and [Common sandbox and approval combinations](https://developers.openai.com/codex/agent-approvals-security#common-sandbox-and-approval-combinations).
61
58#### Sandbox level62#### Sandbox level
59 63
60Adjust how much filesystem and network access Codex has while executing commands.64Adjust how much filesystem and network access Codex has while executing commands.
63sandbox_mode = "workspace-write"67sandbox_mode = "workspace-write"
64```68```
65 69
70For mode-by-mode behavior (including protected `.git`/`.codex` paths and network defaults), see [Sandbox and approvals](https://developers.openai.com/codex/agent-approvals-security#sandbox-and-approvals), [Protected paths in writable roots](https://developers.openai.com/codex/agent-approvals-security#protected-paths-in-writable-roots), and [Network access](https://developers.openai.com/codex/agent-approvals-security#network-access).
71
72#### Windows sandbox mode
73
74When running Codex natively on Windows, set the native sandbox mode to `elevated` in the `windows` table. Use `unelevated` only if you don't have administrator permissions or if elevated setup fails.
75
76```toml
77[windows]
78sandbox = "elevated" # Recommended
79# sandbox = "unelevated" # Fallback if admin permissions/setup are unavailable
80```
81
66#### Web search mode82#### Web search mode
67 83
6884Codex enables web search by default for local tasks and serves results from a web search cache. The cache is an OpenAI-maintained index of web results, so cached mode returns pre-indexed results instead of fetching live pages. This reduces exposure to prompt injection from arbitrary live content, but you should still treat web results as untrusted. If you are using `--yolo` or another [full access sandbox setting](https://developers.openai.com/codex/security), web search defaults to live results. Choose a mode with `web_search`:Codex enables web search by default for local tasks and serves results from a web search cache. The cache is an OpenAI-maintained index of web results, so cached mode returns pre-indexed results instead of fetching live pages. This reduces exposure to prompt injection from arbitrary live content, but you should still treat web results as untrusted. If you are using `--yolo` or another [full access sandbox setting](https://developers.openai.com/codex/agent-approvals-security#common-sandbox-and-approval-combinations), web search defaults to live results. Choose a mode with `web_search`:
69 85
70- `"cached"` (default) serves results from the web search cache.86- `"cached"` (default) serves results from the web search cache.
71- `"live"` fetches the most recent data from the web (same as `--search`).87- `"live"` fetches the most recent data from the web (same as `--search`).
131 147
132| Key | Default | Maturity | Description |148| Key | Default | Maturity | Description |
133| -------------------- | :-------------------: | ------------ | ---------------------------------------------------------------------------------------- |149| -------------------- | :-------------------: | ------------ | ---------------------------------------------------------------------------------------- |
134| `apply_patch_freeform` | false | Experimental | Include the freeform `apply_patch` tool |
135| `apps` | false | Experimental | Enable ChatGPT Apps/connectors support |150| `apps` | false | Experimental | Enable ChatGPT Apps/connectors support |
136151| `apps_mcp_gateway` | false | Experimental | Route Apps MCP calls through `https://api.openai.com/v1/connectors/mcp/` instead of legacy routing || `fast_mode` | true | Stable | Enable Fast mode selection and the `service_tier = "fast"` path |
137152| `elevated_windows_sandbox` | false | Experimental | Use the elevated Windows sandbox pipeline || `multi_agent` | true | Stable | Enable subagent collaboration tools |
138| `collaboration_modes` | true | Stable | Enable collaboration modes such as plan mode |
139| `experimental_windows_sandbox` | false | Experimental | Use the Windows restricted-token sandbox |
140| `multi_agent` | false | Experimental | Enable multi-agent collaboration tools |
141| `personality` | true | Stable | Enable personality selection controls |153| `personality` | true | Stable | Enable personality selection controls |
142154| `remote_models` | false | Experimental | Refresh remote model list before showing readiness || `shell_snapshot` | true | Stable | Snapshot your shell environment to speed up repeated commands |
143| `runtime_metrics` | false | Experimental | Show runtime metrics summaries in TUI turn separators |
144| `request_rule` | true | Stable | Enable Smart approvals (`prefix_rule` suggestions) |
145| `search_tool` | false | Experimental | Enable `search_tool_bm25` so Codex discovers Apps MCP tools via search before tool calls |
146| `shell_snapshot` | false | Beta | Snapshot your shell environment to speed up repeated commands |
147| `shell_tool` | true | Stable | Enable the default `shell` tool |155| `shell_tool` | true | Stable | Enable the default `shell` tool |
148156| `use_linux_sandbox_bwrap` | false | Experimental | Use the bubblewrap-based Linux sandbox pipeline || `smart_approvals` | false | Experimental | Route eligible approval requests through the guardian reviewer subagent |
149157| `unified_exec` | false | Beta | Use the unified PTY-backed exec tool || `unified_exec` | `true` except Windows | Stable | Use the unified PTY-backed exec tool |
150158| `undo` | true | Stable | Enable undo via per-turn git ghost snapshots || `undo` | false | Stable | Enable undo via per-turn git ghost snapshots |
151| `web_search` | true | Deprecated | Legacy toggle; prefer the top-level `web_search` setting |159| `web_search` | true | Deprecated | Legacy toggle; prefer the top-level `web_search` setting |
152160| `web_search_cached` | true | Deprecated | Legacy toggle that maps to `web_search = "cached"` when unset || `web_search_cached` | false | Deprecated | Legacy toggle that maps to `web_search = "cached"` when unset |
153161| `web_search_request` | true | Deprecated | Legacy toggle that maps to `web_search = "live"` when unset || `web_search_request` | false | Deprecated | Legacy toggle that maps to `web_search = "live"` when unset |
154 162
155The Maturity column uses feature maturity labels such as Experimental, Beta,163The Maturity column uses feature maturity labels such as Experimental, Beta,
156 and Stable. See [Feature Maturity](https://developers.openai.com/codex/feature-maturity) for how to164 and Stable. See [Feature Maturity](https://developers.openai.com/codex/feature-maturity) for how to