config-reference.md Codex Docs, 2026-02-23 18:27 UTC → 2026-05-18 22:01 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).9Project-scoped config can't override machine-local provider, auth,

10 10notification, profile, or telemetry routing keys. Codex ignores

11| Key | Type / Values | Details |11`openai_base_url`, `chatgpt_base_url`, `model_provider`, `model_providers`,

12| --- | --- | --- |12`notify`, `profile`, `profiles`, `experimental_realtime_ws_base_url`, and

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`otel` when they appear in a project-local `.codex/config.toml`; put those in

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

15| `agents.max_threads` | `number` | Maximum number of agent threads that can be open concurrently. |15 

16| `approval_policy` | `untrusted | on-request | never` | Controls when Codex pauses for approval before executing commands. `on-failure` is deprecated; use `on-request` for interactive runs or `never` for non-interactive runs. |16For 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).

17| `apps.<id>.disabled_reason` | `unknown | user` | Optional reason attached when an app/connector is disabled. |17 

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

19| `chatgpt_base_url` | `string` | Override the base URL used during the ChatGPT login flow. |19 options={[

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

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

22| `compact_prompt` | `string` | Inline override for the history compaction prompt. |22 type: "string",

23| `developer_instructions` | `string` | Additional developer instructions injected into the session (optional). |23 description: "Model to use (e.g., `gpt-5.5`).",

24| `disable_paste_burst` | `boolean` | Disable burst-paste detection in the TUI. |24 },

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

26| `experimental_use_freeform_apply_patch` | `boolean` | Legacy name for enabling freeform apply\_patch; prefer `[features].apply_patch_freeform` or `codex --enable apply_patch_freeform`. |26 key: "review_model",

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

28| `features.apply_patch_freeform` | `boolean` | Expose the freeform `apply_patch` tool (experimental). |28 description:

29| `features.apps` | `boolean` | Enable ChatGPT Apps/connectors support (experimental). |29 "Optional model override used by `/review` (defaults to the current session model).",

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

31| `features.child_agents_md` | `boolean` | Append AGENTS.md scope/precedence guidance even when no AGENTS.md is present (experimental). |31 {

32| `features.collaboration_modes` | `boolean` | Enable collaboration modes such as plan mode (stable; on by default). |32 key: "model_provider",

33| `features.elevated_windows_sandbox` | `boolean` | Enable the elevated Windows sandbox pipeline (experimental). |33 type: "string",

34| `features.experimental_windows_sandbox` | `boolean` | Run the Windows restricted-token sandbox (experimental). |34 description: "Provider id from `model_providers` (default: `openai`).",

35| `features.multi_agent` | `boolean` | Enable multi-agent collaboration tools (`spawn\_agent`, `send\_input`, `resume\_agent`, `wait`, and `close\_agent`) (experimental; off by default). |35 },

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

37| `features.powershell_utf8` | `boolean` | Force PowerShell UTF-8 output (defaults to true). |37 key: "openai_base_url",

38| `features.remote_models` | `boolean` | Refresh remote model list before showing readiness (experimental). |38 type: "string",

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

40| `features.runtime_metrics` | `boolean` | Show runtime metrics summary in TUI turn separators (experimental). |40 "Base URL override for the built-in `openai` model provider.",

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

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

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

44| `features.unified_exec` | `boolean` | Use the unified PTY-backed exec tool (beta). |44 type: "number",

45| `features.use_linux_sandbox_bwrap` | `boolean` | Use the bubblewrap-based Linux sandbox pipeline (experimental; off by default). |45 description: "Context window tokens available to the active model.",

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

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

48| `features.web_search_request` | `boolean` | Deprecated legacy toggle. When `web_search` is unset, true maps to `web_search = "live"`. |48 key: "model_auto_compact_token_limit",

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

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

51| `forced_chatgpt_workspace_id` | `string (uuid)` | Limit ChatGPT logins to a specific workspace identifier. |51 "Token threshold that triggers automatic history compaction (unset uses model defaults).",

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

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

54| `history.max_bytes` | `number` | If set, caps the history file size in bytes by dropping oldest entries. |54 key: "model_catalog_json",

55| `history.persistence` | `save-all | none` | Control whether Codex saves session transcripts to history.jsonl. |55 type: "string (path)",

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

57| `instructions` | `string` | Reserved for future use; prefer `model_instructions_file` or `AGENTS.md`. |57 "Optional path to a JSON model catalog loaded on startup. Profile-level `profiles.<name>.model_catalog_json` can override this per profile.",

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

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

60| `mcp_oauth_credentials_store` | `auto | file | keyring` | Preferred store for MCP OAuth credentials. |60 key: "oss_provider",

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

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

63| `mcp_servers.<id>.command` | `string` | Launcher command for an MCP stdio server. |63 "Default local provider used when running with `--oss` (defaults to prompting if unset).",

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

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

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

67| `mcp_servers.<id>.enabled_tools` | `array<string>` | Allow list of tool names exposed by the MCP server. |67 type: "untrusted | on-request | never | { granular = { sandbox_approval = bool, rules = bool, mcp_elicitations = bool, request_permissions = bool, skill_approval = bool } }",

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

69| `mcp_servers.<id>.env_http_headers` | `map<string,string>` | HTTP headers populated from environment variables for an MCP HTTP server. |69 "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.",

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

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

72| `mcp_servers.<id>.required` | `boolean` | When true, fail startup/resume if this enabled MCP server cannot initialize. |72 key: "approval_policy.granular.sandbox_approval",

73| `mcp_servers.<id>.startup_timeout_ms` | `number` | Alias for `startup_timeout_sec` in milliseconds. |73 type: "boolean",

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

75| `mcp_servers.<id>.tool_timeout_sec` | `number` | Override the default 60s per-tool timeout for an MCP server. |75 "When `true`, sandbox escalation approval prompts are allowed to surface.",

76| `mcp_servers.<id>.url` | `string` | Endpoint for an MCP streamable HTTP server. |76 },

77| `model` | `string` | Model to use (e.g., `gpt-5-codex`). |77 {

78| `model_auto_compact_token_limit` | `number` | Token threshold that triggers automatic history compaction (unset uses model defaults). |78 key: "approval_policy.granular.rules",

79| `model_context_window` | `number` | Context window tokens available to the active model. |79 type: "boolean",

80| `model_instructions_file` | `string (path)` | Replacement for built-in instructions instead of `AGENTS.md`. |80 description:

81| `model_provider` | `string` | Provider id from `model_providers` (default: `openai`). |81 "When `true`, approvals triggered by execpolicy `prompt` rules are allowed to surface.",

82| `model_providers.<id>.base_url` | `string` | API base URL for the model provider. |82 },

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

84| `model_providers.<id>.env_key` | `string` | Environment variable supplying the provider API key. |84 key: "approval_policy.granular.mcp_elicitations",

85| `model_providers.<id>.env_key_instructions` | `string` | Optional setup guidance for the provider API key. |85 type: "boolean",

86| `model_providers.<id>.experimental_bearer_token` | `string` | Direct bearer token for the provider (discouraged; use `env_key`). |86 description:

87| `model_providers.<id>.http_headers` | `map<string,string>` | Static HTTP headers added to provider requests. |87 "When `true`, MCP elicitation prompts are allowed to surface instead of being auto-rejected.",

88| `model_providers.<id>.name` | `string` | Display name for a custom model provider. |88 },

89| `model_providers.<id>.query_params` | `map<string,string>` | Extra query parameters appended to provider requests. |89 {

90| `model_providers.<id>.request_max_retries` | `number` | Retry count for HTTP requests to the provider (default: 4). |90 key: "approval_policy.granular.request_permissions",

91| `model_providers.<id>.requires_openai_auth` | `boolean` | The provider uses OpenAI authentication (defaults to false). |91 type: "boolean",

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

93| `model_providers.<id>.stream_max_retries` | `number` | Retry count for SSE streaming interruptions (default: 5). |93 "When `true`, prompts from the `request_permissions` tool are allowed to surface.",

94| `model_providers.<id>.wire_api` | `chat | responses` | Protocol used by the provider (defaults to `chat` if omitted). |94 },

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

96| `model_reasoning_summary` | `auto | concise | detailed | none` | Select reasoning summary detail or disable summaries entirely. |96 key: "approval_policy.granular.skill_approval",

97| `model_supports_reasoning_summaries` | `boolean` | Force Codex to send or not send reasoning metadata. |97 type: "boolean",

98| `model_verbosity` | `low | medium | high` | Control GPT-5 Responses API verbosity (defaults to `medium`). |98 description:

99| `notice.hide_full_access_warning` | `boolean` | Track acknowledgement of the full access warning prompt. |99 "When `true`, skill-script approval prompts are allowed to surface.",

100| `notice.hide_gpt-5.1-codex-max_migration_prompt` | `boolean` | Track acknowledgement of the gpt-5.1-codex-max migration prompt. |100 },

101| `notice.hide_gpt5_1_migration_prompt` | `boolean` | Track acknowledgement of the GPT-5.1 migration prompt. |101 {

102| `notice.hide_rate_limit_model_nudge` | `boolean` | Track opt-out of the rate limit model switch reminder. |102 key: "approvals_reviewer",

103| `notice.hide_world_writable_warning` | `boolean` | Track acknowledgement of the Windows world-writable directories warning. |103 type: "user | auto_review",

104| `notice.model_migrations` | `map<string,string>` | Track acknowledged model migrations as old->new mappings. |104 description:

105| `notify` | `array<string>` | Command invoked for notifications; receives a JSON payload from Codex. |105 "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.",

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

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

108| `otel.exporter` | `none | otlp-http | otlp-grpc` | Select the OpenTelemetry exporter and provide any endpoint metadata. |108 key: "auto_review.policy",

109| `otel.exporter.<id>.endpoint` | `string` | Exporter endpoint for OTEL logs. |109 type: "string",

110| `otel.exporter.<id>.headers` | `map<string,string>` | Static headers included with OTEL exporter requests. |110 description:

111| `otel.exporter.<id>.protocol` | `binary | json` | Protocol used by the OTLP/HTTP exporter. |111 "Local Markdown policy instructions for automatic review. Managed `guardian_policy_config` takes precedence. Blank values are ignored.",

112| `otel.exporter.<id>.tls.ca-certificate` | `string` | CA certificate path for OTEL exporter TLS. |112 },

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

114| `otel.exporter.<id>.tls.client-private-key` | `string` | Client private key path for OTEL exporter TLS. |114 key: "allow_login_shell",

115| `otel.log_user_prompt` | `boolean` | Opt in to exporting raw user prompts with OpenTelemetry logs. |115 type: "boolean",

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

117| `otel.trace_exporter.<id>.endpoint` | `string` | Trace exporter endpoint for OTEL logs. |117 "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.",

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

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

120| `otel.trace_exporter.<id>.tls.ca-certificate` | `string` | CA certificate path for OTEL trace exporter TLS. |120 key: "sandbox_mode",

121| `otel.trace_exporter.<id>.tls.client-certificate` | `string` | Client certificate path for OTEL trace exporter TLS. |121 type: "read-only | workspace-write | danger-full-access",

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

123| `personality` | `none | friendly | pragmatic` | Default communication style for models that advertise `supportsPersonality`; can be overridden per thread/turn or via `/personality`. |123 "Sandbox policy for filesystem and network access during command execution.",

124| `profile` | `string` | Default profile applied at startup (equivalent to `--profile`). |124 },

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

126| `profiles.<name>.experimental_use_freeform_apply_patch` | `boolean` | Legacy name for enabling freeform apply\_patch; prefer `[features].apply_patch_freeform`. |126 key: "sandbox_workspace_write.writable_roots",

127| `profiles.<name>.experimental_use_unified_exec_tool` | `boolean` | Legacy name for enabling unified exec; prefer `[features].unified_exec`. |127 type: "array<string>",

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

129| `profiles.<name>.oss_provider` | `lmstudio | ollama` | Profile-scoped OSS provider for `--oss` sessions. |129 'Additional writable roots when `sandbox_mode = "workspace-write"`.',

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

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

132| `project_doc_fallback_filenames` | `array<string>` | Additional filenames to try when `AGENTS.md` is missing. |132 key: "sandbox_workspace_write.network_access",

133| `project_doc_max_bytes` | `number` | Maximum bytes read from `AGENTS.md` when building project instructions. |133 type: "boolean",

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

135| `projects.<path>.trust_level` | `string` | Mark a project or worktree as trusted or untrusted (`"trusted"` | `"untrusted"`). Untrusted projects skip project-scoped `.codex/` layers. |135 "Allow outbound network access inside the workspace-write sandbox.",

136| `review_model` | `string` | Optional model override used by `/review` (defaults to the current session model). |136 },

137| `sandbox_mode` | `read-only | workspace-write | danger-full-access` | Sandbox policy for filesystem and network access during command execution. |137 {

138| `sandbox_workspace_write.exclude_slash_tmp` | `boolean` | Exclude `/tmp` from writable roots in workspace-write mode. |138 key: "sandbox_workspace_write.exclude_tmpdir_env_var",

139| `sandbox_workspace_write.exclude_tmpdir_env_var` | `boolean` | Exclude `$TMPDIR` from writable roots in workspace-write mode. |139 type: "boolean",

140| `sandbox_workspace_write.network_access` | `boolean` | Allow outbound network access inside the workspace-write sandbox. |140 description:

141| `sandbox_workspace_write.writable_roots` | `array<string>` | Additional writable roots when `sandbox_mode = "workspace-write"`. |141 "Exclude `$TMPDIR` from writable roots in workspace-write mode.",

142| `shell_environment_policy.exclude` | `array<string>` | Glob patterns for removing environment variables after the defaults. |142 },

143| `shell_environment_policy.experimental_use_profile` | `boolean` | Use the user shell profile when spawning subprocesses. |143 {

144| `shell_environment_policy.ignore_default_excludes` | `boolean` | Keep variables containing KEY/SECRET/TOKEN before other filters run. |144 key: "sandbox_workspace_write.exclude_slash_tmp",

145| `shell_environment_policy.include_only` | `array<string>` | Whitelist of patterns; when set only matching variables are kept. |145 type: "boolean",

146| `shell_environment_policy.inherit` | `all | core | none` | Baseline environment inheritance when spawning subprocesses. |146 description:

147| `shell_environment_policy.set` | `map<string,string>` | Explicit environment overrides injected into every subprocess. |147 "Exclude `/tmp` from writable roots in workspace-write mode.",

148| `show_raw_agent_reasoning` | `boolean` | Surface raw reasoning content when the active model emits it. |148 },

149| `skills.config` | `array<object>` | Per-skill enablement overrides stored in config.toml. |149 {

150| `skills.config.<index>.enabled` | `boolean` | Enable or disable the referenced skill. |150 key: "windows.sandbox",

151| `skills.config.<index>.path` | `string (path)` | Path to a skill folder containing `SKILL.md`. |151 type: "unelevated | elevated",

152| `suppress_unstable_features_warning` | `boolean` | Suppress the warning that appears when under-development feature flags are enabled. |152 description:

153| `tool_output_token_limit` | `number` | Token budget for storing individual tool/function outputs in history. |153 "Windows-only native sandbox mode when running Codex natively on Windows.",

154| `tools.web_search` | `boolean` | Deprecated legacy toggle for web search; prefer the top-level `web_search` setting. |154 },

155| `tui` | `table` | TUI-specific options such as enabling inline desktop notifications. |155 {

156| `tui.alternate_screen` | `auto | always | never` | Control alternate screen usage for the TUI (default: auto; auto skips it in Zellij to preserve scrollback). |156 key: "windows.sandbox_private_desktop",

157| `tui.animations` | `boolean` | Enable terminal animations (welcome screen, shimmer, spinner) (default: true). |157 type: "boolean",

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

159| `tui.notifications` | `boolean | array<string>` | Enable TUI notifications; optionally restrict to specific event types. |159 "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.",

160| `tui.show_tooltips` | `boolean` | Show onboarding tooltips in the TUI welcome screen (default: true). |160 },

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

162| `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. |162 key: "notify",

163| `windows_wsl_setup_acknowledged` | `boolean` | Track Windows onboarding acknowledgement (Windows only). |163 type: "array<string>",

164 164 description:

165Key165 "Command invoked for notifications; receives a JSON payload from Codex.",

166 166 },

167`agents.<name>.config_file`167 {

168 168 key: "check_for_update_on_startup",

169Type / Values169 type: "boolean",

170 170 description:

171`string (path)`171 "Check for Codex updates on startup (set to false only when updates are centrally managed).",

172 172 },

173Details173 {

174 174 key: "feedback.enabled",

175Path to a TOML config layer for that role; relative paths resolve from the config file that declares the role.175 type: "boolean",

176 176 description:

177Key177 "Enable feedback submission via `/feedback` across Codex surfaces (default: true).",

178 178 },

179`agents.<name>.description`179 {

180 180 key: "analytics.enabled",

181Type / Values181 type: "boolean",

182 182 description:

183`string`183 "Enable or disable analytics for this machine/profile. When unset, the client default applies.",

184 184 },

185Details185 {

186 186 key: "instructions",

187Role guidance shown to Codex when choosing and spawning that agent type.187 type: "string",

188 188 description:

189Key189 "Reserved for future use; prefer `model_instructions_file` or `AGENTS.md`.",

190 190 },

191`agents.max_threads`191 {

192 192 key: "developer_instructions",

193Type / Values193 type: "string",

194 194 description:

195`number`195 "Additional developer instructions injected into the session (optional).",

196 196 },

197Details197 {

198 198 key: "log_dir",

199Maximum number of agent threads that can be open concurrently.199 type: "string (path)",

200 200 description:

201Key201 "Directory where Codex writes log files (for example `codex-tui.log`); defaults to `$CODEX_HOME/log`.",

202 202 },

203`approval_policy`203 {

204 204 key: "sqlite_home",

205Type / Values205 type: "string (path)",

206 206 description:

207`untrusted | on-request | never`207 "Directory where Codex stores the SQLite-backed state DB used by agent jobs and other resumable runtime state.",

208 208 },

209Details209 {

210 210 key: "compact_prompt",

211Controls when Codex pauses for approval before executing commands. `on-failure` is deprecated; use `on-request` for interactive runs or `never` for non-interactive runs.211 type: "string",

212 212 description: "Inline override for the history compaction prompt.",

213Key213 },

214 214 {

215`apps.<id>.disabled_reason`215 key: "commit_attribution",

216 216 type: "string",

217Type / Values217 description:

218 218 'Commit co-author trailer used when `[features].codex_git_commit` is enabled. Defaults to `Codex <noreply@openai.com>`; set `""` to disable.',

219`unknown | user`219 },

220 220 {

221Details221 key: "model_instructions_file",

222 222 type: "string (path)",

223Optional reason attached when an app/connector is disabled.223 description:

224 224 "Replacement for built-in instructions instead of `AGENTS.md`.",

225Key225 },

226 226 {

227`apps.<id>.enabled`227 key: "personality",

228 228 type: "none | friendly | pragmatic",

229Type / Values229 description:

230 230 "Default communication style for models that advertise `supportsPersonality`; can be overridden per thread/turn or via `/personality`.",

231`boolean`231 },

232 232 {

233Details233 key: "service_tier",

234 234 type: "string",

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

236 236 "Preferred service tier for new turns. Built-in values include `flex` and `fast`; legacy `fast` config maps to the request value `priority`, and catalog-provided tier IDs can also be stored.",

237Key237 },

238 238 {

239`chatgpt_base_url`239 key: "experimental_compact_prompt_file",

240 240 type: "string (path)",

241Type / Values241 description:

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

243`string`243 },

244 244 {

245Details245 key: "skills.config",

246 246 type: "array<object>",

247Override the base URL used during the ChatGPT login flow.247 description: "Per-skill enablement overrides stored in config.toml.",

248 248 },

249Key249 {

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

251`check_for_update_on_startup`251 type: "string (path)",

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

253Type / Values253 },

254 254 {

255`boolean`255 key: "skills.config.<index>.enabled",

256 256 type: "boolean",

257Details257 description: "Enable or disable the referenced skill.",

258 258 },

259Check for Codex updates on startup (set to false only when updates are centrally managed).259 {

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

261Key261 type: "boolean",

262 262 description:

263`cli_auth_credentials_store`263 "Enable or disable a specific app/connector by id (default: true).",

264 264 },

265Type / Values265 {

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

267`file | keyring | auto`267 type: "boolean",

268 268 description:

269Details269 "Default app enabled state for all apps unless overridden per app.",

270 270 },

271Control where the CLI stores cached credentials (file-based auth.json vs OS keychain).271 {

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

273Key273 type: "boolean",

274 274 description:

275`compact_prompt`275 "Default allow/deny for app tools with `destructive_hint = true`.",

276 276 },

277Type / Values277 {

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

279`string`279 type: "boolean",

280 280 description:

281Details281 "Default allow/deny for app tools with `open_world_hint = true`.",

282 282 },

283Inline override for the history compaction prompt.283 {

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

285Key285 type: "boolean",

286 286 description:

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

288 288 },

289Type / Values289 {

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

291`string`291 type: "boolean",

292 292 description:

293Details293 "Allow or block tools in this app that advertise `open_world_hint = true`.",

294 294 },

295Additional developer instructions injected into the session (optional).295 {

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

297Key297 type: "boolean",

298 298 description:

299`disable_paste_burst`299 "Default enabled state for tools in this app unless a per-tool override exists.",

300 300 },

301Type / Values301 {

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

303`boolean`303 type: "auto | prompt | approve",

304 304 description:

305Details305 "Default approval behavior for tools in this app unless a per-tool override exists.",

306 306 },

307Disable burst-paste detection in the TUI.307 {

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

309Key309 type: "boolean",

310 310 description:

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

312 312 },

313Type / Values313 {

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

315`string (path)`315 type: "auto | prompt | approve",

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

317Details317 },

318 318 {

319Load the compaction prompt override from a file (experimental).319 key: "tool_suggest.discoverables",

320 320 type: "array<table>",

321Key321 description:

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

323`experimental_use_freeform_apply_patch`323 },

324 324 {

325Type / Values325 key: "tool_suggest.disabled_tools",

326 326 type: "array<table>",

327`boolean`327 description:

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

329Details329 },

330 330 {

331Legacy name for enabling freeform apply\_patch; prefer `[features].apply_patch_freeform` or `codex --enable apply_patch_freeform`.331 key: "features.apps",

332 332 type: "boolean",

333Key333 description: "Enable ChatGPT Apps/connectors support (experimental).",

334 334 },

335`experimental_use_unified_exec_tool`335 {

336 336 key: "features.hooks",

337Type / Values337 type: "boolean",

338 338 description:

339`boolean`339 "Enable lifecycle hooks loaded from `hooks.json` or inline `[hooks]` config. `features.codex_hooks` is a deprecated alias.",

340 340 },

341Details341 {

342 342 key: "features.codex_git_commit",

343Legacy name for enabling unified exec; prefer `[features].unified_exec` or `codex --enable unified_exec`.343 type: "boolean",

344 344 description:

345Key345 "Enable Codex-generated git commits. When enabled, Codex uses `commit_attribution` to append a `Co-authored-by:` trailer to generated commit messages.",

346 346 },

347`features.apply_patch_freeform`347 {

348 348 key: "hooks",

349Type / Values349 type: "table",

350 350 description:

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

352 352 },

353Details353 {

354 354 key: "features.plugin_hooks",

355Expose the freeform `apply_patch` tool (experimental).355 type: "boolean",

356 356 description:

357Key357 "Opt into lifecycle hooks bundled with enabled plugins. Off by default in this release; set to `true` to opt in.",

358 358 },

359`features.apps`359 {

360 360 key: "features.memories",

361Type / Values361 type: "boolean",

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

363`boolean`363 },

364 364 {

365Details365 key: "mcp_servers.<id>.command",

366 366 type: "string",

367Enable ChatGPT Apps/connectors support (experimental).367 description: "Launcher command for an MCP stdio server.",

368 368 },

369Key369 {

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

371`features.apps_mcp_gateway`371 type: "array<string>",

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

373Type / Values373 },

374 374 {

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

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

377Details377 description: "Environment variables forwarded to the MCP stdio server.",

378 378 },

379Route Apps MCP calls through the OpenAI connectors MCP gateway (`https://api.openai.com/v1/connectors/mcp/`) instead of legacy routing (experimental).379 {

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

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

382 382 description:

383`features.child_agents_md`383 '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.',

384 384 },

385Type / Values385 {

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

387`boolean`387 type: "string",

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

389Details389 },

390 390 {

391Append AGENTS.md scope/precedence guidance even when no AGENTS.md is present (experimental).391 key: "mcp_servers.<id>.url",

392 392 type: "string",

393Key393 description: "Endpoint for an MCP streamable HTTP server.",

394 394 },

395`features.collaboration_modes`395 {

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

397Type / Values397 type: "string",

398 398 description:

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

400 400 },

401Details401 {

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

403Enable collaboration modes such as plan mode (stable; on by default).403 type: "map<string,string>",

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

405Key405 },

406 406 {

407`features.elevated_windows_sandbox`407 key: "mcp_servers.<id>.env_http_headers",

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

409Type / Values409 description:

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

411`boolean`411 },

412 412 {

413Details413 key: "mcp_servers.<id>.enabled",

414 414 type: "boolean",

415Enable the elevated Windows sandbox pipeline (experimental).415 description: "Disable an MCP server without removing its configuration.",

416 416 },

417Key417 {

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

419`features.experimental_windows_sandbox`419 type: "boolean",

420 420 description:

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

422 422 },

423`boolean`423 {

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

425Details425 type: "number",

426 426 description:

427Run the Windows restricted-token sandbox (experimental).427 "Override the default 10s startup timeout for an MCP server.",

428 428 },

429Key429 {

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

431`features.multi_agent`431 type: "number",

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

433Type / Values433 },

434 434 {

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

436 436 type: "number",

437Details437 description:

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

439Enable multi-agent collaboration tools (`spawn\_agent`, `send\_input`, `resume\_agent`, `wait`, and `close\_agent`) (experimental; off by default).439 },

440 440 {

441Key441 key: "mcp_servers.<id>.enabled_tools",

442 442 type: "array<string>",

443`features.personality`443 description: "Allow list of tool names exposed by the MCP server.",

444 444 },

445Type / Values445 {

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

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

448 448 description:

449Details449 "Deny list applied after `enabled_tools` for the MCP server.",

450 450 },

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

452 452 key: "mcp_servers.<id>.default_tools_approval_mode",

453Key453 type: "auto | prompt | approve",

454 454 description:

455`features.powershell_utf8`455 "Default approval behavior for MCP tools on this server unless a per-tool override exists.",

456 456 },

457Type / Values457 {

458 458 key: "mcp_servers.<id>.tools.<tool>.approval_mode",

459`boolean`459 type: "auto | prompt | approve",

460 460 description:

461Details461 "Per-tool approval behavior override for one MCP tool on this server.",

462 462 },

463Force PowerShell UTF-8 output (defaults to true).463 {

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

465Key465 type: "array<string>",

466 466 description:

467`features.remote_models`467 "OAuth scopes to request when authenticating to that MCP server.",

468 468 },

469Type / Values469 {

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

471`boolean`471 type: "string",

472 472 description:

473Details473 "Optional RFC 8707 OAuth resource parameter to include during MCP login.",

474 474 },

475Refresh remote model list before showing readiness (experimental).475 {

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

477Key477 type: "local | remote",

478 478 description:

479`features.request_rule`479 "Experimental placement for an MCP server. `remote` starts stdio servers through a remote executor environment; streamable HTTP remote placement is not implemented.",

480 480 },

481Type / Values481 {

482 482 key: "agents.max_threads",

483`boolean`483 type: "number",

484 484 description:

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

486 486 },

487Enable Smart approvals (`prefix_rule` suggestions on escalation requests; stable; on by default).487 {

488 488 key: "agents.max_depth",

489Key489 type: "number",

490 490 description:

491`features.runtime_metrics`491 "Maximum nesting depth allowed for spawned agent threads (root sessions start at depth 0; default: 1).",

492 492 },

493Type / Values493 {

494 494 key: "agents.job_max_runtime_seconds",

495`boolean`495 type: "number",

496 496 description:

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

498 498 },

499Show runtime metrics summary in TUI turn separators (experimental).499 {

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

501Key501 type: "string",

502 502 description:

503`features.search_tool`503 "Role guidance shown to Codex when choosing and spawning that agent type.",

504 504 },

505Type / Values505 {

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

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

508 508 description:

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

510 510 },

511Enable `search_tool_bm25` for Apps tool discovery before invoking app MCP tools (experimental).511 {

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

513Key513 type: "array<string>",

514 514 description:

515`features.shell_snapshot`515 "Optional pool of display nicknames for spawned agents in that role.",

516 516 },

517Type / Values517 {

518 518 key: "memories.generate_memories",

519`boolean`519 type: "boolean",

520 520 description:

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

522 522 },

523Snapshot shell environment to speed up repeated commands (beta).523 {

524 524 key: "memories.use_memories",

525Key525 type: "boolean",

526 526 description:

527`features.shell_tool`527 "When `false`, Codex skips injecting existing memories into future sessions. Defaults to `true`.",

528 528 },

529Type / Values529 {

530 530 key: "memories.disable_on_external_context",

531`boolean`531 type: "boolean",

532 532 description:

533Details533 "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`.",

534 534 },

535Enable the default `shell` tool for running commands (stable; on by default).535 {

536 536 key: "memories.max_raw_memories_for_consolidation",

537Key537 type: "number",

538 538 description:

539`features.unified_exec`539 "Maximum recent raw memories retained for global consolidation. Defaults to `256` and is capped at `4096`.",

540 540 },

541Type / Values541 {

542 542 key: "memories.max_unused_days",

543`boolean`543 type: "number",

544 544 description:

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

546 546 },

547Use the unified PTY-backed exec tool (beta).547 {

548 548 key: "memories.max_rollout_age_days",

549Key549 type: "number",

550 550 description:

551`features.use_linux_sandbox_bwrap`551 "Maximum age of threads considered for memory generation. Defaults to `30` and is clamped to `0`-`90`.",

552 552 },

553Type / Values553 {

554 554 key: "memories.max_rollouts_per_startup",

555`boolean`555 type: "number",

556 556 description:

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

558 558 },

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

560 560 key: "memories.min_rollout_idle_hours",

561Key561 type: "number",

562 562 description:

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

564 564 },

565Type / Values565 {

566 566 key: "memories.min_rate_limit_remaining_percent",

567`boolean`567 type: "number",

568 568 description:

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

570 570 },

571Deprecated legacy toggle; prefer the top-level `web_search` setting.571 {

572 572 key: "memories.extract_model",

573Key573 type: "string",

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

575`features.web_search_cached`575 },

576 576 {

577Type / Values577 key: "memories.consolidation_model",

578 578 type: "string",

579`boolean`579 description: "Optional model override for global memory consolidation.",

580 580 },

581Details581 {

582 582 key: "features.unified_exec",

583Deprecated legacy toggle. When `web_search` is unset, true maps to `web_search = "cached"`.583 type: "boolean",

584 584 description:

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

586 586 },

587`features.web_search_request`587 {

588 588 key: "features.shell_snapshot",

589Type / Values589 type: "boolean",

590 590 description:

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

592 592 },

593Details593 {

594 594 key: "features.undo",

595Deprecated legacy toggle. When `web_search` is unset, true maps to `web_search = "live"`.595 type: "boolean",

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

597Key597 },

598 598 {

599`feedback.enabled`599 key: "features.multi_agent",

600 600 type: "boolean",

601Type / Values601 description:

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

603`boolean`603 },

604 604 {

605Details605 key: "features.personality",

606 606 type: "boolean",

607Enable feedback submission via `/feedback` across Codex surfaces (default: true).607 description:

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

609Key609 },

610 610 {

611`file_opener`611 key: "features.network_proxy",

612 612 type: "boolean | table",

613Type / Values613 description:

614 614 "Enable sandboxed networking. Use a table form when setting network policy options such as `domains` (experimental; off by default).",

615`vscode | vscode-insiders | windsurf | cursor | none`615 },

616 616 {

617Details617 key: "features.network_proxy.enabled",

618 618 type: "boolean",

619URI scheme used to open citations from Codex output (default: `vscode`).619 description: "Enable sandboxed networking. Defaults to `false`.",

620 620 },

621Key621 {

622 622 key: "features.network_proxy.domains",

623`forced_chatgpt_workspace_id`623 type: "map<string, allow | deny>",

624 624 description:

625Type / Values625 "Domain policy for sandboxed networking. Unset by default, which means no external destinations are allowed until you add `allow` rules. Supports exact hosts, `*.example.com` for subdomains only, `**.example.com` for apex plus subdomains, and global `*` allow rules; prefer scoped rules because `*` broadly opens public outbound access. Add `deny` rules for blocked destinations; `deny` wins on conflicts.",

626 626 },

627`string (uuid)`627 {

628 628 key: "features.network_proxy.unix_sockets",

629Details629 type: "map<string, allow | none>",

630 630 description:

631Limit ChatGPT logins to a specific workspace identifier.631 "Unix socket policy for sandboxed networking. Unset by default; add `allow` entries for permitted sockets.",

632 632 },

633Key633 {

634 634 key: "features.network_proxy.allow_local_binding",

635`forced_login_method`635 type: "boolean",

636 636 description:

637Type / Values637 "Allow broader local/private-network access. Defaults to `false`; exact local IP literal or `localhost` allow rules can still permit specific local targets.",

638 638 },

639`chatgpt | api`639 {

640 640 key: "features.network_proxy.enable_socks5",

641Details641 type: "boolean",

642 642 description: "Expose SOCKS5 support. Defaults to `true`.",

643Restrict Codex to a specific authentication method.643 },

644 644 {

645Key645 key: "features.network_proxy.enable_socks5_udp",

646 646 type: "boolean",

647`hide_agent_reasoning`647 description: "Allow UDP over SOCKS5. Defaults to `true`.",

648 648 },

649Type / Values649 {

650 650 key: "features.network_proxy.allow_upstream_proxy",

651`boolean`651 type: "boolean",

652 652 description:

653Details653 "Allow chaining through an upstream proxy from the environment. Defaults to `true`.",

654 654 },

655Suppress reasoning events in both the TUI and `codex exec` output.655 {

656 656 key: "features.network_proxy.dangerously_allow_non_loopback_proxy",

657Key657 type: "boolean",

658 658 description:

659`history.max_bytes`659 "Permit non-loopback listener addresses. Defaults to `false`; enabling it can expose proxy listeners beyond localhost.",

660 660 },

661Type / Values661 {

662 662 key: "features.network_proxy.dangerously_allow_all_unix_sockets",

663`number`663 type: "boolean",

664 664 description:

665Details665 "Permit arbitrary Unix socket destinations instead of allowlist-only access. Defaults to `false`; use only in tightly controlled environments.",

666 666 },

667If set, caps the history file size in bytes by dropping oldest entries.667 {

668 668 key: "features.network_proxy.proxy_url",

669Key669 type: "string",

670 670 description:

671`history.persistence`671 'HTTP listener URL for sandboxed networking. Defaults to `"http://127.0.0.1:3128"`.',

672 672 },

673Type / Values673 {

674 674 key: "features.network_proxy.socks_url",

675`save-all | none`675 type: "string",

676 676 description:

677Details677 'SOCKS5 listener URL. Defaults to `"http://127.0.0.1:8081"`.',

678 678 },

679Control whether Codex saves session transcripts to history.jsonl.679 {

680 680 key: "features.web_search",

681Key681 type: "boolean",

682 682 description:

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

684 684 },

685Type / Values685 {

686 686 key: "features.web_search_cached",

687`boolean`687 type: "boolean",

688 688 description:

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

690 690 },

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

692 692 key: "features.web_search_request",

693Key693 type: "boolean",

694 694 description:

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

696 696 },

697Type / Values697 {

698 698 key: "features.shell_tool",

699`string`699 type: "boolean",

700 700 description:

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

702 702 },

703Reserved for future use; prefer `model_instructions_file` or `AGENTS.md`.703 {

704 704 key: "features.enable_request_compression",

705Key705 type: "boolean",

706 706 description:

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

708 708 },

709Type / Values709 {

710 710 key: "features.skill_mcp_dependency_install",

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

712 712 description:

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

714 714 },

715Directory where Codex writes log files (for example `codex-tui.log`); defaults to `$CODEX_HOME/log`.715 {

716 716 key: "features.fast_mode",

717Key717 type: "boolean",

718 718 description:

719`mcp_oauth_callback_port`719 "Enable model-catalog service tier selection in the TUI, including Fast-tier commands when the active model advertises them (stable; on by default).",

720 720 },

721Type / Values721 {

722 722 key: "features.prevent_idle_sleep",

723`integer`723 type: "boolean",

724 724 description:

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

726 726 },

727Optional 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.727 {

728 728 key: "suppress_unstable_features_warning",

729Key729 type: "boolean",

730 730 description:

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

732 732 },

733Type / Values733 {

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

735`auto | file | keyring`735 type: "table",

736 736 description:

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

738 738 },

739Preferred store for MCP OAuth credentials.739 {

740 740 key: "model_providers.<id>.name",

741Key741 type: "string",

742 742 description: "Display name for a custom model provider.",

743`mcp_servers.<id>.args`743 },

744 744 {

745Type / Values745 key: "model_providers.<id>.base_url",

746 746 type: "string",

747`array<string>`747 description: "API base URL for the model provider.",

748 748 },

749Details749 {

750 750 key: "model_providers.<id>.env_key",

751Arguments passed to the MCP stdio server command.751 type: "string",

752 752 description: "Environment variable supplying the provider API key.",

753Key753 },

754 754 {

755`mcp_servers.<id>.bearer_token_env_var`755 key: "model_providers.<id>.env_key_instructions",

756 756 type: "string",

757Type / Values757 description: "Optional setup guidance for the provider API key.",

758 758 },

759`string`759 {

760 760 key: "model_providers.<id>.experimental_bearer_token",

761Details761 type: "string",

762 762 description:

763Environment variable sourcing the bearer token for an MCP HTTP server.763 "Direct bearer token for the provider (discouraged; use `env_key`).",

764 764 },

765Key765 {

766 766 key: "model_providers.<id>.requires_openai_auth",

767`mcp_servers.<id>.command`767 type: "boolean",

768 768 description:

769Type / Values769 "The provider uses OpenAI authentication (defaults to false).",

770 770 },

771`string`771 {

772 772 key: "model_providers.<id>.wire_api",

773Details773 type: "responses",

774 774 description:

775Launcher command for an MCP stdio server.775 "Protocol used by the provider. `responses` is the only supported value, and it is the default when omitted.",

776 776 },

777Key777 {

778 778 key: "model_providers.<id>.query_params",

779`mcp_servers.<id>.cwd`779 type: "map<string,string>",

780 780 description: "Extra query parameters appended to provider requests.",

781Type / Values781 },

782 782 {

783`string`783 key: "model_providers.<id>.http_headers",

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

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

786 786 },

787Working directory for the MCP stdio server process.787 {

788 788 key: "model_providers.<id>.env_http_headers",

789Key789 type: "map<string,string>",

790 790 description:

791`mcp_servers.<id>.disabled_tools`791 "HTTP headers populated from environment variables when present.",

792 792 },

793Type / Values793 {

794 794 key: "model_providers.<id>.request_max_retries",

795`array<string>`795 type: "number",

796 796 description:

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

798 798 },

799Deny list applied after `enabled_tools` for the MCP server.799 {

800 800 key: "model_providers.<id>.stream_max_retries",

801Key801 type: "number",

802 802 description: "Retry count for SSE streaming interruptions (default: 5).",

803`mcp_servers.<id>.enabled`803 },

804 804 {

805Type / Values805 key: "model_providers.<id>.stream_idle_timeout_ms",

806 806 type: "number",

807`boolean`807 description:

808 808 "Idle timeout for SSE streams in milliseconds (default: 300000).",

809Details809 },

810 810 {

811Disable an MCP server without removing its configuration.811 key: "model_providers.<id>.supports_websockets",

812 812 type: "boolean",

813Key813 description:

814 814 "Whether that provider supports the Responses API WebSocket transport.",

815`mcp_servers.<id>.enabled_tools`815 },

816 816 {

817Type / Values817 key: "model_providers.<id>.auth",

818 818 type: "table",

819`array<string>`819 description:

820 820 "Command-backed bearer token configuration for a custom provider. Do not combine with `env_key`, `experimental_bearer_token`, or `requires_openai_auth`.",

821Details821 },

822 822 {

823Allow list of tool names exposed by the MCP server.823 key: "model_providers.<id>.auth.command",

824 824 type: "string",

825Key825 description:

826 826 "Command to run when Codex needs a bearer token. The command must print the token to stdout.",

827`mcp_servers.<id>.env`827 },

828 828 {

829Type / Values829 key: "model_providers.<id>.auth.args",

830 830 type: "array<string>",

831`map<string,string>`831 description: "Arguments passed to the token command.",

832 832 },

833Details833 {

834 834 key: "model_providers.<id>.auth.timeout_ms",

835Environment variables forwarded to the MCP stdio server.835 type: "number",

836 836 description:

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

838 838 },

839`mcp_servers.<id>.env_http_headers`839 {

840 840 key: "model_providers.<id>.auth.refresh_interval_ms",

841Type / Values841 type: "number",

842 842 description:

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

844 844 },

845Details845 {

846 846 key: "model_providers.<id>.auth.cwd",