config-reference.md Codex Docs, 2026-03-06 00:38 UTC → 2026-04-23 00:46 UTC

6 6 

7User-level configuration lives in `~/.codex/config.toml`. You can also add project-scoped overrides in `.codex/config.toml` files. Codex loads project-scoped config files only when you trust the project.7User-level configuration lives in `~/.codex/config.toml`. You can also add project-scoped overrides in `.codex/config.toml` files. Codex loads project-scoped config files only when you trust the project.

8 8 

9For sandbox and approval keys (`approval_policy`, `sandbox_mode`, and `sandbox_workspace_write.*`), pair this reference with [Sandbox and approvals](https://developers.openai.com/codex/security#sandbox-and-approvals), [Protected paths in writable roots](https://developers.openai.com/codex/security#protected-paths-in-writable-roots), and [Network access](https://developers.openai.com/codex/security#network-access).9For sandbox and approval keys (`approval_policy`, `sandbox_mode`, and `sandbox_workspace_write.*`), pair this reference with [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).

10 10 

11| Key | Type / Values | Details |11| Key | Type / Values | Details |

12| --- | --- | --- |12| --- | --- | --- |

13| `agents.<name>.config_file` | `string (path)` | Path to a TOML config layer for that role; relative paths resolve from the config file that declares the role. |13| `agents.<name>.config_file` | `string (path)` | Path to a TOML config layer for that role; relative paths resolve from the config file that declares the role. |

14| `agents.<name>.description` | `string` | Role guidance shown to Codex when choosing and spawning that agent type. |14| `agents.<name>.description` | `string` | Role guidance shown to Codex when choosing and spawning that agent type. |

15| `agents.<name>.nickname_candidates` | `array<string>` | Optional pool of display nicknames for spawned agents in that role. |

15| `agents.job_max_runtime_seconds` | `number` | Default per-worker timeout for `spawn_agents_on_csv` jobs. When unset, the tool falls back to 1800 seconds per worker. |16| `agents.job_max_runtime_seconds` | `number` | Default per-worker timeout for `spawn_agents_on_csv` jobs. When unset, the tool falls back to 1800 seconds per worker. |

16| `agents.max_depth` | `number` | Maximum nesting depth allowed for spawned agent threads (root sessions start at depth 0; default: 1). |17| `agents.max_depth` | `number` | Maximum nesting depth allowed for spawned agent threads (root sessions start at depth 0; default: 1). |

17| `agents.max_threads` | `number` | Maximum number of agent threads that can be open concurrently. |18| `agents.max_threads` | `number` | Maximum number of agent threads that can be open concurrently. Defaults to `6` when unset. |

18| `allow_login_shell` | `boolean` | Allow shell-based tools to use login-shell semantics. Defaults to `true`; when `false`, `login = true` requests are rejected and omitted `login` defaults to non-login shells. |19| `allow_login_shell` | `boolean` | Allow shell-based tools to use login-shell semantics. Defaults to `true`; when `false`, `login = true` requests are rejected and omitted `login` defaults to non-login shells. |

19| `approval_policy` | `untrusted | on-request | never | { reject = { sandbox_approval = bool, rules = bool, mcp_elicitations = bool } }` | Controls when Codex pauses for approval before executing commands. You can also use `approval_policy = { reject = { ... } }` to auto-reject specific prompt categories while keeping other prompts interactive. `on-failure` is deprecated; use `on-request` for interactive runs or `never` for non-interactive runs. |20| `analytics.enabled` | `boolean` | Enable or disable analytics for this machine/profile. When unset, the client default applies. |

20| `approval_policy.reject.mcp_elicitations` | `boolean` | When `true`, MCP elicitation prompts are auto-rejected instead of shown to the user. |21| `approval_policy` | `untrusted | on-request | never | { granular = { sandbox_approval = bool, rules = bool, mcp_elicitations = bool, request_permissions = bool, skill_approval = bool } }` | Controls when Codex pauses for approval before executing commands. You can also use `approval_policy = { granular = { ... } }` to allow or auto-reject specific prompt categories while keeping other prompts interactive. `on-failure` is deprecated; use `on-request` for interactive runs or `never` for non-interactive runs. |

21| `approval_policy.reject.rules` | `boolean` | When `true`, approvals triggered by execpolicy `prompt` rules are auto-rejected. |22| `approval_policy.granular.mcp_elicitations` | `boolean` | When `true`, MCP elicitation prompts are allowed to surface instead of being auto-rejected. |

22| `approval_policy.reject.sandbox_approval` | `boolean` | When `true`, sandbox escalation approval prompts are auto-rejected. |23| `approval_policy.granular.request_permissions` | `boolean` | When `true`, prompts from the `request_permissions` tool are allowed to surface. |

24| `approval_policy.granular.rules` | `boolean` | When `true`, approvals triggered by execpolicy `prompt` rules are allowed to surface. |

25| `approval_policy.granular.sandbox_approval` | `boolean` | When `true`, sandbox escalation approval prompts are allowed to surface. |

26| `approval_policy.granular.skill_approval` | `boolean` | When `true`, skill-script approval prompts are allowed to surface. |

27| `approvals_reviewer` | `user | guardian_subagent` | Select who reviews eligible approval prompts. Defaults to `user`; `guardian_subagent` routes supported reviews through the Guardian reviewer subagent. |

23| `apps._default.destructive_enabled` | `boolean` | Default allow/deny for app tools with `destructive_hint = true`. |28| `apps._default.destructive_enabled` | `boolean` | Default allow/deny for app tools with `destructive_hint = true`. |

24| `apps._default.enabled` | `boolean` | Default app enabled state for all apps unless overridden per app. |29| `apps._default.enabled` | `boolean` | Default app enabled state for all apps unless overridden per app. |

25| `apps._default.open_world_enabled` | `boolean` | Default allow/deny for app tools with `open_world_hint = true`. |30| `apps._default.open_world_enabled` | `boolean` | Default allow/deny for app tools with `open_world_hint = true`. |

34| `chatgpt_base_url` | `string` | Override the base URL used during the ChatGPT login flow. |39| `chatgpt_base_url` | `string` | Override the base URL used during the ChatGPT login flow. |

35| `check_for_update_on_startup` | `boolean` | Check for Codex updates on startup (set to false only when updates are centrally managed). |40| `check_for_update_on_startup` | `boolean` | Check for Codex updates on startup (set to false only when updates are centrally managed). |

36| `cli_auth_credentials_store` | `file | keyring | auto` | Control where the CLI stores cached credentials (file-based auth.json vs OS keychain). |41| `cli_auth_credentials_store` | `file | keyring | auto` | Control where the CLI stores cached credentials (file-based auth.json vs OS keychain). |

42| `commit_attribution` | `string` | Override the commit co-author trailer text. Set an empty string to disable automatic attribution. |

37| `compact_prompt` | `string` | Inline override for the history compaction prompt. |43| `compact_prompt` | `string` | Inline override for the history compaction prompt. |

44| `default_permissions` | `string` | Name of the default permissions profile to apply to sandboxed tool calls. |

38| `developer_instructions` | `string` | Additional developer instructions injected into the session (optional). |45| `developer_instructions` | `string` | Additional developer instructions injected into the session (optional). |

39| `disable_paste_burst` | `boolean` | Disable burst-paste detection in the TUI. |46| `disable_paste_burst` | `boolean` | Disable burst-paste detection in the TUI. |

40| `experimental_compact_prompt_file` | `string (path)` | Load the compaction prompt override from a file (experimental). |47| `experimental_compact_prompt_file` | `string (path)` | Load the compaction prompt override from a file (experimental). |

41| `experimental_use_freeform_apply_patch` | `boolean` | Legacy name for enabling freeform apply\_patch; prefer `[features].apply_patch_freeform` or `codex --enable apply_patch_freeform`. |

42| `experimental_use_unified_exec_tool` | `boolean` | Legacy name for enabling unified exec; prefer `[features].unified_exec` or `codex --enable unified_exec`. |48| `experimental_use_unified_exec_tool` | `boolean` | Legacy name for enabling unified exec; prefer `[features].unified_exec` or `codex --enable unified_exec`. |

43| `features.apply_patch_freeform` | `boolean` | Expose the freeform `apply_patch` tool (experimental). |

44| `features.apps` | `boolean` | Enable ChatGPT Apps/connectors support (experimental). |49| `features.apps` | `boolean` | Enable ChatGPT Apps/connectors support (experimental). |

45| `features.apps_mcp_gateway` | `boolean` | Route Apps MCP calls through the OpenAI connectors MCP gateway (`https://api.openai.com/v1/connectors/mcp/`) instead of legacy routing (experimental). |50| `features.codex_hooks` | `boolean` | Enable lifecycle hooks loaded from `hooks.json` (under development; off by default). |

46| `features.child_agents_md` | `boolean` | Append AGENTS.md scope/precedence guidance even when no AGENTS.md is present (experimental). |51| `features.enable_request_compression` | `boolean` | Compress streaming request bodies with zstd when supported (stable; on by default). |

47| `features.collaboration_modes` | `boolean` | Enable collaboration modes such as plan mode (stable; on by default). |52| `features.fast_mode` | `boolean` | Enable Fast mode selection and the `service_tier = "fast"` path (stable; on by default). |

48| `features.multi_agent` | `boolean` | Enable multi-agent collaboration tools (`spawn_agent`, `send_input`, `resume_agent`, `wait`, `close_agent`, and `spawn_agents_on_csv`) (experimental; off by default). |53| `features.guardian_approval` | `boolean` | Route eligible approval requests through the guardian reviewer subagent (experimental; off by default). Use with `approvals_reviewer = "guardian_subagent"`. |

54| `features.memories` | `boolean` | Enable [Memories](https://developers.openai.com/codex/memories) (off by default). |

55| `features.multi_agent` | `boolean` | Enable multi-agent collaboration tools (`spawn_agent`, `send_input`, `resume_agent`, `wait_agent`, and `close_agent`) (stable; on by default). |

49| `features.personality` | `boolean` | Enable personality selection controls (stable; on by default). |56| `features.personality` | `boolean` | Enable personality selection controls (stable; on by default). |

50| `features.powershell_utf8` | `boolean` | Force PowerShell UTF-8 output (defaults to true). |57| `features.prevent_idle_sleep` | `boolean` | Prevent the machine from sleeping while a turn is actively running (experimental; off by default). |

51| `features.remote_models` | `boolean` | Refresh remote model list before showing readiness (experimental). |58| `features.shell_snapshot` | `boolean` | Snapshot shell environment to speed up repeated commands (stable; on by default). |

52| `features.request_rule` | `boolean` | Enable Smart approvals (`prefix_rule` suggestions on escalation requests; stable; on by default). |

53| `features.runtime_metrics` | `boolean` | Show runtime metrics summary in TUI turn separators (experimental). |

54| `features.search_tool` | `boolean` | Enable `search_tool_bm25` for Apps tool discovery before invoking app MCP tools (experimental). |

55| `features.shell_snapshot` | `boolean` | Snapshot shell environment to speed up repeated commands (beta). |

56| `features.shell_tool` | `boolean` | Enable the default `shell` tool for running commands (stable; on by default). |59| `features.shell_tool` | `boolean` | Enable the default `shell` tool for running commands (stable; on by default). |

57| `features.unified_exec` | `boolean` | Use the unified PTY-backed exec tool (beta). |60| `features.skill_mcp_dependency_install` | `boolean` | Allow prompting and installing missing MCP dependencies for skills (stable; on by default). |

58| `features.use_linux_sandbox_bwrap` | `boolean` | Use the bubblewrap-based Linux sandbox pipeline (experimental; off by default). |61| `features.undo` | `boolean` | Enable undo support (stable; off by default). |

62| `features.unified_exec` | `boolean` | Use the unified PTY-backed exec tool (stable; enabled by default except on Windows). |

59| `features.web_search` | `boolean` | Deprecated legacy toggle; prefer the top-level `web_search` setting. |63| `features.web_search` | `boolean` | Deprecated legacy toggle; prefer the top-level `web_search` setting. |

60| `features.web_search_cached` | `boolean` | Deprecated legacy toggle. When `web_search` is unset, true maps to `web_search = "cached"`. |64| `features.web_search_cached` | `boolean` | Deprecated legacy toggle. When `web_search` is unset, true maps to `web_search = "cached"`. |

61| `features.web_search_request` | `boolean` | Deprecated legacy toggle. When `web_search` is unset, true maps to `web_search = "live"`. |65| `features.web_search_request` | `boolean` | Deprecated legacy toggle. When `web_search` is unset, true maps to `web_search = "live"`. |

66| `hide_agent_reasoning` | `boolean` | Suppress reasoning events in both the TUI and `codex exec` output. |70| `hide_agent_reasoning` | `boolean` | Suppress reasoning events in both the TUI and `codex exec` output. |

67| `history.max_bytes` | `number` | If set, caps the history file size in bytes by dropping oldest entries. |71| `history.max_bytes` | `number` | If set, caps the history file size in bytes by dropping oldest entries. |

68| `history.persistence` | `save-all | none` | Control whether Codex saves session transcripts to history.jsonl. |72| `history.persistence` | `save-all | none` | Control whether Codex saves session transcripts to history.jsonl. |

69| `include_apply_patch_tool` | `boolean` | Legacy name for enabling freeform apply\_patch; prefer `[features].apply_patch_freeform`. |

70| `instructions` | `string` | Reserved for future use; prefer `model_instructions_file` or `AGENTS.md`. |73| `instructions` | `string` | Reserved for future use; prefer `model_instructions_file` or `AGENTS.md`. |

71| `log_dir` | `string (path)` | Directory where Codex writes log files (for example `codex-tui.log`); defaults to `$CODEX_HOME/log`. |74| `log_dir` | `string (path)` | Directory where Codex writes log files (for example `codex-tui.log`); defaults to `$CODEX_HOME/log`. |

72| `mcp_oauth_callback_port` | `integer` | Optional fixed port for the local HTTP callback server used during MCP OAuth login. When unset, Codex binds to an ephemeral port chosen by the OS. |75| `mcp_oauth_callback_port` | `integer` | Optional fixed port for the local HTTP callback server used during MCP OAuth login. When unset, Codex binds to an ephemeral port chosen by the OS. |

81| `mcp_servers.<id>.enabled_tools` | `array<string>` | Allow list of tool names exposed by the MCP server. |84| `mcp_servers.<id>.enabled_tools` | `array<string>` | Allow list of tool names exposed by the MCP server. |

82| `mcp_servers.<id>.env` | `map<string,string>` | Environment variables forwarded to the MCP stdio server. |85| `mcp_servers.<id>.env` | `map<string,string>` | Environment variables forwarded to the MCP stdio server. |

83| `mcp_servers.<id>.env_http_headers` | `map<string,string>` | HTTP headers populated from environment variables for an MCP HTTP server. |86| `mcp_servers.<id>.env_http_headers` | `map<string,string>` | HTTP headers populated from environment variables for an MCP HTTP server. |

84| `mcp_servers.<id>.env_vars` | `array<string>` | Additional environment variables to whitelist for an MCP stdio server. |87| `mcp_servers.<id>.env_vars` | `array<string | { name = string, source = "local" | "remote" }>` | Additional environment variables to whitelist for an MCP stdio server. String entries default to `source = "local"`; use `source = "remote"` only with executor-backed remote stdio. |

88| `mcp_servers.<id>.experimental_environment` | `local | remote` | Experimental placement for an MCP server. `remote` starts stdio servers through a remote executor environment; streamable HTTP remote placement is not implemented. |

85| `mcp_servers.<id>.http_headers` | `map<string,string>` | Static HTTP headers included with each MCP HTTP request. |89| `mcp_servers.<id>.http_headers` | `map<string,string>` | Static HTTP headers included with each MCP HTTP request. |

90| `mcp_servers.<id>.oauth_resource` | `string` | Optional RFC 8707 OAuth resource parameter to include during MCP login. |

86| `mcp_servers.<id>.required` | `boolean` | When true, fail startup/resume if this enabled MCP server cannot initialize. |91| `mcp_servers.<id>.required` | `boolean` | When true, fail startup/resume if this enabled MCP server cannot initialize. |

92| `mcp_servers.<id>.scopes` | `array<string>` | OAuth scopes to request when authenticating to that MCP server. |

87| `mcp_servers.<id>.startup_timeout_ms` | `number` | Alias for `startup_timeout_sec` in milliseconds. |93| `mcp_servers.<id>.startup_timeout_ms` | `number` | Alias for `startup_timeout_sec` in milliseconds. |

88| `mcp_servers.<id>.startup_timeout_sec` | `number` | Override the default 10s startup timeout for an MCP server. |94| `mcp_servers.<id>.startup_timeout_sec` | `number` | Override the default 10s startup timeout for an MCP server. |

89| `mcp_servers.<id>.tool_timeout_sec` | `number` | Override the default 60s per-tool timeout for an MCP server. |95| `mcp_servers.<id>.tool_timeout_sec` | `number` | Override the default 60s per-tool timeout for an MCP server. |

90| `mcp_servers.<id>.url` | `string` | Endpoint for an MCP streamable HTTP server. |96| `mcp_servers.<id>.url` | `string` | Endpoint for an MCP streamable HTTP server. |

91| `model` | `string` | Model to use (e.g., `gpt-5-codex`). |97| `memories.consolidation_model` | `string` | Optional model override for global memory consolidation. |

98| `memories.disable_on_external_context` | `boolean` | When `true`, threads that use external context such as MCP tool calls, web search, or tool search are kept out of memory generation. Defaults to `false`. Legacy alias: `memories.no_memories_if_mcp_or_web_search`. |

99| `memories.extract_model` | `string` | Optional model override for per-thread memory extraction. |

100| `memories.generate_memories` | `boolean` | When `false`, newly created threads are not stored as memory-generation inputs. Defaults to `true`. |

101| `memories.max_raw_memories_for_consolidation` | `number` | Maximum recent raw memories retained for global consolidation. Defaults to `256` and is capped at `4096`. |

102| `memories.max_rollout_age_days` | `number` | Maximum age of threads considered for memory generation. Defaults to `30` and is clamped to `0`-`90`. |

103| `memories.max_rollouts_per_startup` | `number` | Maximum rollout candidates processed per startup pass. Defaults to `16` and is capped at `128`. |

104| `memories.max_unused_days` | `number` | Maximum days since a memory was last used before it becomes ineligible for consolidation. Defaults to `30` and is clamped to `0`-`365`. |

105| `memories.min_rollout_idle_hours` | `number` | Minimum idle time before a thread is considered for memory generation. Defaults to `6` and is clamped to `1`-`48`. |

106| `memories.use_memories` | `boolean` | When `false`, Codex skips injecting existing memories into future sessions. Defaults to `true`. |

107| `model` | `string` | Model to use (e.g., `gpt-5.4`). |

92| `model_auto_compact_token_limit` | `number` | Token threshold that triggers automatic history compaction (unset uses model defaults). |108| `model_auto_compact_token_limit` | `number` | Token threshold that triggers automatic history compaction (unset uses model defaults). |

93| `model_catalog_json` | `string (path)` | Optional path to a JSON model catalog loaded on startup. Profile-level `profiles.<name>.model_catalog_json` can override this per profile. |109| `model_catalog_json` | `string (path)` | Optional path to a JSON model catalog loaded on startup. Profile-level `profiles.<name>.model_catalog_json` can override this per profile. |

94| `model_context_window` | `number` | Context window tokens available to the active model. |110| `model_context_window` | `number` | Context window tokens available to the active model. |

95| `model_instructions_file` | `string (path)` | Replacement for built-in instructions instead of `AGENTS.md`. |111| `model_instructions_file` | `string (path)` | Replacement for built-in instructions instead of `AGENTS.md`. |

96| `model_provider` | `string` | Provider id from `model_providers` (default: `openai`). |112| `model_provider` | `string` | Provider id from `model_providers` (default: `openai`). |

113| `model_providers.<id>` | `table` | Custom provider definition. Built-in provider IDs (`openai`, `ollama`, and `lmstudio`) are reserved and cannot be overridden. |

114| `model_providers.<id>.auth` | `table` | Command-backed bearer token configuration for a custom provider. Do not combine with `env_key`, `experimental_bearer_token`, or `requires_openai_auth`. |

115| `model_providers.<id>.auth.args` | `array<string>` | Arguments passed to the token command. |

116| `model_providers.<id>.auth.command` | `string` | Command to run when Codex needs a bearer token. The command must print the token to stdout. |

117| `model_providers.<id>.auth.cwd` | `string (path)` | Working directory for the token command. |

118| `model_providers.<id>.auth.refresh_interval_ms` | `number` | How often Codex proactively refreshes the token in milliseconds (default: 300000). Set to `0` to refresh only after an authentication retry. |

119| `model_providers.<id>.auth.timeout_ms` | `number` | Maximum token command runtime in milliseconds (default: 5000). |

97| `model_providers.<id>.base_url` | `string` | API base URL for the model provider. |120| `model_providers.<id>.base_url` | `string` | API base URL for the model provider. |

98| `model_providers.<id>.env_http_headers` | `map<string,string>` | HTTP headers populated from environment variables when present. |121| `model_providers.<id>.env_http_headers` | `map<string,string>` | HTTP headers populated from environment variables when present. |

99| `model_providers.<id>.env_key` | `string` | Environment variable supplying the provider API key. |122| `model_providers.<id>.env_key` | `string` | Environment variable supplying the provider API key. |

106| `model_providers.<id>.requires_openai_auth` | `boolean` | The provider uses OpenAI authentication (defaults to false). |129| `model_providers.<id>.requires_openai_auth` | `boolean` | The provider uses OpenAI authentication (defaults to false). |

107| `model_providers.<id>.stream_idle_timeout_ms` | `number` | Idle timeout for SSE streams in milliseconds (default: 300000). |130| `model_providers.<id>.stream_idle_timeout_ms` | `number` | Idle timeout for SSE streams in milliseconds (default: 300000). |

108| `model_providers.<id>.stream_max_retries` | `number` | Retry count for SSE streaming interruptions (default: 5). |131| `model_providers.<id>.stream_max_retries` | `number` | Retry count for SSE streaming interruptions (default: 5). |

109| `model_providers.<id>.wire_api` | `chat | responses` | Protocol used by the provider (defaults to `chat` if omitted). |132| `model_providers.<id>.supports_websockets` | `boolean` | Whether that provider supports the Responses API WebSocket transport. |

133| `model_providers.<id>.wire_api` | `responses` | Protocol used by the provider. `responses` is the only supported value, and it is the default when omitted. |

110| `model_reasoning_effort` | `minimal | low | medium | high | xhigh` | Adjust reasoning effort for supported models (Responses API only; `xhigh` is model-dependent). |134| `model_reasoning_effort` | `minimal | low | medium | high | xhigh` | Adjust reasoning effort for supported models (Responses API only; `xhigh` is model-dependent). |

111| `model_reasoning_summary` | `auto | concise | detailed | none` | Select reasoning summary detail or disable summaries entirely. |135| `model_reasoning_summary` | `auto | concise | detailed | none` | Select reasoning summary detail or disable summaries entirely. |

112| `model_supports_reasoning_summaries` | `boolean` | Force Codex to send or not send reasoning metadata. |136| `model_supports_reasoning_summaries` | `boolean` | Force Codex to send or not send reasoning metadata. |

113| `model_verbosity` | `low | medium | high` | Control GPT-5 Responses API verbosity (defaults to `medium`). |137| `model_verbosity` | `low | medium | high` | Optional GPT-5 Responses API verbosity override; when unset, the selected model/preset default is used. |

114| `notice.hide_full_access_warning` | `boolean` | Track acknowledgement of the full access warning prompt. |138| `notice.hide_full_access_warning` | `boolean` | Track acknowledgement of the full access warning prompt. |

115| `notice.hide_gpt-5.1-codex-max_migration_prompt` | `boolean` | Track acknowledgement of the gpt-5.1-codex-max migration prompt. |139| `notice.hide_gpt-5.1-codex-max_migration_prompt` | `boolean` | Track acknowledgement of the gpt-5.1-codex-max migration prompt. |

116| `notice.hide_gpt5_1_migration_prompt` | `boolean` | Track acknowledgement of the GPT-5.1 migration prompt. |140| `notice.hide_gpt5_1_migration_prompt` | `boolean` | Track acknowledgement of the GPT-5.1 migration prompt. |

118| `notice.hide_world_writable_warning` | `boolean` | Track acknowledgement of the Windows world-writable directories warning. |142| `notice.hide_world_writable_warning` | `boolean` | Track acknowledgement of the Windows world-writable directories warning. |

119| `notice.model_migrations` | `map<string,string>` | Track acknowledged model migrations as old->new mappings. |143| `notice.model_migrations` | `map<string,string>` | Track acknowledged model migrations as old->new mappings. |

120| `notify` | `array<string>` | Command invoked for notifications; receives a JSON payload from Codex. |144| `notify` | `array<string>` | Command invoked for notifications; receives a JSON payload from Codex. |

145| `openai_base_url` | `string` | Base URL override for the built-in `openai` model provider. |

121| `oss_provider` | `lmstudio | ollama` | Default local provider used when running with `--oss` (defaults to prompting if unset). |146| `oss_provider` | `lmstudio | ollama` | Default local provider used when running with `--oss` (defaults to prompting if unset). |

122| `otel.environment` | `string` | Environment tag applied to emitted OpenTelemetry events (default: `dev`). |147| `otel.environment` | `string` | Environment tag applied to emitted OpenTelemetry events (default: `dev`). |

123| `otel.exporter` | `none | otlp-http | otlp-grpc` | Select the OpenTelemetry exporter and provide any endpoint metadata. |148| `otel.exporter` | `none | otlp-http | otlp-grpc` | Select the OpenTelemetry exporter and provide any endpoint metadata. |

128| `otel.exporter.<id>.tls.client-certificate` | `string` | Client certificate path for OTEL exporter TLS. |153| `otel.exporter.<id>.tls.client-certificate` | `string` | Client certificate path for OTEL exporter TLS. |

129| `otel.exporter.<id>.tls.client-private-key` | `string` | Client private key path for OTEL exporter TLS. |154| `otel.exporter.<id>.tls.client-private-key` | `string` | Client private key path for OTEL exporter TLS. |

130| `otel.log_user_prompt` | `boolean` | Opt in to exporting raw user prompts with OpenTelemetry logs. |155| `otel.log_user_prompt` | `boolean` | Opt in to exporting raw user prompts with OpenTelemetry logs. |

156| `otel.metrics_exporter` | `none | statsig | otlp-http | otlp-grpc` | Select the OpenTelemetry metrics exporter (defaults to `statsig`). |

131| `otel.trace_exporter` | `none | otlp-http | otlp-grpc` | Select the OpenTelemetry trace exporter and provide any endpoint metadata. |157| `otel.trace_exporter` | `none | otlp-http | otlp-grpc` | Select the OpenTelemetry trace exporter and provide any endpoint metadata. |

132| `otel.trace_exporter.<id>.endpoint` | `string` | Trace exporter endpoint for OTEL logs. |158| `otel.trace_exporter.<id>.endpoint` | `string` | Trace exporter endpoint for OTEL logs. |

133| `otel.trace_exporter.<id>.headers` | `map<string,string>` | Static headers included with OTEL trace exporter requests. |159| `otel.trace_exporter.<id>.headers` | `map<string,string>` | Static headers included with OTEL trace exporter requests. |

135| `otel.trace_exporter.<id>.tls.ca-certificate` | `string` | CA certificate path for OTEL trace exporter TLS. |161| `otel.trace_exporter.<id>.tls.ca-certificate` | `string` | CA certificate path for OTEL trace exporter TLS. |

136| `otel.trace_exporter.<id>.tls.client-certificate` | `string` | Client certificate path for OTEL trace exporter TLS. |162| `otel.trace_exporter.<id>.tls.client-certificate` | `string` | Client certificate path for OTEL trace exporter TLS. |

137| `otel.trace_exporter.<id>.tls.client-private-key` | `string` | Client private key path for OTEL trace exporter TLS. |163| `otel.trace_exporter.<id>.tls.client-private-key` | `string` | Client private key path for OTEL trace exporter TLS. |

164| `permissions.<name>.filesystem` | `table` | Named filesystem permission profile. Each key is an absolute path or special token such as `:minimal` or `:project_roots`. |

165| `permissions.<name>.filesystem.":project_roots".<subpath-or-glob>` | `"read" | "write" | "none"` | Scoped filesystem access relative to the detected project roots. Use `"."` for the root itself; glob subpaths such as `"**/*.env"` can deny reads with `"none"`. |

166| `permissions.<name>.filesystem.<path-or-glob>` | `"read" | "write" | "none" | table` | Grant direct access for a path, glob pattern, or special token, or scope nested entries under that root. Use `"none"` to deny reads for matching paths. |

167| `permissions.<name>.filesystem.glob_scan_max_depth` | `number` | Maximum depth for expanding deny-read glob patterns on platforms that snapshot matches before sandbox startup. Must be at least `1` when set. |

168| `permissions.<name>.network.allow_local_binding` | `boolean` | Permit local bind/listen operations through the managed proxy. |

169| `permissions.<name>.network.allow_upstream_proxy` | `boolean` | Allow the managed proxy to chain to another upstream proxy. |

170| `permissions.<name>.network.dangerously_allow_all_unix_sockets` | `boolean` | Allow the proxy to use arbitrary Unix sockets instead of the default restricted set. |

171| `permissions.<name>.network.dangerously_allow_non_loopback_proxy` | `boolean` | Permit non-loopback bind addresses for the managed proxy listener. |

172| `permissions.<name>.network.domains` | `map<string, allow | deny>` | Domain rules for the managed proxy. Use domain names or wildcard patterns as keys, with `allow` or `deny` values. |

173| `permissions.<name>.network.enable_socks5` | `boolean` | Expose a SOCKS5 listener when this permissions profile enables the managed network proxy. |

174| `permissions.<name>.network.enable_socks5_udp` | `boolean` | Allow UDP over the SOCKS5 listener when enabled. |

175| `permissions.<name>.network.enabled` | `boolean` | Enable network access for this named permissions profile. |

176| `permissions.<name>.network.mode` | `limited | full` | Network proxy mode used for subprocess traffic. |

177| `permissions.<name>.network.proxy_url` | `string` | HTTP proxy endpoint used when this permissions profile enables the managed network proxy. |

178| `permissions.<name>.network.socks_url` | `string` | SOCKS5 proxy endpoint used by this permissions profile. |

179| `permissions.<name>.network.unix_sockets` | `map<string, allow | none>` | Unix socket rules for the managed proxy. Use socket paths as keys, with `allow` or `none` values. |

138| `personality` | `none | friendly | pragmatic` | Default communication style for models that advertise `supportsPersonality`; can be overridden per thread/turn or via `/personality`. |180| `personality` | `none | friendly | pragmatic` | Default communication style for models that advertise `supportsPersonality`; can be overridden per thread/turn or via `/personality`. |

181| `plan_mode_reasoning_effort` | `none | minimal | low | medium | high | xhigh` | Plan-mode-specific reasoning override. When unset, Plan mode uses its built-in preset default. |

139| `profile` | `string` | Default profile applied at startup (equivalent to `--profile`). |182| `profile` | `string` | Default profile applied at startup (equivalent to `--profile`). |

140| `profiles.<name>.*` | `various` | Profile-scoped overrides for any of the supported configuration keys. |183| `profiles.<name>.*` | `various` | Profile-scoped overrides for any of the supported configuration keys. |

141| `profiles.<name>.experimental_use_freeform_apply_patch` | `boolean` | Legacy name for enabling freeform apply\_patch; prefer `[features].apply_patch_freeform`. |184| `profiles.<name>.analytics.enabled` | `boolean` | Profile-scoped analytics enablement override. |

142| `profiles.<name>.experimental_use_unified_exec_tool` | `boolean` | Legacy name for enabling unified exec; prefer `[features].unified_exec`. |185| `profiles.<name>.experimental_use_unified_exec_tool` | `boolean` | Legacy name for enabling unified exec; prefer `[features].unified_exec`. |

143| `profiles.<name>.include_apply_patch_tool` | `boolean` | Legacy name for enabling freeform apply\_patch; prefer `[features].apply_patch_freeform`. |

144| `profiles.<name>.model_catalog_json` | `string (path)` | Profile-scoped model catalog JSON path override (applied on startup only; overrides the top-level `model_catalog_json` for that profile). |186| `profiles.<name>.model_catalog_json` | `string (path)` | Profile-scoped model catalog JSON path override (applied on startup only; overrides the top-level `model_catalog_json` for that profile). |

187| `profiles.<name>.model_instructions_file` | `string (path)` | Profile-scoped replacement for the built-in instruction file. |

145| `profiles.<name>.oss_provider` | `lmstudio | ollama` | Profile-scoped OSS provider for `--oss` sessions. |188| `profiles.<name>.oss_provider` | `lmstudio | ollama` | Profile-scoped OSS provider for `--oss` sessions. |

146| `profiles.<name>.personality` | `none | friendly | pragmatic` | Profile-scoped communication style override for supported models. |189| `profiles.<name>.personality` | `none | friendly | pragmatic` | Profile-scoped communication style override for supported models. |

190| `profiles.<name>.plan_mode_reasoning_effort` | `none | minimal | low | medium | high | xhigh` | Profile-scoped Plan-mode reasoning override. |

191| `profiles.<name>.service_tier` | `flex | fast` | Profile-scoped service tier preference for new turns. |

192| `profiles.<name>.tools_view_image` | `boolean` | Enable or disable the `view_image` tool in that profile. |

147| `profiles.<name>.web_search` | `disabled | cached | live` | Profile-scoped web search mode override (default: `"cached"`). |193| `profiles.<name>.web_search` | `disabled | cached | live` | Profile-scoped web search mode override (default: `"cached"`). |

194| `profiles.<name>.windows.sandbox` | `unelevated | elevated` | Profile-scoped Windows sandbox mode override. |

148| `project_doc_fallback_filenames` | `array<string>` | Additional filenames to try when `AGENTS.md` is missing. |195| `project_doc_fallback_filenames` | `array<string>` | Additional filenames to try when `AGENTS.md` is missing. |

149| `project_doc_max_bytes` | `number` | Maximum bytes read from `AGENTS.md` when building project instructions. |196| `project_doc_max_bytes` | `number` | Maximum bytes read from `AGENTS.md` when building project instructions. |

150| `project_root_markers` | `array<string>` | List of project root marker filenames; used when searching parent directories for the project root. |197| `project_root_markers` | `array<string>` | List of project root marker filenames; used when searching parent directories for the project root. |

155| `sandbox_workspace_write.exclude_tmpdir_env_var` | `boolean` | Exclude `$TMPDIR` from writable roots in workspace-write mode. |202| `sandbox_workspace_write.exclude_tmpdir_env_var` | `boolean` | Exclude `$TMPDIR` from writable roots in workspace-write mode. |

156| `sandbox_workspace_write.network_access` | `boolean` | Allow outbound network access inside the workspace-write sandbox. |203| `sandbox_workspace_write.network_access` | `boolean` | Allow outbound network access inside the workspace-write sandbox. |

157| `sandbox_workspace_write.writable_roots` | `array<string>` | Additional writable roots when `sandbox_mode = "workspace-write"`. |204| `sandbox_workspace_write.writable_roots` | `array<string>` | Additional writable roots when `sandbox_mode = "workspace-write"`. |

205| `service_tier` | `flex | fast` | Preferred service tier for new turns. |

158| `shell_environment_policy.exclude` | `array<string>` | Glob patterns for removing environment variables after the defaults. |206| `shell_environment_policy.exclude` | `array<string>` | Glob patterns for removing environment variables after the defaults. |

159| `shell_environment_policy.experimental_use_profile` | `boolean` | Use the user shell profile when spawning subprocesses. |207| `shell_environment_policy.experimental_use_profile` | `boolean` | Use the user shell profile when spawning subprocesses. |

160| `shell_environment_policy.ignore_default_excludes` | `boolean` | Keep variables containing KEY/SECRET/TOKEN before other filters run. |208| `shell_environment_policy.ignore_default_excludes` | `boolean` | Keep variables containing KEY/SECRET/TOKEN before other filters run. |

168| `sqlite_home` | `string (path)` | Directory where Codex stores the SQLite-backed state DB used by agent jobs and other resumable runtime state. |216| `sqlite_home` | `string (path)` | Directory where Codex stores the SQLite-backed state DB used by agent jobs and other resumable runtime state. |

169| `suppress_unstable_features_warning` | `boolean` | Suppress the warning that appears when under-development feature flags are enabled. |217| `suppress_unstable_features_warning` | `boolean` | Suppress the warning that appears when under-development feature flags are enabled. |

170| `tool_output_token_limit` | `number` | Token budget for storing individual tool/function outputs in history. |218| `tool_output_token_limit` | `number` | Token budget for storing individual tool/function outputs in history. |

171| `tools.web_search` | `boolean` | Deprecated legacy toggle for web search; prefer the top-level `web_search` setting. |219| `tool_suggest.discoverables` | `array<table>` | Allow tool suggestions for additional discoverable connectors or plugins. Each entry uses `type = "connector"` or `"plugin"` and an `id`. |

220| `tools.view_image` | `boolean` | Enable the local-image attachment tool `view_image`. |

221| `tools.web_search` | `boolean | { context_size = "low|medium|high", allowed_domains = [string], location = { country, region, city, timezone } }` | Optional web search tool configuration. The legacy boolean form is still accepted, but the object form lets you set search context size, allowed domains, and approximate user location. |

172| `tui` | `table` | TUI-specific options such as enabling inline desktop notifications. |222| `tui` | `table` | TUI-specific options such as enabling inline desktop notifications. |

173| `tui.alternate_screen` | `auto | always | never` | Control alternate screen usage for the TUI (default: auto; auto skips it in Zellij to preserve scrollback). |223| `tui.alternate_screen` | `auto | always | never` | Control alternate screen usage for the TUI (default: auto; auto skips it in Zellij to preserve scrollback). |

174| `tui.animations` | `boolean` | Enable terminal animations (welcome screen, shimmer, spinner) (default: true). |224| `tui.animations` | `boolean` | Enable terminal animations (welcome screen, shimmer, spinner) (default: true). |

175| `tui.notification_method` | `auto | osc9 | bel` | Notification method for unfocused terminal notifications (default: auto). |225| `tui.model_availability_nux.<model>` | `integer` | Internal startup-tooltip state keyed by model slug. |

226| `tui.notification_condition` | `unfocused | always` | Control whether TUI notifications fire only when the terminal is unfocused or regardless of focus. Defaults to `unfocused`. |

227| `tui.notification_method` | `auto | osc9 | bel` | Notification method for terminal notifications (default: auto). |

176| `tui.notifications` | `boolean | array<string>` | Enable TUI notifications; optionally restrict to specific event types. |228| `tui.notifications` | `boolean | array<string>` | Enable TUI notifications; optionally restrict to specific event types. |

177| `tui.show_tooltips` | `boolean` | Show onboarding tooltips in the TUI welcome screen (default: true). |229| `tui.show_tooltips` | `boolean` | Show onboarding tooltips in the TUI welcome screen (default: true). |

178| `tui.status_line` | `array<string> | null` | Ordered list of TUI footer status-line item identifiers. `null` disables the status line. |230| `tui.status_line` | `array<string> | null` | Ordered list of TUI footer status-line item identifiers. `null` disables the status line. |

231| `tui.terminal_title` | `array<string> | null` | Ordered list of terminal window/tab title item identifiers. Defaults to `["spinner", "project"]`; `null` disables title updates. |

232| `tui.theme` | `string` | Syntax-highlighting theme override (kebab-case theme name). |

179| `web_search` | `disabled | cached | live` | Web search mode (default: `"cached"`; cached uses an OpenAI-maintained index and does not fetch live pages; if you use `--yolo` or another full access sandbox setting, it defaults to `"live"`). Use `"live"` to fetch the most recent data from the web, or `"disabled"` to remove the tool. |233| `web_search` | `disabled | cached | live` | Web search mode (default: `"cached"`; cached uses an OpenAI-maintained index and does not fetch live pages; if you use `--yolo` or another full access sandbox setting, it defaults to `"live"`). Use `"live"` to fetch the most recent data from the web, or `"disabled"` to remove the tool. |

180| `windows_wsl_setup_acknowledged` | `boolean` | Track Windows onboarding acknowledgement (Windows only). |234| `windows_wsl_setup_acknowledged` | `boolean` | Track Windows onboarding acknowledgement (Windows only). |

181| `windows.sandbox` | `unelevated | elevated` | Windows-only native sandbox mode when running Codex natively on Windows. |235| `windows.sandbox` | `unelevated | elevated` | Windows-only native sandbox mode when running Codex natively on Windows. |

236| `windows.sandbox_private_desktop` | `boolean` | Run the final sandboxed child process on a private desktop by default on native Windows. Set `false` only for compatibility with the older `Winsta0\\Default` behavior. |

182 237 

183Key238Key

184 239 

206 261 

207Key262Key

208 263 

264`agents.<name>.nickname_candidates`

265 

266Type / Values

267 

268`array<string>`

269 

270Details

271 

272Optional pool of display nicknames for spawned agents in that role.

273 

274Key

275 

209`agents.job_max_runtime_seconds`276`agents.job_max_runtime_seconds`

210 277 

211Type / Values278Type / Values

238 305 

239Details306Details

240 307 

241Maximum number of agent threads that can be open concurrently.308Maximum number of agent threads that can be open concurrently. Defaults to `6` when unset.

242 309 

243Key310Key

244 311 

254 321 

255Key322Key

256 323 

324`analytics.enabled`

325 

326Type / Values

327 

328`boolean`

329 

330Details

331 

332Enable or disable analytics for this machine/profile. When unset, the client default applies.

333 

334Key

335 

257`approval_policy`336`approval_policy`

258 337 

259Type / Values338Type / Values

260 339 

261`untrusted | on-request | never | { reject = { sandbox_approval = bool, rules = bool, mcp_elicitations = bool } }`340`untrusted | on-request | never | { granular = { sandbox_approval = bool, rules = bool, mcp_elicitations = bool, request_permissions = bool, skill_approval = bool } }`

341 

342Details

343 

344Controls when Codex pauses for approval before executing commands. You can also use `approval_policy = { granular = { ... } }` to allow or auto-reject specific prompt categories while keeping other prompts interactive. `on-failure` is deprecated; use `on-request` for interactive runs or `never` for non-interactive runs.

345 

346Key

347 

348`approval_policy.granular.mcp_elicitations`

349 

350Type / Values

351 

352`boolean`

353 

354Details

355 

356When `true`, MCP elicitation prompts are allowed to surface instead of being auto-rejected.

357 

358Key

359 

360`approval_policy.granular.request_permissions`

361 

362Type / Values

363 

364`boolean`

262 365 

263Details366Details

264 367 

265Controls when Codex pauses for approval before executing commands. You can also use `approval_policy = { reject = { ... } }` to auto-reject specific prompt categories while keeping other prompts interactive. `on-failure` is deprecated; use `on-request` for interactive runs or `never` for non-interactive runs.368When `true`, prompts from the `request_permissions` tool are allowed to surface.

266 369 

267Key370Key

268 371 

269`approval_policy.reject.mcp_elicitations`372`approval_policy.granular.rules`

270 373 

271Type / Values374Type / Values

272 375 

274 377 

275Details378Details

276 379 

277When `true`, MCP elicitation prompts are auto-rejected instead of shown to the user.380When `true`, approvals triggered by execpolicy `prompt` rules are allowed to surface.

278 381 

279Key382Key

280 383 

281`approval_policy.reject.rules`384`approval_policy.granular.sandbox_approval`

282 385 

283Type / Values386Type / Values

284 387 

286 389 

287Details390Details

288 391 

289When `true`, approvals triggered by execpolicy `prompt` rules are auto-rejected.392When `true`, sandbox escalation approval prompts are allowed to surface.

290 393 

291Key394Key

292 395 

293`approval_policy.reject.sandbox_approval`396`approval_policy.granular.skill_approval`

294 397 

295Type / Values398Type / Values

296 399 

298 401 

299Details402Details

300 403 

301When `true`, sandbox escalation approval prompts are auto-rejected.404When `true`, skill-script approval prompts are allowed to surface.

405 

406Key

407 

408`approvals_reviewer`

409 

410Type / Values

411 

412`user | guardian_subagent`

413 

414Details

415 

416Select who reviews eligible approval prompts. Defaults to `user`; `guardian_subagent` routes supported reviews through the Guardian reviewer subagent.

302 417 

303Key418Key

304 419 

470 585 

471Key586Key

472 587 

473`compact_prompt`588`commit_attribution`

474 589 

475Type / Values590Type / Values

476 591 

478 593 

479Details594Details

480 595 

481Inline override for the history compaction prompt.596Override the commit co-author trailer text. Set an empty string to disable automatic attribution.

482 597 

483Key598Key

484 599 

485`developer_instructions`600`compact_prompt`

486 601 

487Type / Values602Type / Values

488 603 

490 605 

491Details606Details

492 607 

493Additional developer instructions injected into the session (optional).608Inline override for the history compaction prompt.

494 609 

495Key610Key

496 611 

497`disable_paste_burst`612`default_permissions`

498 613 

499Type / Values614Type / Values

500 615 

501`boolean`616`string`

502 617 

503Details618Details

504 619 

505Disable burst-paste detection in the TUI.620Name of the default permissions profile to apply to sandboxed tool calls.

506 621 

507Key622Key

508 623 

509`experimental_compact_prompt_file`624`developer_instructions`

510 625 

511Type / Values626Type / Values

512 627 

513`string (path)`628`string`

514 629 

515Details630Details

516 631 

517Load the compaction prompt override from a file (experimental).632Additional developer instructions injected into the session (optional).

518 633 

519Key634Key

520 635 

521`experimental_use_freeform_apply_patch`636`disable_paste_burst`

522 637 

523Type / Values638Type / Values

524 639 

526 641 

527Details642Details

528 643 

529Legacy name for enabling freeform apply\_patch; prefer `[features].apply_patch_freeform` or `codex --enable apply_patch_freeform`.644Disable burst-paste detection in the TUI.

530 645 

531Key646Key

532 647 

533`experimental_use_unified_exec_tool`648`experimental_compact_prompt_file`

534 649 

535Type / Values650Type / Values

536 651 

537`boolean`652`string (path)`

538 653 

539Details654Details

540 655 

541Legacy name for enabling unified exec; prefer `[features].unified_exec` or `codex --enable unified_exec`.656Load the compaction prompt override from a file (experimental).

542 657 

543Key658Key

544 659 

545`features.apply_patch_freeform`660`experimental_use_unified_exec_tool`

546 661 

547Type / Values662Type / Values

548 663 

550 665 

551Details666Details

552 667 

553Expose the freeform `apply_patch` tool (experimental).668Legacy name for enabling unified exec; prefer `[features].unified_exec` or `codex --enable unified_exec`.

554 669 

555Key670Key

556 671 

566 681 

567Key682Key

568 683 

569`features.apps_mcp_gateway`684`features.codex_hooks`

570 685 

571Type / Values686Type / Values

572 687 

574 689 

575Details690Details

576 691 

577Route Apps MCP calls through the OpenAI connectors MCP gateway (`https://api.openai.com/v1/connectors/mcp/`) instead of legacy routing (experimental).692Enable lifecycle hooks loaded from `hooks.json` (under development; off by default).

578 693 

579Key694Key

580 695 

581`features.child_agents_md`696`features.enable_request_compression`

582 697 

583Type / Values698Type / Values

584 699 

586 701 

587Details702Details

588 703 

589Append AGENTS.md scope/precedence guidance even when no AGENTS.md is present (experimental).704Compress streaming request bodies with zstd when supported (stable; on by default).

590 705 

591Key706Key

592 707 

593`features.collaboration_modes`708`features.fast_mode`

594 709 

595Type / Values710Type / Values

596 711 

598 713 

599Details714Details

600 715 

601Enable collaboration modes such as plan mode (stable; on by default).716Enable Fast mode selection and the `service_tier = "fast"` path (stable; on by default).

602 717 

603Key718Key

604 719 

605`features.multi_agent`720`features.guardian_approval`

606 721 

607Type / Values722Type / Values

608 723 

610 725 

611Details726Details

612 727 

613Enable multi-agent collaboration tools (`spawn_agent`, `send_input`, `resume_agent`, `wait`, `close_agent`, and `spawn_agents_on_csv`) (experimental; off by default).728Route eligible approval requests through the guardian reviewer subagent (experimental; off by default). Use with `approvals_reviewer = "guardian_subagent"`.

614 729 

615Key730Key

616 731 

617`features.personality`732`features.memories`

618 733 

619Type / Values734Type / Values

620 735 

622 737 

623Details738Details

624 739 

625Enable personality selection controls (stable; on by default).740Enable [Memories](https://developers.openai.com/codex/memories) (off by default).

626 741 

627Key742Key

628 743 

629`features.powershell_utf8`744`features.multi_agent`

630 745 

631Type / Values746Type / Values

632 747 

634 749 

635Details750Details

636 751 

637Force PowerShell UTF-8 output (defaults to true).752Enable multi-agent collaboration tools (`spawn_agent`, `send_input`, `resume_agent`, `wait_agent`, and `close_agent`) (stable; on by default).

638 753 

639Key754Key

640 755 

641`features.remote_models`756`features.personality`

642 757 

643Type / Values758Type / Values

644 759 

646 761 

647Details762Details

648 763 

649Refresh remote model list before showing readiness (experimental).764Enable personality selection controls (stable; on by default).

650 765 

651Key766Key

652 767 

653`features.request_rule`768`features.prevent_idle_sleep`

654 769 

655Type / Values770Type / Values

656 771 

658 773 

659Details774Details

660 775 

661Enable Smart approvals (`prefix_rule` suggestions on escalation requests; stable; on by default).776Prevent the machine from sleeping while a turn is actively running (experimental; off by default).

662 777 

663Key778Key

664 779 

665`features.runtime_metrics`780`features.shell_snapshot`

666 781 

667Type / Values782Type / Values

668 783 

670 785 

671Details786Details

672 787 

673Show runtime metrics summary in TUI turn separators (experimental).788Snapshot shell environment to speed up repeated commands (stable; on by default).

674 789 

675Key790Key

676 791 

677`features.search_tool`792`features.shell_tool`

678 793 

679Type / Values794Type / Values

680 795 

682 797 

683Details798Details

684 799 

685Enable `search_tool_bm25` for Apps tool discovery before invoking app MCP tools (experimental).800Enable the default `shell` tool for running commands (stable; on by default).

686 801 

687Key802Key

688 803 

689`features.shell_snapshot`804`features.skill_mcp_dependency_install`

690 805 

691Type / Values806Type / Values

692 807 

694 809 

695Details810Details

696 811 

697Snapshot shell environment to speed up repeated commands (beta).812Allow prompting and installing missing MCP dependencies for skills (stable; on by default).

698 813 

699Key814Key

700 815 

701`features.shell_tool`816`features.undo`

702 817 

703Type / Values818Type / Values

704 819 

706 821 

707Details822Details

708 823 

709Enable the default `shell` tool for running commands (stable; on by default).824Enable undo support (stable; off by default).

710 825 

711Key826Key

712 827 

718 833 

719Details834Details

720 835 

721Use the unified PTY-backed exec tool (beta).836Use the unified PTY-backed exec tool (stable; enabled by default except on Windows).

722 

723Key

724 

725`features.use_linux_sandbox_bwrap`

726 

727Type / Values

728 

729`boolean`

730 

731Details

732 

733Use the bubblewrap-based Linux sandbox pipeline (experimental; off by default).

734 837 

735Key838Key

736 839 

854 957 

855Key958Key

856 959 

857`include_apply_patch_tool`

858 

859Type / Values

860 

861`boolean`

862 

863Details

864 

865Legacy name for enabling freeform apply\_patch; prefer `[features].apply_patch_freeform`.

866 

867Key

868 

869`instructions`960`instructions`

870 961 

871Type / Values962Type / Values

1038 1129 

1039Type / Values1130Type / Values

1040 1131 

1041`array<string>`1132`array<string | { name = string, source = "local" | "remote" }>`

1133 

1134Details

1135 

1136Additional environment variables to whitelist for an MCP stdio server. String entries default to `source = "local"`; use `source = "remote"` only with executor-backed remote stdio.

1137 

1138Key

1139 

1140`mcp_servers.<id>.experimental_environment`

1141 

1142Type / Values

1143 

1144`local | remote`

1042 1145 

1043Details1146Details

1044 1147 

1045Additional environment variables to whitelist for an MCP stdio server.1148Experimental placement for an MCP server. `remote` starts stdio servers through a remote executor environment; streamable HTTP remote placement is not implemented.

1046 1149 

1047Key1150Key

1048 1151 

1058 1161 

1059Key1162Key

1060 1163 

1164`mcp_servers.<id>.oauth_resource`

1165 

1166Type / Values

1167 

1168`string`

1169 

1170Details

1171 

1172Optional RFC 8707 OAuth resource parameter to include during MCP login.

1173 

1174Key

1175 

1061`mcp_servers.<id>.required`1176`mcp_servers.<id>.required`

1062 1177 

1063Type / Values1178Type / Values

1070 1185 

1071Key1186Key

1072 1187 

1188`mcp_servers.<id>.scopes`

1189 

1190Type / Values

1191 

1192`array<string>`

1193 

1194Details

1195 

1196OAuth scopes to request when authenticating to that MCP server.

1197 

1198Key

1199 

1073`mcp_servers.<id>.startup_timeout_ms`1200`mcp_servers.<id>.startup_timeout_ms`

1074 1201 

1075Type / Values1202Type / Values

1118 1245 

1119Key1246Key

1120 1247 

1121`model`1248`memories.consolidation_model`

1122 1249 

1123Type / Values1250Type / Values

1124 1251 

1126 1253 

1127Details1254Details

1128 1255 

1129Model to use (e.g., `gpt-5-codex`).1256Optional model override for global memory consolidation.

1130 1257 

1131Key1258Key

1132 1259 

1133`model_auto_compact_token_limit`1260`memories.disable_on_external_context`

1134 1261 

1135Type / Values1262Type / Values

1136 1263 

1137`number`1264`boolean`

1138 1265 

1139Details1266Details

1140 1267 

1141Token threshold that triggers automatic history compaction (unset uses model defaults).1268When `true`, threads that use external context such as MCP tool calls, web search, or tool search are kept out of memory generation. Defaults to `false`. Legacy alias: `memories.no_memories_if_mcp_or_web_search`.

1142 1269 

1143Key1270Key

1144 1271 

1145`model_catalog_json`1272`memories.extract_model`

1146 1273 

1147Type / Values1274Type / Values

1148 1275 

1149`string (path)`1276`string`

1150 1277 

1151Details1278Details

1152 1279 

1153Optional path to a JSON model catalog loaded on startup. Profile-level `profiles.<name>.model_catalog_json` can override this per profile.1280Optional model override for per-thread memory extraction.

1154 1281 

1155Key1282Key

1156 1283 

1157`model_context_window`1284`memories.generate_memories`

1158 1285 

1159Type / Values1286Type / Values

1160 1287 

1161`number`1288`boolean`

1162 1289 

1163Details1290Details

1164 1291 

1165Context window tokens available to the active model.1292When `false`, newly created threads are not stored as memory-generation inputs. Defaults to `true`.

1166 1293 

1167Key1294Key

1168 1295 

1169`model_instructions_file`1296`memories.max_raw_memories_for_consolidation`

1170 1297 

1171Type / Values1298Type / Values

1172 1299 

1173`string (path)`1300`number`

1174 1301 

1175Details1302Details

1176 1303 

1177Replacement for built-in instructions instead of `AGENTS.md`.1304Maximum recent raw memories retained for global consolidation. Defaults to `256` and is capped at `4096`.

1178 1305 

1179Key1306Key

1180 1307 

1181`model_provider`1308`memories.max_rollout_age_days`

1182 1309 

1183Type / Values1310Type / Values

1184 1311 

1185`string`1312`number`

1186 1313 

1187Details1314Details

1188 1315 

1189Provider id from `model_providers` (default: `openai`).1316Maximum age of threads considered for memory generation. Defaults to `30` and is clamped to `0`-`90`.

1190 1317 

1191Key1318Key

1192 1319 

1193`model_providers.<id>.base_url`1320`memories.max_rollouts_per_startup`

1194 1321 

1195Type / Values1322Type / Values

1196 1323 

1197`string`1324`number`

1198 1325 

1199Details1326Details

1200 1327 

1201API base URL for the model provider.1328Maximum rollout candidates processed per startup pass. Defaults to `16` and is capped at `128`.

1202 1329 

1203Key1330Key

1204 1331 

1205`model_providers.<id>.env_http_headers`1332`memories.max_unused_days`

1206 1333 

1207Type / Values1334Type / Values

1208 1335 

1209`map<string,string>`1336`number`

1210 1337 

1211Details1338Details

1212 1339 

1213HTTP headers populated from environment variables when present.1340Maximum days since a memory was last used before it becomes ineligible for consolidation. Defaults to `30` and is clamped to `0`-`365`.

1214 1341 

1215Key1342Key

1216 1343 

1217`model_providers.<id>.env_key`1344`memories.min_rollout_idle_hours`

1218 1345 

1219Type / Values1346Type / Values

1220 1347 

1221`string`1348`number`

1222 1349 

1223Details1350Details

1224 1351 

1225Environment variable supplying the provider API key.1352Minimum idle time before a thread is considered for memory generation. Defaults to `6` and is clamped to `1`-`48`.

1226 1353 

1227Key1354Key

1228 1355 

1229`model_providers.<id>.env_key_instructions`1356`memories.use_memories`

1230 1357 

1231Type / Values1358Type / Values

1232 1359 

1233`string`1360`boolean`

1234 1361 

1235Details1362Details

1236 1363 

1237Optional setup guidance for the provider API key.1364When `false`, Codex skips injecting existing memories into future sessions. Defaults to `true`.

1238 1365 

1239Key1366Key

1240 1367 

1241`model_providers.<id>.experimental_bearer_token`1368`model`

1242 1369 

1243Type / Values1370Type / Values

1244 1371 

1246 1373 

1247Details1374Details

1248 1375 

1249Direct bearer token for the provider (discouraged; use `env_key`).1376Model to use (e.g., `gpt-5.4`).

1250 1377 

1251Key1378Key

1252 1379 

1253`model_providers.<id>.http_headers`1380`model_auto_compact_token_limit`

1254 1381 

1255Type / Values1382Type / Values

1256 1383 

1257`map<string,string>`1384`number`

1258 1385 

1259Details1386Details

1260 1387 

1261Static HTTP headers added to provider requests.1388Token threshold that triggers automatic history compaction (unset uses model defaults).

1262 1389 

1263Key1390Key

1264 1391 

1265`model_providers.<id>.name`1392`model_catalog_json`

1266 1393 

1267Type / Values1394Type / Values

1268 1395 

1269`string`1396`string (path)`

1270 1397 

1271Details1398Details

1272 1399 

1273Display name for a custom model provider.1400Optional path to a JSON model catalog loaded on startup. Profile-level `profiles.<name>.model_catalog_json` can override this per profile.

1274 1401 

1275Key1402Key

1276 1403 

1277`model_providers.<id>.query_params`1404`model_context_window`

1278 1405 

1279Type / Values1406Type / Values

1280 1407 

1281`map<string,string>`1408`number`

1282 1409 

1283Details1410Details

1284 1411 

1285Extra query parameters appended to provider requests.1412Context window tokens available to the active model.

1286 1413 

1287Key1414Key

1288 1415 

1289`model_providers.<id>.request_max_retries`1416`model_instructions_file`

1290 1417 

1291Type / Values1418Type / Values

1292 1419 

1293`number`1420`string (path)`

1294 1421 

1295Details1422Details

1296 1423 

1297Retry count for HTTP requests to the provider (default: 4).1424Replacement for built-in instructions instead of `AGENTS.md`.

1298 1425 

1299Key1426Key

1300 1427 

1301`model_providers.<id>.requires_openai_auth`1428`model_provider`

1302 1429 

1303Type / Values1430Type / Values

1304 1431 

1305`boolean`1432`string`

1306 1433 

1307Details1434Details

1308 1435 

1309The provider uses OpenAI authentication (defaults to false).1436Provider id from `model_providers` (default: `openai`).

1310 1437 

1311Key1438Key

1312 1439 

1313`model_providers.<id>.stream_idle_timeout_ms`1440`model_providers.<id>`

1314 1441 

1315Type / Values1442Type / Values

1316 1443 

1317`number`1444`table`

1318 1445 

1319Details1446Details

1320 1447 

1321Idle timeout for SSE streams in milliseconds (default: 300000).1448Custom provider definition. Built-in provider IDs (`openai`, `ollama`, and `lmstudio`) are reserved and cannot be overridden.

1322 1449 

1323Key1450Key

1324 1451 

1325`model_providers.<id>.stream_max_retries`1452`model_providers.<id>.auth`

1326 1453 

1327Type / Values1454Type / Values

1328 1455 

1329`number`1456`table`

1330 1457 

1331Details1458Details

1332 1459 

1333Retry count for SSE streaming interruptions (default: 5).1460Command-backed bearer token configuration for a custom provider. Do not combine with `env_key`, `experimental_bearer_token`, or `requires_openai_auth`.

1334 1461 

1335Key1462Key

1336 1463 

1337`model_providers.<id>.wire_api`1464`model_providers.<id>.auth.args`

1338 1465 

1339Type / Values1466Type / Values

1340 1467 

1341`chat | responses`1468`array<string>`

1342 1469 

1343Details1470Details

1344 1471 

1345Protocol used by the provider (defaults to `chat` if omitted).1472Arguments passed to the token command.

1346 1473 

1347Key1474Key

1348 1475 

1349`model_reasoning_effort`1476`model_providers.<id>.auth.command`

1350 1477 

1351Type / Values1478Type / Values

1352 1479 

1353`minimal | low | medium | high | xhigh`1480`string`

1354 1481 

1355Details1482Details

1356 1483 

1357Adjust reasoning effort for supported models (Responses API only; `xhigh` is model-dependent).1484Command to run when Codex needs a bearer token. The command must print the token to stdout.

1358 1485 

1359Key1486Key

1360 1487 

1361`model_reasoning_summary`1488`model_providers.<id>.auth.cwd`

1362 1489 

1363Type / Values1490Type / Values

1364 1491 

1365`auto | concise | detailed | none`1492`string (path)`

1366 1493 

1367Details1494Details

1368 1495 

1369Select reasoning summary detail or disable summaries entirely.1496Working directory for the token command.

1370 1497 

1371Key1498Key

1372 1499 

1373`model_supports_reasoning_summaries`1500`model_providers.<id>.auth.refresh_interval_ms`

1374 1501 

1375Type / Values1502Type / Values

1376 1503 

1377`boolean`1504`number`

1378 1505 

1379Details1506Details

1380 1507 

1381Force Codex to send or not send reasoning metadata.1508How often Codex proactively refreshes the token in milliseconds (default: 300000). Set to `0` to refresh only after an authentication retry.

1382 1509 

1383Key1510Key

1384 1511 

1385`model_verbosity`1512`model_providers.<id>.auth.timeout_ms`

1386 1513 

1387Type / Values1514Type / Values

1388 1515 

1389`low | medium | high`1516`number`

1390 1517 

1391Details1518Details

1392 1519 

1393Control GPT-5 Responses API verbosity (defaults to `medium`).1520Maximum token command runtime in milliseconds (default: 5000).

1394 1521 

1395Key1522Key

1396 1523 

1397`notice.hide_full_access_warning`1524`model_providers.<id>.base_url`

1398 1525 

1399Type / Values1526Type / Values

1400 1527 

1401`boolean`1528`string`

1402 1529 

1403Details1530Details

1404 1531 

1405Track acknowledgement of the full access warning prompt.1532API base URL for the model provider.

1406 1533 

1407Key1534Key

1408 1535 

1409`notice.hide_gpt-5.1-codex-max_migration_prompt`1536`model_providers.<id>.env_http_headers`

1410 1537 

1411Type / Values1538Type / Values

1412 1539 

1413`boolean`1540`map<string,string>`

1414 1541 

1415Details1542Details

1416 1543 

1417Track acknowledgement of the gpt-5.1-codex-max migration prompt.1544HTTP headers populated from environment variables when present.

1418 1545 

1419Key1546Key

1420 1547 

1421`notice.hide_gpt5_1_migration_prompt`1548`model_providers.<id>.env_key`

1422 1549 

1423Type / Values1550Type / Values

1424 1551 

1425`boolean`1552`string`

1426 1553 

1427Details1554Details

1428 1555 

1429Track acknowledgement of the GPT-5.1 migration prompt.1556Environment variable supplying the provider API key.

1430 1557 

1431Key1558Key

1432 1559 

1433`notice.hide_rate_limit_model_nudge`1560`model_providers.<id>.env_key_instructions`

1434 1561 

1435Type / Values1562Type / Values

1436 1563 

1437`boolean`1564`string`

1438 1565 

1439Details1566Details

1440 1567 

1441Track opt-out of the rate limit model switch reminder.1568Optional setup guidance for the provider API key.

1569 

1570Key

1571 

1572`model_providers.<id>.experimental_bearer_token`

1573 

1574Type / Values

1575 

1576`string`

1577 

1578Details

1579 

1580Direct bearer token for the provider (discouraged; use `env_key`).

1581 

1582Key

1583 

1584`model_providers.<id>.http_headers`

1585 

1586Type / Values

1587 

1588`map<string,string>`

1589 

1590Details

1591 

1592Static HTTP headers added to provider requests.

1593 

1594Key

1595 

1596`model_providers.<id>.name`

1597 

1598Type / Values

1599 

1600`string`

1601 

1602Details

1603 

1604Display name for a custom model provider.

1605 

1606Key

1607 

1608`model_providers.<id>.query_params`

1609 

1610Type / Values

1611 

1612`map<string,string>`

1613 

1614Details

1615 

1616Extra query parameters appended to provider requests.

1617 

1618Key

1619 

1620`model_providers.<id>.request_max_retries`

1621 

1622Type / Values

1623 

1624`number`

1625 

1626Details

1627 

1628Retry count for HTTP requests to the provider (default: 4).

1629 

1630Key

1631 

1632`model_providers.<id>.requires_openai_auth`

1633 

1634Type / Values

1635 

1636`boolean`

1637 

1638Details

1639 

1640The provider uses OpenAI authentication (defaults to false).

1641 

1642Key

1643 

1644`model_providers.<id>.stream_idle_timeout_ms`

1645 

1646Type / Values

1647 

1648`number`

1649 

1650Details

1651 

1652Idle timeout for SSE streams in milliseconds (default: 300000).

1653 

1654Key

1655 

1656`model_providers.<id>.stream_max_retries`

1657 

1658Type / Values

1659 

1660`number`

1661 

1662Details

1663 

1664Retry count for SSE streaming interruptions (default: 5).

1665 

1666Key

1667 

1668`model_providers.<id>.supports_websockets`

1669 

1670Type / Values

1671 

1672`boolean`

1673 

1674Details

1675 

1676Whether that provider supports the Responses API WebSocket transport.

1677 

1678Key

1679 

1680`model_providers.<id>.wire_api`

1681 

1682Type / Values

1683 

1684`responses`

1685 

1686Details

1687 

1688Protocol used by the provider. `responses` is the only supported value, and it is the default when omitted.

1689 

1690Key

1691 

1692`model_reasoning_effort`

1693 

1694Type / Values

1695 

1696`minimal | low | medium | high | xhigh`

1697 

1698Details

1699 

1700Adjust reasoning effort for supported models (Responses API only; `xhigh` is model-dependent).

1701 

1702Key

1703 

1704`model_reasoning_summary`

1705 

1706Type / Values

1707