config-reference.md Codex Docs, 2026-04-18 18:18 UTC → 2026-05-11 18:00 UTC

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/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).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<ConfigTable

12| --- | --- | --- |12 options={[

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 {

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

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

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 description: "Model to use (e.g., `gpt-5.5`).",

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

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

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 key: "review_model",

20| `analytics.enabled` | `boolean` | Enable or disable analytics for this machine/profile. When unset, the client default applies. |20 type: "string",

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 description:

22| `approval_policy.granular.mcp_elicitations` | `boolean` | When `true`, MCP elicitation prompts are allowed to surface instead of being auto-rejected. |22 "Optional model override used by `/review` (defaults to the current session model).",

23| `approval_policy.granular.request_permissions` | `boolean` | When `true`, prompts from the `request_permissions` tool are allowed to surface. |23 },

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

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

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

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. |27 description: "Provider id from `model_providers` (default: `openai`).",

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

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

30| `apps._default.open_world_enabled` | `boolean` | Default allow/deny for app tools with `open_world_hint = true`. |30 key: "openai_base_url",

31| `apps.<id>.default_tools_approval_mode` | `auto | prompt | approve` | Default approval behavior for tools in this app unless a per-tool override exists. |31 type: "string",

32| `apps.<id>.default_tools_enabled` | `boolean` | Default enabled state for tools in this app unless a per-tool override exists. |32 description:

33| `apps.<id>.destructive_enabled` | `boolean` | Allow or block tools in this app that advertise `destructive_hint = true`. |33 "Base URL override for the built-in `openai` model provider.",

34| `apps.<id>.enabled` | `boolean` | Enable or disable a specific app/connector by id (default: true). |34 },

35| `apps.<id>.open_world_enabled` | `boolean` | Allow or block tools in this app that advertise `open_world_hint = true`. |35 {

36| `apps.<id>.tools.<tool>.approval_mode` | `auto | prompt | approve` | Per-tool approval behavior override for a single app tool. |36 key: "model_context_window",

37| `apps.<id>.tools.<tool>.enabled` | `boolean` | Per-tool enabled override for an app tool (for example `repos/list`). |37 type: "number",

38| `background_terminal_max_timeout` | `number` | Maximum poll window in milliseconds for empty `write_stdin` polls (background terminal polling). Default: `300000` (5 minutes). Replaces the older `background_terminal_timeout` key. |38 description: "Context window tokens available to the active model.",

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

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

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

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

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

44| `default_permissions` | `string` | Name of the default permissions profile to apply to sandboxed tool calls. |44 "Token threshold that triggers automatic history compaction (unset uses model defaults).",

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

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

47| `experimental_compact_prompt_file` | `string (path)` | Load the compaction prompt override from a file (experimental). |47 key: "model_catalog_json",

48| `experimental_use_unified_exec_tool` | `boolean` | Legacy name for enabling unified exec; prefer `[features].unified_exec` or `codex --enable unified_exec`. |48 type: "string (path)",

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

50| `features.codex_hooks` | `boolean` | Enable lifecycle hooks loaded from `hooks.json` (under development; off by default). |50 "Optional path to a JSON model catalog loaded on startup. Profile-level `profiles.<name>.model_catalog_json` can override this per profile.",

51| `features.enable_request_compression` | `boolean` | Compress streaming request bodies with zstd when supported (stable; on by default). |51 },

52| `features.fast_mode` | `boolean` | Enable Fast mode selection and the `service_tier = "fast"` path (stable; on by default). |52 {

53| `features.guardian_approval` | `boolean` | Route eligible approval requests through the guardian reviewer subagent (experimental; off by default). Use with `approvals_reviewer = "guardian_subagent"`. |53 key: "oss_provider",

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

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). |55 description:

56| `features.personality` | `boolean` | Enable personality selection controls (stable; on by default). |56 "Default local provider used when running with `--oss` (defaults to prompting if unset).",

57| `features.prevent_idle_sleep` | `boolean` | Prevent the machine from sleeping while a turn is actively running (experimental; off by default). |57 },

58| `features.shell_snapshot` | `boolean` | Snapshot shell environment to speed up repeated commands (stable; on by default). |58 {

59| `features.shell_tool` | `boolean` | Enable the default `shell` tool for running commands (stable; on by default). |59 key: "approval_policy",

60| `features.skill_mcp_dependency_install` | `boolean` | Allow prompting and installing missing MCP dependencies for skills (stable; on by default). |60 type: "untrusted | on-request | never | { granular = { sandbox_approval = bool, rules = bool, mcp_elicitations = bool, request_permissions = bool, skill_approval = bool } }",

61| `features.undo` | `boolean` | Enable undo support (stable; off by default). |61 description:

62| `features.unified_exec` | `boolean` | Use the unified PTY-backed exec tool (stable; enabled by default except on Windows). |62 "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.",

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

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

65| `features.web_search_request` | `boolean` | Deprecated legacy toggle. When `web_search` is unset, true maps to `web_search = "live"`. |65 key: "approval_policy.granular.sandbox_approval",

66| `feedback.enabled` | `boolean` | Enable feedback submission via `/feedback` across Codex surfaces (default: true). |66 type: "boolean",

67| `file_opener` | `vscode | vscode-insiders | windsurf | cursor | none` | URI scheme used to open citations from Codex output (default: `vscode`). |67 description:

68| `forced_chatgpt_workspace_id` | `string (uuid)` | Limit ChatGPT logins to a specific workspace identifier. |68 "When `true`, sandbox escalation approval prompts are allowed to surface.",

69| `forced_login_method` | `chatgpt | api` | Restrict Codex to a specific authentication method. |69 },

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

71| `history.max_bytes` | `number` | If set, caps the history file size in bytes by dropping oldest entries. |71 key: "approval_policy.granular.rules",

72| `history.persistence` | `save-all | none` | Control whether Codex saves session transcripts to history.jsonl. |72 type: "boolean",

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

74| `log_dir` | `string (path)` | Directory where Codex writes log files (for example `codex-tui.log`); defaults to `$CODEX_HOME/log`. |74 "When `true`, approvals triggered by execpolicy `prompt` rules are allowed to surface.",

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. |75 },

76| `mcp_oauth_callback_url` | `string` | Optional redirect URI override for MCP OAuth login (for example, a devbox ingress URL). `mcp_oauth_callback_port` still controls the callback listener port. |76 {

77| `mcp_oauth_credentials_store` | `auto | file | keyring` | Preferred store for MCP OAuth credentials. |77 key: "approval_policy.granular.mcp_elicitations",

78| `mcp_servers.<id>.args` | `array<string>` | Arguments passed to the MCP stdio server command. |78 type: "boolean",

79| `mcp_servers.<id>.bearer_token_env_var` | `string` | Environment variable sourcing the bearer token for an MCP HTTP server. |79 description:

80| `mcp_servers.<id>.command` | `string` | Launcher command for an MCP stdio server. |80 "When `true`, MCP elicitation prompts are allowed to surface instead of being auto-rejected.",

81| `mcp_servers.<id>.cwd` | `string` | Working directory for the MCP stdio server process. |81 },

82| `mcp_servers.<id>.disabled_tools` | `array<string>` | Deny list applied after `enabled_tools` for the MCP server. |82 {

83| `mcp_servers.<id>.enabled` | `boolean` | Disable an MCP server without removing its configuration. |83 key: "approval_policy.granular.request_permissions",

84| `mcp_servers.<id>.enabled_tools` | `array<string>` | Allow list of tool names exposed by the MCP server. |84 type: "boolean",

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

86| `mcp_servers.<id>.env_http_headers` | `map<string,string>` | HTTP headers populated from environment variables for an MCP HTTP server. |86 "When `true`, prompts from the `request_permissions` tool are allowed to surface.",

87| `mcp_servers.<id>.env_vars` | `array<string>` | Additional environment variables to whitelist for an MCP stdio server. |87 },

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

89| `mcp_servers.<id>.oauth_resource` | `string` | Optional RFC 8707 OAuth resource parameter to include during MCP login. |89 key: "approval_policy.granular.skill_approval",

90| `mcp_servers.<id>.required` | `boolean` | When true, fail startup/resume if this enabled MCP server cannot initialize. |90 type: "boolean",

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

92| `mcp_servers.<id>.startup_timeout_ms` | `number` | Alias for `startup_timeout_sec` in milliseconds. |92 "When `true`, skill-script approval prompts are allowed to surface.",

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

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

95| `mcp_servers.<id>.url` | `string` | Endpoint for an MCP streamable HTTP server. |95 key: "approvals_reviewer",

96| `memories.consolidation_model` | `string` | Optional model override for global memory consolidation. |96 type: "user | auto_review",

97| `memories.extract_model` | `string` | Optional model override for per-thread memory extraction. |97 description:

98| `memories.generate_memories` | `boolean` | When `false`, newly created threads are not stored as memory-generation inputs. Defaults to `true`. |98 "Who reviews eligible approval prompts under `on-request` or granular approval policies. Defaults to `user`; `auto_review` uses the reviewer subagent. This setting doesn't change sandboxing or review actions already allowed inside the sandbox.",

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

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

101| `memories.max_rollouts_per_startup` | `number` | Maximum rollout candidates processed per startup pass. Defaults to `16` and is capped at `128`. |101 key: "auto_review.policy",

102| `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`. |102 type: "string",

103| `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`. |103 description:

104| `memories.no_memories_if_mcp_or_web_search` | `boolean` | When `true`, threads that use MCP tool calls or web search are kept out of memory generation. Defaults to `false`. |104 "Local Markdown policy instructions for automatic review. Managed `guardian_policy_config` takes precedence. Blank values are ignored.",

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

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

107| `model_auto_compact_token_limit` | `number` | Token threshold that triggers automatic history compaction (unset uses model defaults). |107 key: "allow_login_shell",

108| `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. |108 type: "boolean",

109| `model_context_window` | `number` | Context window tokens available to the active model. |109 description:

110| `model_instructions_file` | `string (path)` | Replacement for built-in instructions instead of `AGENTS.md`. |110 "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.",

111| `model_provider` | `string` | Provider id from `model_providers` (default: `openai`). |111 },

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

113| `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`. |113 key: "sandbox_mode",

114| `model_providers.<id>.auth.args` | `array<string>` | Arguments passed to the token command. |114 type: "read-only | workspace-write | danger-full-access",

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

116| `model_providers.<id>.auth.cwd` | `string (path)` | Working directory for the token command. |116 "Sandbox policy for filesystem and network access during command execution.",

117| `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. |117 },

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

119| `model_providers.<id>.base_url` | `string` | API base URL for the model provider. |119 key: "sandbox_workspace_write.writable_roots",

120| `model_providers.<id>.env_http_headers` | `map<string,string>` | HTTP headers populated from environment variables when present. |120 type: "array<string>",

121| `model_providers.<id>.env_key` | `string` | Environment variable supplying the provider API key. |121 description:

122| `model_providers.<id>.env_key_instructions` | `string` | Optional setup guidance for the provider API key. |122 'Additional writable roots when `sandbox_mode = "workspace-write"`.',

123| `model_providers.<id>.experimental_bearer_token` | `string` | Direct bearer token for the provider (discouraged; use `env_key`). |123 },

124| `model_providers.<id>.http_headers` | `map<string,string>` | Static HTTP headers added to provider requests. |124 {

125| `model_providers.<id>.name` | `string` | Display name for a custom model provider. |125 key: "sandbox_workspace_write.network_access",

126| `model_providers.<id>.query_params` | `map<string,string>` | Extra query parameters appended to provider requests. |126 type: "boolean",

127| `model_providers.<id>.request_max_retries` | `number` | Retry count for HTTP requests to the provider (default: 4). |127 description:

128| `model_providers.<id>.requires_openai_auth` | `boolean` | The provider uses OpenAI authentication (defaults to false). |128 "Allow outbound network access inside the workspace-write sandbox.",

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

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

131| `model_providers.<id>.supports_websockets` | `boolean` | Whether that provider supports the Responses API WebSocket transport. |131 key: "sandbox_workspace_write.exclude_tmpdir_env_var",

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

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

134| `model_reasoning_summary` | `auto | concise | detailed | none` | Select reasoning summary detail or disable summaries entirely. |134 "Exclude `$TMPDIR` from writable roots in workspace-write mode.",

135| `model_supports_reasoning_summaries` | `boolean` | Force Codex to send or not send reasoning metadata. |135 },

136| `model_verbosity` | `low | medium | high` | Optional GPT-5 Responses API verbosity override; when unset, the selected model/preset default is used. |136 {

137| `notice.hide_full_access_warning` | `boolean` | Track acknowledgement of the full access warning prompt. |137 key: "sandbox_workspace_write.exclude_slash_tmp",

138| `notice.hide_gpt-5.1-codex-max_migration_prompt` | `boolean` | Track acknowledgement of the gpt-5.1-codex-max migration prompt. |138 type: "boolean",

139| `notice.hide_gpt5_1_migration_prompt` | `boolean` | Track acknowledgement of the GPT-5.1 migration prompt. |139 description:

140| `notice.hide_rate_limit_model_nudge` | `boolean` | Track opt-out of the rate limit model switch reminder. |140 "Exclude `/tmp` from writable roots in workspace-write mode.",

141| `notice.hide_world_writable_warning` | `boolean` | Track acknowledgement of the Windows world-writable directories warning. |141 },

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

143| `notify` | `array<string>` | Command invoked for notifications; receives a JSON payload from Codex. |143 key: "windows.sandbox",

144| `openai_base_url` | `string` | Base URL override for the built-in `openai` model provider. |144 type: "unelevated | elevated",

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

146| `otel.environment` | `string` | Environment tag applied to emitted OpenTelemetry events (default: `dev`). |146 "Windows-only native sandbox mode when running Codex natively on Windows.",

147| `otel.exporter` | `none | otlp-http | otlp-grpc` | Select the OpenTelemetry exporter and provide any endpoint metadata. |147 },

148| `otel.exporter.<id>.endpoint` | `string` | Exporter endpoint for OTEL logs. |148 {

149| `otel.exporter.<id>.headers` | `map<string,string>` | Static headers included with OTEL exporter requests. |149 key: "windows.sandbox_private_desktop",

150| `otel.exporter.<id>.protocol` | `binary | json` | Protocol used by the OTLP/HTTP exporter. |150 type: "boolean",

151| `otel.exporter.<id>.tls.ca-certificate` | `string` | CA certificate path for OTEL exporter TLS. |151 description:

152| `otel.exporter.<id>.tls.client-certificate` | `string` | Client certificate path for OTEL exporter TLS. |152 "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.",

153| `otel.exporter.<id>.tls.client-private-key` | `string` | Client private key path for OTEL exporter TLS. |153 },

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

155| `otel.metrics_exporter` | `none | statsig | otlp-http | otlp-grpc` | Select the OpenTelemetry metrics exporter (defaults to `statsig`). |155 key: "notify",

156| `otel.trace_exporter` | `none | otlp-http | otlp-grpc` | Select the OpenTelemetry trace exporter and provide any endpoint metadata. |156 type: "array<string>",

157| `otel.trace_exporter.<id>.endpoint` | `string` | Trace exporter endpoint for OTEL logs. |157 description:

158| `otel.trace_exporter.<id>.headers` | `map<string,string>` | Static headers included with OTEL trace exporter requests. |158 "Command invoked for notifications; receives a JSON payload from Codex.",

159| `otel.trace_exporter.<id>.protocol` | `binary | json` | Protocol used by the OTLP/HTTP trace exporter. |159 },

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

161| `otel.trace_exporter.<id>.tls.client-certificate` | `string` | Client certificate path for OTEL trace exporter TLS. |161 key: "check_for_update_on_startup",

162| `otel.trace_exporter.<id>.tls.client-private-key` | `string` | Client private key path for OTEL trace exporter TLS. |162 type: "boolean",

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

164| `permissions.<name>.filesystem.":project_roots".<subpath>` | `"read" | "write" | "none"` | Scoped filesystem access relative to the detected project roots. Use `"."` for the root itself. |164 "Check for Codex updates on startup (set to false only when updates are centrally managed).",

165| `permissions.<name>.filesystem.<path>` | `"read" | "write" | "none" | table` | Grant direct access for a path or special token, or scope nested entries under that root. |165 },

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

167| `permissions.<name>.network.allow_upstream_proxy` | `boolean` | Allow the managed proxy to chain to another upstream proxy. |167 key: "feedback.enabled",

168| `permissions.<name>.network.dangerously_allow_all_unix_sockets` | `boolean` | Allow the proxy to use arbitrary Unix sockets instead of the default restricted set. |168 type: "boolean",

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

170| `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. |170 "Enable feedback submission via `/feedback` across Codex surfaces (default: true).",

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

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

173| `permissions.<name>.network.enabled` | `boolean` | Enable network access for this named permissions profile. |173 key: "analytics.enabled",

174| `permissions.<name>.network.mode` | `limited | full` | Network proxy mode used for subprocess traffic. |174 type: "boolean",

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

176| `permissions.<name>.network.socks_url` | `string` | SOCKS5 proxy endpoint used by this permissions profile. |176 "Enable or disable analytics for this machine/profile. When unset, the client default applies.",

177| `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. |177 },

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

179| `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. |179 key: "instructions",

180| `profile` | `string` | Default profile applied at startup (equivalent to `--profile`). |180 type: "string",

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

182| `profiles.<name>.analytics.enabled` | `boolean` | Profile-scoped analytics enablement override. |182 "Reserved for future use; prefer `model_instructions_file` or `AGENTS.md`.",

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

184| `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). |184 {

185| `profiles.<name>.model_instructions_file` | `string (path)` | Profile-scoped replacement for the built-in instruction file. |185 key: "developer_instructions",

186| `profiles.<name>.oss_provider` | `lmstudio | ollama` | Profile-scoped OSS provider for `--oss` sessions. |186 type: "string",

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

188| `profiles.<name>.plan_mode_reasoning_effort` | `none | minimal | low | medium | high | xhigh` | Profile-scoped Plan-mode reasoning override. |188 "Additional developer instructions injected into the session (optional).",

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

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

191| `profiles.<name>.web_search` | `disabled | cached | live` | Profile-scoped web search mode override (default: `"cached"`). |191 key: "log_dir",

192| `profiles.<name>.windows.sandbox` | `unelevated | elevated` | Profile-scoped Windows sandbox mode override. |192 type: "string (path)",

193| `project_doc_fallback_filenames` | `array<string>` | Additional filenames to try when `AGENTS.md` is missing. |193 description:

194| `project_doc_max_bytes` | `number` | Maximum bytes read from `AGENTS.md` when building project instructions. |194 "Directory where Codex writes log files (for example `codex-tui.log`); defaults to `$CODEX_HOME/log`.",

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

196| `projects.<path>.trust_level` | `string` | Mark a project or worktree as trusted or untrusted (`"trusted"` | `"untrusted"`). Untrusted projects skip project-scoped `.codex/` layers. |196 {

197| `review_model` | `string` | Optional model override used by `/review` (defaults to the current session model). |197 key: "sqlite_home",

198| `sandbox_mode` | `read-only | workspace-write | danger-full-access` | Sandbox policy for filesystem and network access during command execution. |198 type: "string (path)",

199| `sandbox_workspace_write.exclude_slash_tmp` | `boolean` | Exclude `/tmp` from writable roots in workspace-write mode. |199 description:

200| `sandbox_workspace_write.exclude_tmpdir_env_var` | `boolean` | Exclude `$TMPDIR` from writable roots in workspace-write mode. |200 "Directory where Codex stores the SQLite-backed state DB used by agent jobs and other resumable runtime state.",

201| `sandbox_workspace_write.network_access` | `boolean` | Allow outbound network access inside the workspace-write sandbox. |201 },

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

203| `service_tier` | `flex | fast` | Preferred service tier for new turns. |203 key: "compact_prompt",

204| `shell_environment_policy.exclude` | `array<string>` | Glob patterns for removing environment variables after the defaults. |204 type: "string",

205| `shell_environment_policy.experimental_use_profile` | `boolean` | Use the user shell profile when spawning subprocesses. |205 description: "Inline override for the history compaction prompt.",

206| `shell_environment_policy.ignore_default_excludes` | `boolean` | Keep variables containing KEY/SECRET/TOKEN before other filters run. |206 },

207| `shell_environment_policy.include_only` | `array<string>` | Whitelist of patterns; when set only matching variables are kept. |207 {

208| `shell_environment_policy.inherit` | `all | core | none` | Baseline environment inheritance when spawning subprocesses. |208 key: "commit_attribution",

209| `shell_environment_policy.set` | `map<string,string>` | Explicit environment overrides injected into every subprocess. |209 type: "string",

210| `show_raw_agent_reasoning` | `boolean` | Surface raw reasoning content when the active model emits it. |210 description:

211| `skills.config` | `array<object>` | Per-skill enablement overrides stored in config.toml. |211 'Commit co-author trailer used when `[features].codex_git_commit` is enabled. Defaults to `Codex <noreply@openai.com>`; set `""` to disable.',

212| `skills.config.<index>.enabled` | `boolean` | Enable or disable the referenced skill. |212 },

213| `skills.config.<index>.path` | `string (path)` | Path to a skill folder containing `SKILL.md`. |213 {

214| `sqlite_home` | `string (path)` | Directory where Codex stores the SQLite-backed state DB used by agent jobs and other resumable runtime state. |214 key: "model_instructions_file",

215| `suppress_unstable_features_warning` | `boolean` | Suppress the warning that appears when under-development feature flags are enabled. |215 type: "string (path)",

216| `tool_output_token_limit` | `number` | Token budget for storing individual tool/function outputs in history. |216 description:

217| `tool_suggest.discoverables` | `array<table>` | Allow tool suggestions for additional discoverable connectors or plugins. Each entry uses `type = "connector"` or `"plugin"` and an `id`. |217 "Replacement for built-in instructions instead of `AGENTS.md`.",

218| `tools.view_image` | `boolean` | Enable the local-image attachment tool `view_image`. |218 },

219| `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. |219 {

220| `tui` | `table` | TUI-specific options such as enabling inline desktop notifications. |220 key: "personality",

221| `tui.alternate_screen` | `auto | always | never` | Control alternate screen usage for the TUI (default: auto; auto skips it in Zellij to preserve scrollback). |221 type: "none | friendly | pragmatic",

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

223| `tui.model_availability_nux.<model>` | `integer` | Internal startup-tooltip state keyed by model slug. |223 "Default communication style for models that advertise `supportsPersonality`; can be overridden per thread/turn or via `/personality`.",

224| `tui.notification_method` | `auto | osc9 | bel` | Notification method for unfocused terminal notifications (default: auto). |224 },

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

226| `tui.show_tooltips` | `boolean` | Show onboarding tooltips in the TUI welcome screen (default: true). |226 key: "service_tier",

227| `tui.status_line` | `array<string> | null` | Ordered list of TUI footer status-line item identifiers. `null` disables the status line. |227 type: "flex | fast",

228| `tui.terminal_title` | `array<string> | null` | Ordered list of terminal window/tab title item identifiers. Defaults to `["spinner", "project"]`; `null` disables title updates. |228 description: "Preferred service tier for new turns.",

229| `tui.theme` | `string` | Syntax-highlighting theme override (kebab-case theme name). |229 },

230| `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. |230 {

231| `windows_wsl_setup_acknowledged` | `boolean` | Track Windows onboarding acknowledgement (Windows only). |231 key: "experimental_compact_prompt_file",

232| `windows.sandbox` | `unelevated | elevated` | Windows-only native sandbox mode when running Codex natively on Windows. |232 type: "string (path)",

233| `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. |233 description:

234 234 "Load the compaction prompt override from a file (experimental).",

235Key235 },

236 236 {

237`agents.<name>.config_file`237 key: "skills.config",

238 238 type: "array<object>",

239Type / Values239 description: "Per-skill enablement overrides stored in config.toml.",

240 240 },

241`string (path)`241 {

242 242 key: "skills.config.<index>.path",

243Details243 type: "string (path)",

244 244 description: "Path to a skill folder containing `SKILL.md`.",

245Path to a TOML config layer for that role; relative paths resolve from the config file that declares the role.245 },

246 246 {

247Key247 key: "skills.config.<index>.enabled",

248 248 type: "boolean",

249`agents.<name>.description`249 description: "Enable or disable the referenced skill.",

250 250 },

251Type / Values251 {

252 252 key: "apps.<id>.enabled",

253`string`253 type: "boolean",

254 254 description:

255Details255 "Enable or disable a specific app/connector by id (default: true).",

256 256 },

257Role guidance shown to Codex when choosing and spawning that agent type.257 {

258 258 key: "apps._default.enabled",

259Key259 type: "boolean",

260 260 description:

261`agents.<name>.nickname_candidates`261 "Default app enabled state for all apps unless overridden per app.",

262 262 },

263Type / Values263 {

264 264 key: "apps._default.destructive_enabled",

265`array<string>`265 type: "boolean",

266 266 description:

267Details267 "Default allow/deny for app tools with `destructive_hint = true`.",

268 268 },

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

270 270 key: "apps._default.open_world_enabled",

271Key271 type: "boolean",

272 272 description:

273`agents.job_max_runtime_seconds`273 "Default allow/deny for app tools with `open_world_hint = true`.",

274 274 },

275Type / Values275 {

276 276 key: "apps.<id>.destructive_enabled",

277`number`277 type: "boolean",

278 278 description:

279Details279 "Allow or block tools in this app that advertise `destructive_hint = true`.",

280 280 },

281Default per-worker timeout for `spawn_agents_on_csv` jobs. When unset, the tool falls back to 1800 seconds per worker.281 {

282 282 key: "apps.<id>.open_world_enabled",

283Key283 type: "boolean",

284 284 description:

285`agents.max_depth`285 "Allow or block tools in this app that advertise `open_world_hint = true`.",

286 286 },

287Type / Values287 {

288 288 key: "apps.<id>.default_tools_enabled",

289`number`289 type: "boolean",

290 290 description:

291Details291 "Default enabled state for tools in this app unless a per-tool override exists.",

292 292 },

293Maximum nesting depth allowed for spawned agent threads (root sessions start at depth 0; default: 1).293 {

294 294 key: "apps.<id>.default_tools_approval_mode",

295Key295 type: "auto | prompt | approve",

296 296 description:

297`agents.max_threads`297 "Default approval behavior for tools in this app unless a per-tool override exists.",

298 298 },

299Type / Values299 {

300 300 key: "apps.<id>.tools.<tool>.enabled",

301`number`301 type: "boolean",

302 302 description:

303Details303 "Per-tool enabled override for an app tool (for example `repos/list`).",

304 304 },

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

306 306 key: "apps.<id>.tools.<tool>.approval_mode",

307Key307 type: "auto | prompt | approve",

308 308 description: "Per-tool approval behavior override for a single app tool.",

309`allow_login_shell`309 },

310 310 {

311Type / Values311 key: "tool_suggest.discoverables",

312 312 type: "array<table>",

313`boolean`313 description:

314 314 'Allow tool suggestions for additional discoverable connectors or plugins. Each entry uses `type = "connector"` or `"plugin"` and an `id`.',

315Details315 },

316 316 {

317Allow 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.317 key: "tool_suggest.disabled_tools",

318 318 type: "array<table>",

319Key319 description:

320 320 'Disable suggestions for specific discoverable connectors or plugins. Each entry uses `type = "connector"` or `"plugin"` and an `id`.',

321`analytics.enabled`321 },

322 322 {

323Type / Values323 key: "features.apps",

324 324 type: "boolean",

325`boolean`325 description: "Enable ChatGPT Apps/connectors support (experimental).",

326 326 },

327Details327 {

328 328 key: "features.codex_hooks",

329Enable or disable analytics for this machine/profile. When unset, the client default applies.329 type: "boolean",

330 330 description:

331Key331 "Enable lifecycle hooks loaded from `hooks.json` or inline `[hooks]` config.",

332 332 },

333`approval_policy`333 {

334 334 key: "features.codex_git_commit",

335Type / Values335 type: "boolean",

336 336 description:

337`untrusted | on-request | never | { granular = { sandbox_approval = bool, rules = bool, mcp_elicitations = bool, request_permissions = bool, skill_approval = bool } }`337 "Enable Codex-generated git commits. When enabled, Codex uses `commit_attribution` to append a `Co-authored-by:` trailer to generated commit messages.",

338 338 },

339Details339 {

340 340 key: "hooks",

341Controls 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.341 type: "table",

342 342 description:

343Key343 "Lifecycle hooks configured inline in `config.toml`. Uses the same event schema as `hooks.json`; see the Hooks guide for examples and supported events.",

344 344 },

345`approval_policy.granular.mcp_elicitations`345 {

346 346 key: "features.memories",

347Type / Values347 type: "boolean",

348 348 description: "Enable [Memories](https://developers.openai.com/codex/memories) (off by default).",

349`boolean`349 },

350 350 {

351Details351 key: "mcp_servers.<id>.command",

352 352 type: "string",

353When `true`, MCP elicitation prompts are allowed to surface instead of being auto-rejected.353 description: "Launcher command for an MCP stdio server.",

354 354 },

355Key355 {

356 356 key: "mcp_servers.<id>.args",

357`approval_policy.granular.request_permissions`357 type: "array<string>",

358 358 description: "Arguments passed to the MCP stdio server command.",

359Type / Values359 },

360 360 {

361`boolean`361 key: "mcp_servers.<id>.env",

362 362 type: "map<string,string>",

363Details363 description: "Environment variables forwarded to the MCP stdio server.",

364 364 },

365When `true`, prompts from the `request_permissions` tool are allowed to surface.365 {

366 366 key: "mcp_servers.<id>.env_vars",

367Key367 type: 'array<string | { name = string, source = "local" | "remote" }>',

368 368 description:

369`approval_policy.granular.rules`369 '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.',

370 370 },

371Type / Values371 {

372 372 key: "mcp_servers.<id>.cwd",

373`boolean`373 type: "string",

374 374 description: "Working directory for the MCP stdio server process.",

375Details375 },

376 376 {

377When `true`, approvals triggered by execpolicy `prompt` rules are allowed to surface.377 key: "mcp_servers.<id>.url",

378 378 type: "string",

379Key379 description: "Endpoint for an MCP streamable HTTP server.",

380 380 },

381`approval_policy.granular.sandbox_approval`381 {

382 382 key: "mcp_servers.<id>.bearer_token_env_var",

383Type / Values383 type: "string",

384 384 description:

385`boolean`385 "Environment variable sourcing the bearer token for an MCP HTTP server.",

386 386 },

387Details387 {

388 388 key: "mcp_servers.<id>.http_headers",

389When `true`, sandbox escalation approval prompts are allowed to surface.389 type: "map<string,string>",

390 390 description: "Static HTTP headers included with each MCP HTTP request.",

391Key391 },

392 392 {

393`approval_policy.granular.skill_approval`393 key: "mcp_servers.<id>.env_http_headers",

394 394 type: "map<string,string>",

395Type / Values395 description:

396 396 "HTTP headers populated from environment variables for an MCP HTTP server.",

397`boolean`397 },

398 398 {

399Details399 key: "mcp_servers.<id>.enabled",

400 400 type: "boolean",

401When `true`, skill-script approval prompts are allowed to surface.401 description: "Disable an MCP server without removing its configuration.",

402 402 },

403Key403 {

404 404 key: "mcp_servers.<id>.required",

405`approvals_reviewer`405 type: "boolean",

406 406 description:

407Type / Values407 "When true, fail startup/resume if this enabled MCP server cannot initialize.",

408 408 },

409`user | guardian_subagent`409 {

410 410 key: "mcp_servers.<id>.startup_timeout_sec",

411Details411 type: "number",

412 412 description:

413Select who reviews eligible approval prompts. Defaults to `user`; `guardian_subagent` routes supported reviews through the Guardian reviewer subagent.413 "Override the default 10s startup timeout for an MCP server.",

414 414 },

415Key415 {

416 416 key: "mcp_servers.<id>.startup_timeout_ms",

417`apps._default.destructive_enabled`417 type: "number",

418 418 description: "Alias for `startup_timeout_sec` in milliseconds.",

419Type / Values419 },

420 420 {

421`boolean`421 key: "mcp_servers.<id>.tool_timeout_sec",

422 422 type: "number",

423Details423 description:

424 424 "Override the default 60s per-tool timeout for an MCP server.",

425Default allow/deny for app tools with `destructive_hint = true`.425 },

426 426 {

427Key427 key: "mcp_servers.<id>.enabled_tools",

428 428 type: "array<string>",

429`apps._default.enabled`429 description: "Allow list of tool names exposed by the MCP server.",

430 430 },

431Type / Values431 {

432 432 key: "mcp_servers.<id>.disabled_tools",

433`boolean`433 type: "array<string>",

434 434 description:

435Details435 "Deny list applied after `enabled_tools` for the MCP server.",

436 436 },

437Default app enabled state for all apps unless overridden per app.437 {

438 438 key: "mcp_servers.<id>.scopes",

439Key439 type: "array<string>",

440 440 description:

441`apps._default.open_world_enabled`441 "OAuth scopes to request when authenticating to that MCP server.",

442 442 },

443Type / Values443 {

444 444 key: "mcp_servers.<id>.oauth_resource",

445`boolean`445 type: "string",

446 446 description:

447Details447 "Optional RFC 8707 OAuth resource parameter to include during MCP login.",

448 448 },

449Default allow/deny for app tools with `open_world_hint = true`.449 {

450 450 key: "mcp_servers.<id>.experimental_environment",

451Key451 type: "local | remote",

452 452 description:

453`apps.<id>.default_tools_approval_mode`453 "Experimental placement for an MCP server. `remote` starts stdio servers through a remote executor environment; streamable HTTP remote placement is not implemented.",

454 454 },

455Type / Values455 {

456 456 key: "agents.max_threads",

457`auto | prompt | approve`457 type: "number",

458 458 description:

459Details459 "Maximum number of agent threads that can be open concurrently. Defaults to `6` when unset.",

460 460 },

461Default approval behavior for tools in this app unless a per-tool override exists.461 {

462 462 key: "agents.max_depth",

463Key463 type: "number",

464 464 description:

465`apps.<id>.default_tools_enabled`465 "Maximum nesting depth allowed for spawned agent threads (root sessions start at depth 0; default: 1).",

466 466 },

467Type / Values467 {

468 468 key: "agents.job_max_runtime_seconds",

469`boolean`469 type: "number",

470 470 description:

471Details471 "Default per-worker timeout for `spawn_agents_on_csv` jobs. When unset, the tool falls back to 1800 seconds per worker.",

472 472 },

473Default enabled state for tools in this app unless a per-tool override exists.473 {

474 474 key: "agents.<name>.description",

475Key475 type: "string",

476 476 description:

477`apps.<id>.destructive_enabled`477 "Role guidance shown to Codex when choosing and spawning that agent type.",

478 478 },

479Type / Values479 {

480 480 key: "agents.<name>.config_file",

481`boolean`481 type: "string (path)",

482 482 description:

483Details483 "Path to a TOML config layer for that role; relative paths resolve from the config file that declares the role.",

484 484 },

485Allow or block tools in this app that advertise `destructive_hint = true`.485 {

486 486 key: "agents.<name>.nickname_candidates",

487Key487 type: "array<string>",

488 488 description:

489`apps.<id>.enabled`489 "Optional pool of display nicknames for spawned agents in that role.",

490 490 },

491Type / Values491 {

492 492 key: "memories.generate_memories",

493`boolean`493 type: "boolean",

494 494 description:

495Details495 "When `false`, newly created threads are not stored as memory-generation inputs. Defaults to `true`.",

496 496 },

497Enable or disable a specific app/connector by id (default: true).497 {

498 498 key: "memories.use_memories",

499Key499 type: "boolean",

500 500 description:

501`apps.<id>.open_world_enabled`501 "When `false`, Codex skips injecting existing memories into future sessions. Defaults to `true`.",

502 502 },

503Type / Values503 {

504 504 key: "memories.disable_on_external_context",

505`boolean`505 type: "boolean",

506 506 description:

507Details507 "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`.",

508 508 },

509Allow or block tools in this app that advertise `open_world_hint = true`.509 {

510 510 key: "memories.max_raw_memories_for_consolidation",

511Key511 type: "number",

512 512 description:

513`apps.<id>.tools.<tool>.approval_mode`513 "Maximum recent raw memories retained for global consolidation. Defaults to `256` and is capped at `4096`.",

514 514 },

515Type / Values515 {

516 516 key: "memories.max_unused_days",

517`auto | prompt | approve`517 type: "number",

518 518 description:

519Details519 "Maximum days since a memory was last used before it becomes ineligible for consolidation. Defaults to `30` and is clamped to `0`-`365`.",

520 520 },

521Per-tool approval behavior override for a single app tool.521 {

522 522 key: "memories.max_rollout_age_days",

523Key523 type: "number",

524 524 description:

525`apps.<id>.tools.<tool>.enabled`525 "Maximum age of threads considered for memory generation. Defaults to `30` and is clamped to `0`-`90`.",

526 526 },

527Type / Values527 {

528 528 key: "memories.max_rollouts_per_startup",

529`boolean`529 type: "number",

530 530 description:

531Details531 "Maximum rollout candidates processed per startup pass. Defaults to `16` and is capped at `128`.",

532 532 },

533Per-tool enabled override for an app tool (for example `repos/list`).533 {

534 534 key: "memories.min_rollout_idle_hours",

535Key535 type: "number",

536 536 description:

537`background_terminal_max_timeout`537 "Minimum idle time before a thread is considered for memory generation. Defaults to `6` and is clamped to `1`-`48`.",

538 538 },

539Type / Values539 {

540 540 key: "memories.min_rate_limit_remaining_percent",

541`number`541 type: "number",

542 542 description:

543Details543 "Minimum remaining percentage required in Codex rate-limit windows before memory generation starts. Defaults to `25` and is clamped to `0`-`100`.",

544 544 },

545Maximum poll window in milliseconds for empty `write_stdin` polls (background terminal polling). Default: `300000` (5 minutes). Replaces the older `background_terminal_timeout` key.545 {

546 546 key: "memories.extract_model",

547Key547 type: "string",

548 548 description: "Optional model override for per-thread memory extraction.",

549`chatgpt_base_url`549 },

550 550 {

551Type / Values551 key: "memories.consolidation_model",

552 552 type: "string",

553`string`553 description: "Optional model override for global memory consolidation.",

554 554 },

555Details555 {

556 556 key: "features.unified_exec",

557Override the base URL used during the ChatGPT login flow.557 type: "boolean",

558 558 description:

559Key559 "Use the unified PTY-backed exec tool (stable; enabled by default except on Windows).",

560 560 },

561`check_for_update_on_startup`561 {

562 562 key: "features.shell_snapshot",

563Type / Values563 type: "boolean",

564 564 description:

565`boolean`565 "Snapshot shell environment to speed up repeated commands (stable; on by default).",

566 566 },

567Details567 {

568 568 key: "features.undo",

569Check for Codex updates on startup (set to false only when updates are centrally managed).569 type: "boolean",

570 570 description: "Enable undo support (stable; off by default).",

571Key571 },

572 572 {

573`cli_auth_credentials_store`573 key: "features.multi_agent",

574 574 type: "boolean",

575Type / Values575 description:

576 576 "Enable multi-agent collaboration tools (`spawn_agent`, `send_input`, `resume_agent`, `wait_agent`, and `close_agent`) (stable; on by default).",

577`file | keyring | auto`577 },

578 578 {

579Details579 key: "features.personality",

580 580 type: "boolean",

581Control where the CLI stores cached credentials (file-based auth.json vs OS keychain).581 description:

582 582 "Enable personality selection controls (stable; on by default).",

583Key583 },

584 584 {

585`commit_attribution`585 key: "features.web_search",

586 586 type: "boolean",

587Type / Values587 description:

588 588 "Deprecated legacy toggle; prefer the top-level `web_search` setting.",

589`string`589 },

590 590 {

591Details591 key: "features.web_search_cached",

592 592 type: "boolean",

593Override the commit co-author trailer text. Set an empty string to disable automatic attribution.593 description:

594 594 'Deprecated legacy toggle. When `web_search` is unset, true maps to `web_search = "cached"`.',

595Key595 },

596 596 {

597`compact_prompt`597 key: "features.web_search_request",

598 598 type: "boolean",

599Type / Values599 description:

600 600 'Deprecated legacy toggle. When `web_search` is unset, true maps to `web_search = "live"`.',

601`string`601 },

602 602 {

603Details603 key: "features.shell_tool",

604 604 type: "boolean",

605Inline override for the history compaction prompt.605 description:

606 606 "Enable the default `shell` tool for running commands (stable; on by default).",

607Key607 },

608 608 {

609`default_permissions`609 key: "features.enable_request_compression",

610 610 type: "boolean",

611Type / Values611 description:

612 612 "Compress streaming request bodies with zstd when supported (stable; on by default).",

613`string`613 },

614 614 {

615Details615 key: "features.skill_mcp_dependency_install",

616 616 type: "boolean",

617Name of the default permissions profile to apply to sandboxed tool calls.617 description:

618 618 "Allow prompting and installing missing MCP dependencies for skills (stable; on by default).",

619Key619 },

620 620 {

621`developer_instructions`621 key: "features.fast_mode",

622 622 type: "boolean",

623Type / Values623 description:

624 624 'Enable Fast mode selection and the `service_tier = "fast"` path (stable; on by default).',

625`string`625 },

626 626 {

627Details627 key: "features.prevent_idle_sleep",

628 628 type: "boolean",

629Additional developer instructions injected into the session (optional).629 description:

630 630 "Prevent the machine from sleeping while a turn is actively running (experimental; off by default).",

631Key631 },

632 632 {

633`disable_paste_burst`633 key: "suppress_unstable_features_warning",

634 634 type: "boolean",

635Type / Values635 description:

636 636 "Suppress the warning that appears when under-development feature flags are enabled.",

637`boolean`637 },

638 638 {

639Details639 key: "model_providers.<id>",

640 640 type: "table",

641Disable burst-paste detection in the TUI.641 description:

642 642 "Custom provider definition. Built-in provider IDs (`openai`, `ollama`, and `lmstudio`) are reserved and cannot be overridden.",

643Key643 },

644 644 {

645`experimental_compact_prompt_file`645 key: "model_providers.<id>.name",

646 646 type: "string",

647Type / Values647 description: "Display name for a custom model provider.",

648 648 },

649`string (path)`649 {

650 650 key: "model_providers.<id>.base_url",

651Details651 type: "string",

652 652 description: "API base URL for the model provider.",

653Load the compaction prompt override from a file (experimental).653 },

654 654 {

655Key655 key: "model_providers.<id>.env_key",

656 656 type: "string",

657`experimental_use_unified_exec_tool`657 description: "Environment variable supplying the provider API key.",

658 658 },

659Type / Values659 {

660 660 key: "model_providers.<id>.env_key_instructions",

661`boolean`661 type: "string",

662 662 description: "Optional setup guidance for the provider API key.",

663Details663 },

664 664 {

665Legacy name for enabling unified exec; prefer `[features].unified_exec` or `codex --enable unified_exec`.665 key: "model_providers.<id>.experimental_bearer_token",

666 666 type: "string",

667Key667 description:

668 668 "Direct bearer token for the provider (discouraged; use `env_key`).",

669`features.apps`669 },

670 670 {

671Type / Values671 key: "model_providers.<id>.requires_openai_auth",

672 672 type: "boolean",

673`boolean`673 description:

674 674 "The provider uses OpenAI authentication (defaults to false).",

675Details675 },

676 676 {

677Enable ChatGPT Apps/connectors support (experimental).677 key: "model_providers.<id>.wire_api",

678 678 type: "responses",

679Key679 description:

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

681`features.codex_hooks`681 },

682 682 {

683Type / Values683 key: "model_providers.<id>.query_params",

684 684 type: "map<string,string>",

685`boolean`685 description: "Extra query parameters appended to provider requests.",

686 686 },

687Details687 {

688 688 key: "model_providers.<id>.http_headers",

689Enable lifecycle hooks loaded from `hooks.json` (under development; off by default).689 type: "map<string,string>",

690 690 description: "Static HTTP headers added to provider requests.",

691Key691 },

692 692 {

693`features.enable_request_compression`693 key: "model_providers.<id>.env_http_headers",

694 694 type: "map<string,string>",

695Type / Values695 description:

696 696 "HTTP headers populated from environment variables when present.",

697`boolean`697 },

698 698 {

699Details699 key: "model_providers.<id>.request_max_retries",

700 700 type: "number",

701Compress streaming request bodies with zstd when supported (stable; on by default).701 description:

702 702 "Retry count for HTTP requests to the provider (default: 4).",

703Key703 },

704 704 {

705`features.fast_mode`705 key: "model_providers.<id>.stream_max_retries",

706 706 type: "number",

707Type / Values707 description: "Retry count for SSE streaming interruptions (default: 5).",

708 708 },

709`boolean`709 {

710 710 key: "model_providers.<id>.stream_idle_timeout_ms",

711Details711 type: "number",

712 712 description:

713Enable Fast mode selection and the `service_tier = "fast"` path (stable; on by default).713 "Idle timeout for SSE streams in milliseconds (default: 300000).",

714 714 },

715Key715 {

716 716 key: "model_providers.<id>.supports_websockets",

717`features.guardian_approval`717 type: "boolean",

718 718 description:

719Type / Values719 "Whether that provider supports the Responses API WebSocket transport.",

720 720 },

721`boolean`721 {

722 722 key: "model_providers.<id>.auth",

723Details723 type: "table",

724 724 description:

725Route eligible approval requests through the guardian reviewer subagent (experimental; off by default). Use with `approvals_reviewer = "guardian_subagent"`.725 "Command-backed bearer token configuration for a custom provider. Do not combine with `env_key`, `experimental_bearer_token`, or `requires_openai_auth`.",

726 726 },

727Key727 {

728 728 key: "model_providers.<id>.auth.command",

729`features.memories`729 type: "string",

730 730 description:

731Type / Values731 "Command to run when Codex needs a bearer token. The command must print the token to stdout.",

732 732 },

733`boolean`733 {

734 734 key: "model_providers.<id>.auth.args",

735Details735 type: "array<string>",

736 736 description: "Arguments passed to the token command.",

737Enable [Memories](https://developers.openai.com/codex/memories) (off by default).737 },

738 738 {

739Key739 key: "model_providers.<id>.auth.timeout_ms",

740 740 type: "number",

741`features.multi_agent`741 description:

742 742 "Maximum token command runtime in milliseconds (default: 5000).",

743Type / Values743 },

744 744 {

745`boolean`745 key: "model_providers.<id>.auth.refresh_interval_ms",

746 746 type: "number",

747Details747 description:

748 748 "How often Codex proactively refreshes the token in milliseconds (default: 300000). Set to `0` to refresh only after an authentication retry.",

749Enable multi-agent collaboration tools (`spawn_agent`, `send_input`, `resume_agent`, `wait_agent`, and `close_agent`) (stable; on by default).749 },

750 750 {

751Key751 key: "model_providers.<id>.auth.cwd",

752 752 type: "string (path)",

753`features.personality`753 description: "Working directory for the token command.",

754 754 },

755Type / Values755 {

756 756 key: "model_providers.amazon-bedrock.aws.profile",

757`boolean`757 type: "string",

758 758 description:

759Details759 "AWS profile name used by the built-in `amazon-bedrock` provider.",

760 760 },

761Enable personality selection controls (stable; on by default).761 {

762 762 key: "model_providers.amazon-bedrock.aws.region",

763Key763 type: "string",

764 764 description: "AWS region used by the built-in `amazon-bedrock` provider.",

765`features.prevent_idle_sleep`765 },

766 766 {

767Type / Values767 key: "model_reasoning_effort",

768 768 type: "minimal | low | medium | high | xhigh",

769`boolean`769 description:

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

771Details771 },

772 772 {

773Prevent the machine from sleeping while a turn is actively running (experimental; off by default).773 key: "plan_mode_reasoning_effort",

774 774 type: "none | minimal | low | medium | high | xhigh",

775Key775 description:

776 776 "Plan-mode-specific reasoning override. When unset, Plan mode uses its built-in preset default.",

777`features.shell_snapshot`777 },

778 778 {

779Type / Values779 key: "model_reasoning_summary",

780 780 type: "auto | concise | detailed | none",

781`boolean`781 description:

782 782 "Select reasoning summary detail or disable summaries entirely.",

783Details783 },

784 784 {

785Snapshot shell environment to speed up repeated commands (stable; on by default).785 key: "model_verbosity",

786 786 type: "low | medium | high",

787Key787 description:

788 788 "Optional GPT-5 Responses API verbosity override; when unset, the selected model/preset default is used.",

789`features.shell_tool`789 },

790 790 {

791Type / Values791 key: "model_supports_reasoning_summaries",

792 792 type: "boolean",

793`boolean`793 description: "Force Codex to send or not send reasoning metadata.",

794 794 },

795Details795 {

796 796 key: "shell_environment_policy.inherit",

797Enable the default `shell` tool for running commands (stable; on by default).797 type: "all | core | none",

798 798 description:

799Key799 "Baseline environment inheritance when spawning subprocesses.",

800 800 },

801`features.skill_mcp_dependency_install`801 {

802 802 key: "shell_environment_policy.ignore_default_excludes",

803Type / Values803 type: "boolean",

804 804 description:

805`boolean`805 "Keep variables containing KEY/SECRET/TOKEN before other filters run.",