config-sample.md Codex Docs, 2026-02-19 20:37 UTC → 2026-05-02 00:48 UTC

1# Sample Configuration1# Sample Configuration

2 2 

3A complete example config.toml you can copy and adapt3Use this example configuration as a starting point. It includes most keys Codex reads from `config.toml`, along with default behaviors, recommended values where helpful, and short notes.

4 

5Use this example configuration as a starting point. It includes most keys Codex reads from `config.toml`, along with defaults and short notes.

6 4 

7For explanations and guidance, see:5For explanations and guidance, see:

8 6 

9- [Config basics](https://developers.openai.com/codex/config-basic)7- [Config basics](https://developers.openai.com/codex/config-basic)

10- [Advanced Config](https://developers.openai.com/codex/config-advanced)8- [Advanced Config](https://developers.openai.com/codex/config-advanced)

11- [Config Reference](https://developers.openai.com/codex/config-reference)9- [Config Reference](https://developers.openai.com/codex/config-reference)

10- [Sandbox and approvals](https://developers.openai.com/codex/agent-approvals-security#sandbox-and-approvals)

11- [Managed configuration](https://developers.openai.com/codex/enterprise/managed-configuration)

12 12 

13Use the snippet below as a reference. Copy only the keys and sections you need into `~/.codex/config.toml` (or into a project-scoped `.codex/config.toml`), then adjust values for your setup.13Use the snippet below as a reference. Copy only the keys and sections you need into `~/.codex/config.toml` (or into a project-scoped `.codex/config.toml`), then adjust values for your setup.

14 14 

15```toml15```toml

16# Codex example configuration (config.toml)16# Codex example configuration (config.toml)

17#17#

18# This file lists all keys Codex reads from config.toml, their default values,18# This file lists the main keys Codex reads from config.toml, along with default

19# and concise explanations. Values here mirror the effective defaults compiled19# behaviors, recommended examples, and concise explanations. Adjust as needed.

20# into the CLI. Adjust as needed.

21#20#

22# Notes21# Notes

23# - Root keys must appear before tables in TOML.22# - Root keys must appear before tables in TOML.

28# Core Model Selection27# Core Model Selection

29################################################################################28################################################################################

30 29 

31# Primary model used by Codex. Default: "gpt-5.2-codex" on all platforms.30# Primary model used by Codex. Recommended example for most users: "gpt-5.5".

32model = "gpt-5.2-codex"31model = "gpt-5.5"

33 32 

34# Default communication style for supported models. Default: "friendly".33# Communication style for supported models. Allowed values: none | friendly | pragmatic

35# Allowed values: none | friendly | pragmatic34# personality = "pragmatic"

36# personality = "friendly"

37 35 

38# Optional model override for /review. Default: unset (uses current session model).36# Optional model override for /review. Default: unset (uses current session model).

39# review_model = "gpt-5.2-codex"37# review_model = "gpt-5.5"

40 38 

41# Provider id selected from [model_providers]. Default: "openai".39# Provider id selected from [model_providers]. Default: "openai".

42model_provider = "openai"40model_provider = "openai"

44# Default OSS provider for --oss sessions. When unset, Codex prompts. Default: unset.42# Default OSS provider for --oss sessions. When unset, Codex prompts. Default: unset.

45# oss_provider = "ollama"43# oss_provider = "ollama"

46 44 

47# Optional manual model metadata. When unset, Codex auto-detects from model.45# Preferred service tier. `fast` is honored only when enabled in [features].

48# Uncomment to force values.46# service_tier = "flex" # fast | flex

47 

48# Optional manual model metadata. When unset, Codex uses model or preset defaults.

49# model_context_window = 128000 # tokens; default: auto for model49# model_context_window = 128000 # tokens; default: auto for model

50# model_auto_compact_token_limit = 0 # tokens; unset uses model defaults50# model_auto_compact_token_limit = 64000 # tokens; unset uses model defaults

51# tool_output_token_limit = 10000 # tokens stored per tool output; default: 10000 for gpt-5.2-codex51# tool_output_token_limit = 12000 # tokens stored per tool output

52# model_catalog_json = "/absolute/path/to/models.json" # optional startup-only model catalog override

53# background_terminal_max_timeout = 300000 # ms; max empty write_stdin poll window (default 5m)

52# log_dir = "/absolute/path/to/codex-logs" # directory for Codex logs; default: "$CODEX_HOME/log"54# log_dir = "/absolute/path/to/codex-logs" # directory for Codex logs; default: "$CODEX_HOME/log"

55# sqlite_home = "/absolute/path/to/codex-state" # optional SQLite-backed runtime state directory

53 56 

54################################################################################57################################################################################

55# Reasoning & Verbosity (Responses API capable models)58# Reasoning & Verbosity (Responses API capable models)

56################################################################################59################################################################################

57 60 

58# Reasoning effort: minimal | low | medium | high | xhigh (default: medium; xhigh on gpt-5.2-codex and gpt-5.2)61# Reasoning effort: minimal | low | medium | high | xhigh

59model_reasoning_effort = "medium"62# model_reasoning_effort = "medium"

63 

64# Optional override used when Codex runs in plan mode: none | minimal | low | medium | high | xhigh

65# plan_mode_reasoning_effort = "high"

60 66 

61# Reasoning summary: auto | concise | detailed | none (default: auto)67# Reasoning summary: auto | concise | detailed | none

62# model_reasoning_summary = "auto"68# model_reasoning_summary = "auto"

63 69 

64# Text verbosity for GPT-5 family (Responses API): low | medium | high (default: medium)70# Text verbosity for GPT-5 family (Responses API): low | medium | high

65# model_verbosity = "medium"71# model_verbosity = "medium"

66 72 

67# Force enable or disable reasoning summaries for current model73# Force enable or disable reasoning summaries for current model.

68# model_supports_reasoning_summaries = true74# model_supports_reasoning_summaries = true

69 75 

70################################################################################76################################################################################

74# Additional user instructions are injected before AGENTS.md. Default: unset.80# Additional user instructions are injected before AGENTS.md. Default: unset.

75# developer_instructions = ""81# developer_instructions = ""

76 82 

77# (Ignored) Optional legacy base instructions override (prefer AGENTS.md). Default: unset.

78# instructions = ""

79 

80# Inline override for the history compaction prompt. Default: unset.83# Inline override for the history compaction prompt. Default: unset.

81# compact_prompt = ""84# compact_prompt = ""

82 85 

86# Override the default commit co-author trailer. Set to "" to disable it.

87# commit_attribution = "Jane Doe <jane@example.com>"

88 

83# Override built-in base instructions with a file path. Default: unset.89# Override built-in base instructions with a file path. Default: unset.

84# model_instructions_file = "/absolute/or/relative/path/to/instructions.txt"90# model_instructions_file = "/absolute/or/relative/path/to/instructions.txt"

85 91 

86# Migration note: experimental_instructions_file was renamed to model_instructions_file (deprecated).

87 

88# Load the compact prompt override from a file. Default: unset.92# Load the compact prompt override from a file. Default: unset.

89# experimental_compact_prompt_file = "/absolute/or/relative/path/to/compact_prompt.txt"93# experimental_compact_prompt_file = "/absolute/or/relative/path/to/compact_prompt.txt"

90 94 

91# Legacy name for apply_patch_freeform. Default: false

92include_apply_patch_tool = false

93 

94################################################################################95################################################################################

95# Notifications96# Notifications

96################################################################################97################################################################################

97 98 

98# External notifier program (argv array). When unset: disabled.99# External notifier program (argv array). When unset: disabled.

99# Example: notify = ["notify-send", "Codex"]100# notify = ["notify-send", "Codex"]

100notify = [ ]

101 101 

102################################################################################102################################################################################

103# Approval & Sandbox103# Approval & Sandbox

107# - untrusted: only known-safe read-only commands auto-run; others prompt107# - untrusted: only known-safe read-only commands auto-run; others prompt

108# - on-request: model decides when to ask (default)108# - on-request: model decides when to ask (default)

109# - never: never prompt (risky)109# - never: never prompt (risky)

110# - { granular = { ... } }: allow or auto-reject selected prompt categories

110approval_policy = "on-request"111approval_policy = "on-request"

112# Who reviews eligible approval prompts: user (default) | auto_review

113# approvals_reviewer = "user"

114 

115# Example granular policy:

116# approval_policy = { granular = {

117# sandbox_approval = true,

118# rules = true,

119# mcp_elicitations = true,

120# request_permissions = false,

121# skill_approval = false

122# } }

123 

124# Allow login-shell semantics for shell-based tools when they request `login = true`.

125# Default: true. Set false to force non-login shells and reject explicit login-shell requests.

126allow_login_shell = true

111 127 

112# Filesystem/network sandbox policy for tool calls:128# Filesystem/network sandbox policy for tool calls:

113# - read-only (default)129# - read-only (default)

114# - workspace-write130# - workspace-write

115# - danger-full-access (no sandbox; extremely risky)131# - danger-full-access (no sandbox; extremely risky)

116sandbox_mode = "read-only"132sandbox_mode = "read-only"

133# Named permissions profile to apply by default. Built-ins:

134# :read-only | :workspace | :danger-no-sandbox

135# Use a custom name such as "workspace" only when you also define [permissions.workspace].

136# default_permissions = ":workspace"

137 

138# Example filesystem profile. Use `"none"` to deny reads for exact paths or

139# glob patterns. On platforms that need pre-expanded glob matches, set

140# glob_scan_max_depth when using unbounded patterns such as `**`.

141# [permissions.workspace.filesystem]

142# glob_scan_max_depth = 3

143# ":project_roots" = { "." = "write", "**/*.env" = "none" }

144# "/absolute/path/to/secrets" = "none"

117 145 

118################################################################################146################################################################################

119# Authentication & Login147# Authentication & Login

122# Where to persist CLI login credentials: file (default) | keyring | auto150# Where to persist CLI login credentials: file (default) | keyring | auto

123cli_auth_credentials_store = "file"151cli_auth_credentials_store = "file"

124 152 

125# Base URL for ChatGPT auth flow (not OpenAI API). Default:153# Base URL for ChatGPT auth flow (not OpenAI API).

126chatgpt_base_url = "https://chatgpt.com/backend-api/"154chatgpt_base_url = "https://chatgpt.com/backend-api/"

127 155 

156# Optional base URL override for the built-in OpenAI provider.

157# openai_base_url = "https://us.api.openai.com/v1"

158 

128# Restrict ChatGPT login to a specific workspace id. Default: unset.159# Restrict ChatGPT login to a specific workspace id. Default: unset.

129# forced_chatgpt_workspace_id = ""160# forced_chatgpt_workspace_id = "00000000-0000-0000-0000-000000000000"

130 161 

131# Force login mechanism when Codex would normally auto-select. Default: unset.162# Force login mechanism when Codex would normally auto-select. Default: unset.

132# Allowed values: chatgpt | api163# Allowed values: chatgpt | api

134 165 

135# Preferred store for MCP OAuth credentials: auto (default) | file | keyring166# Preferred store for MCP OAuth credentials: auto (default) | file | keyring

136mcp_oauth_credentials_store = "auto"167mcp_oauth_credentials_store = "auto"

137 

138# Optional fixed port for MCP OAuth callback: 1-65535. Default: unset.168# Optional fixed port for MCP OAuth callback: 1-65535. Default: unset.

139# mcp_oauth_callback_port = 4321169# mcp_oauth_callback_port = 4321

170# Optional redirect URI override for MCP OAuth login (for example, remote devbox ingress).

171# Custom callback paths are supported. `mcp_oauth_callback_port` still controls the listener port.

172# mcp_oauth_callback_url = "https://devbox.example.internal/callback"

140 173 

141################################################################################174################################################################################

142# Project Documentation Controls175# Project Documentation Controls

187# If you use --yolo or another full access sandbox setting, web search defaults to live.220# If you use --yolo or another full access sandbox setting, web search defaults to live.

188web_search = "cached"221web_search = "cached"

189 222 

223# Active profile name. When unset, no profile is applied.

224# profile = "default"

225 

226# Suppress the warning shown when under-development feature flags are enabled.

227# suppress_unstable_features_warning = true

228 

190################################################################################229################################################################################

191# Profiles (named presets)230# Agents (multi-agent roles and limits)

192################################################################################231################################################################################

193 232 

194# Active profile name. When unset, no profile is applied.233[agents]

195# profile = "default"234# Maximum concurrently open agent threads. Default: 6

235# max_threads = 6

236# Maximum nested spawn depth. Root session starts at depth 0. Default: 1

237# max_depth = 1

238# Default timeout per worker for spawn_agents_on_csv jobs. When unset, the tool defaults to 1800 seconds.

239# job_max_runtime_seconds = 1800

240 

241# [agents.reviewer]

242# description = "Find correctness, security, and test risks in code."

243# config_file = "./agents/reviewer.toml" # relative to the config.toml that defines it

244# nickname_candidates = ["Athena", "Ada"]

196 245 

197################################################################################246################################################################################

198# Skills (per-skill overrides)247# Skills (per-skill overrides)

200 249 

201# Disable or re-enable a specific skill without deleting it.250# Disable or re-enable a specific skill without deleting it.

202[[skills.config]]251[[skills.config]]

203# path = "/path/to/skill"252# path = "/path/to/skill/SKILL.md"

204# enabled = false253# enabled = false

205 254 

206################################################################################

207# Experimental toggles (legacy; prefer [features])

208################################################################################

209 

210experimental_use_unified_exec_tool = false

211 

212# Include apply_patch via freeform editing path (affects default tool set). Default: false

213experimental_use_freeform_apply_patch = false

214 

215################################################################################255################################################################################

216# Sandbox settings (tables)256# Sandbox settings (tables)

217################################################################################257################################################################################

234[shell_environment_policy]274[shell_environment_policy]

235# inherit: all (default) | core | none275# inherit: all (default) | core | none

236inherit = "all"276inherit = "all"

237# Skip default excludes for names containing KEY/SECRET/TOKEN (case-insensitive). Default: true277# Skip default excludes for names containing KEY/SECRET/TOKEN (case-insensitive). Default: false

238ignore_default_excludes = true278ignore_default_excludes = false

239# Case-insensitive glob patterns to remove (e.g., "AWS_*", "AZURE_*"). Default: []279# Case-insensitive glob patterns to remove (e.g., "AWS_*", "AZURE_*"). Default: []

240exclude = []280exclude = []

241# Explicit key/value overrides (always win). Default: {}281# Explicit key/value overrides (always win). Default: {}

245# Experimental: run via user shell profile. Default: false285# Experimental: run via user shell profile. Default: false

246experimental_use_profile = false286experimental_use_profile = false

247 287 

288################################################################################

289# Managed network proxy settings

290################################################################################

291 

292# Set `default_permissions = "workspace"` before enabling this profile.

293# [permissions.workspace.network]

294# enabled = true

295# proxy_url = "http://127.0.0.1:43128"

296# admin_url = "http://127.0.0.1:43129"

297# enable_socks5 = false

298# socks_url = "http://127.0.0.1:43130"

299# enable_socks5_udp = false

300# allow_upstream_proxy = false

301# dangerously_allow_non_loopback_proxy = false

302# dangerously_allow_non_loopback_admin = false

303# dangerously_allow_all_unix_sockets = false

304# mode = "limited" # limited | full

305# allow_local_binding = false

306#

307# [permissions.workspace.network.domains]

308# "api.openai.com" = "allow"

309# "example.com" = "deny"

310#

311# [permissions.workspace.network.unix_sockets]

312# "/var/run/docker.sock" = "allow"

313 

248################################################################################314################################################################################

249# History (table)315# History (table)

250################################################################################316################################################################################

253# save-all (default) | none319# save-all (default) | none

254persistence = "save-all"320persistence = "save-all"

255# Maximum bytes for history file; oldest entries are trimmed when exceeded. Example: 5242880321# Maximum bytes for history file; oldest entries are trimmed when exceeded. Example: 5242880

256# max_bytes = 0322# max_bytes = 5242880

257 323 

258################################################################################324################################################################################

259# UI, Notifications, and Misc (tables)325# UI, Notifications, and Misc (tables)

267# Notification mechanism for terminal alerts: auto | osc9 | bel. Default: "auto"333# Notification mechanism for terminal alerts: auto | osc9 | bel. Default: "auto"

268# notification_method = "auto"334# notification_method = "auto"

269 335 

336# When notifications fire: unfocused (default) | always

337# notification_condition = "unfocused"

338 

270# Enables welcome/status/spinner animations. Default: true339# Enables welcome/status/spinner animations. Default: true

271animations = true340animations = true

272 341 

276# Control alternate screen usage (auto skips it in Zellij to preserve scrollback).345# Control alternate screen usage (auto skips it in Zellij to preserve scrollback).

277# alternate_screen = "auto"346# alternate_screen = "auto"

278 347 

279# Ordered list of footer status-line item IDs. Default: null (disabled).348# Ordered list of footer status-line item IDs. When unset, Codex uses:

349# ["model-with-reasoning", "context-remaining", "current-dir"].

350# Set to [] to hide the footer.

280# status_line = ["model", "context-remaining", "git-branch"]351# status_line = ["model", "context-remaining", "git-branch"]

281 352 

353# Ordered list of terminal window/tab title item IDs. When unset, Codex uses:

354# ["spinner", "project"]. Set to [] to clear the title.

355# Available IDs include app-name, project, spinner, status, thread, git-branch, model,

356# and task-progress.

357# terminal_title = ["spinner", "project"]

358 

359# Syntax-highlighting theme (kebab-case). Use /theme in the TUI to preview and save.

360# You can also add custom .tmTheme files under $CODEX_HOME/themes.

361# theme = "catppuccin-mocha"

362 

363# Custom key bindings. Context-specific bindings override [tui.keymap.global].

364# Use [] to unbind an action.

365# [tui.keymap.global]

366# open_transcript = "ctrl-t"

367# open_external_editor = []

368#

369# [tui.keymap.composer]

370# submit = ["enter", "ctrl-m"]

371 

372# Internal tooltip state keyed by model slug. Usually managed by Codex.

373# [tui.model_availability_nux]

374# "gpt-5.4" = 1

375 

376# Enable or disable analytics for this machine. When unset, Codex uses its default behavior.

377[analytics]

378enabled = true

379 

282# Control whether users can submit feedback from `/feedback`. Default: true380# Control whether users can submit feedback from `/feedback`. Default: true

283[feedback]381[feedback]

284enabled = true382enabled = true

290# hide_rate_limit_model_nudge = true388# hide_rate_limit_model_nudge = true

291# hide_gpt5_1_migration_prompt = true389# hide_gpt5_1_migration_prompt = true

292# "hide_gpt-5.1-codex-max_migration_prompt" = true390# "hide_gpt-5.1-codex-max_migration_prompt" = true

293# model_migrations = { "gpt-4.1" = "gpt-5.1" }391# model_migrations = { "gpt-5.3-codex" = "gpt-5.4" }

294 

295# Suppress the warning shown when under-development feature flags are enabled.

296# suppress_unstable_features_warning = true

297 392 

298################################################################################393################################################################################

299# Centralized Feature Flags (preferred)394# Centralized Feature Flags (preferred)

301 396 

302[features]397[features]

303# Leave this table empty to accept defaults. Set explicit booleans to opt in/out.398# Leave this table empty to accept defaults. Set explicit booleans to opt in/out.

304shell_tool = true399# shell_tool = true

305# apps = false400# apps = false

306# apps_mcp_gateway = false401# codex_hooks = false

307# Deprecated legacy toggles; prefer the top-level `web_search` setting.402# unified_exec = true

308# web_search = false403# shell_snapshot = true

309# web_search_cached = false404# multi_agent = true

310# web_search_request = false

311unified_exec = false

312shell_snapshot = false

313apply_patch_freeform = false

314# search_tool = false

315# personality = true405# personality = true

316request_rule = true406# fast_mode = true

317collaboration_modes = true407# enable_request_compression = true

318use_linux_sandbox_bwrap = false408# skill_mcp_dependency_install = true

319experimental_windows_sandbox = false409# prevent_idle_sleep = false

320elevated_windows_sandbox = false410 

321remote_models = false411################################################################################

322runtime_metrics = false412# Memories (table)

323powershell_utf8 = true413################################################################################

324child_agents_md = false414 

415# Enable memories with [features].memories, then tune memory behavior here.

416# [memories]

417# generate_memories = true

418# use_memories = true

419# disable_on_external_context = false # legacy alias: no_memories_if_mcp_or_web_search

420 

421################################################################################

422# Lifecycle hooks can be configured here inline or in a sibling hooks.json.

423################################################################################

424 

425# [hooks]

426# [[hooks.PreToolUse]]

427# matcher = "^Bash$"

428#

429# [[hooks.PreToolUse.hooks]]

430# type = "command"

431# command = 'python3 "/absolute/path/to/pre_tool_use_policy.py"'

432# timeout = 30

433# statusMessage = "Checking Bash command"

325 434 

326################################################################################435################################################################################

327# Define MCP servers under this table. Leave empty to disable.436# Define MCP servers under this table. Leave empty to disable.

336# command = "docs-server" # required445# command = "docs-server" # required

337# args = ["--port", "4000"] # optional446# args = ["--port", "4000"] # optional

338# env = { "API_KEY" = "value" } # optional key/value pairs copied as-is447# env = { "API_KEY" = "value" } # optional key/value pairs copied as-is

339# env_vars = ["ANOTHER_SECRET"] # optional: forward these from the parent env448# env_vars = ["ANOTHER_SECRET"] # optional: forward local parent env vars

449# env_vars = ["LOCAL_TOKEN", { name = "REMOTE_TOKEN", source = "remote" }]

340# cwd = "/path/to/server" # optional working directory override450# cwd = "/path/to/server" # optional working directory override

451# experimental_environment = "remote" # experimental: run stdio via a remote executor

341# startup_timeout_sec = 10.0 # optional; default 10.0 seconds452# startup_timeout_sec = 10.0 # optional; default 10.0 seconds

342# # startup_timeout_ms = 10000 # optional alias for startup timeout (milliseconds)453# # startup_timeout_ms = 10000 # optional alias for startup timeout (milliseconds)

343# tool_timeout_sec = 60.0 # optional; default 60.0 seconds454# tool_timeout_sec = 60.0 # optional; default 60.0 seconds

344# enabled_tools = ["search", "summarize"] # optional allow-list455# enabled_tools = ["search", "summarize"] # optional allow-list

345# disabled_tools = ["slow-tool"] # optional deny-list (applied after allow-list)456# disabled_tools = ["slow-tool"] # optional deny-list (applied after allow-list)

457# scopes = ["read:docs"] # optional OAuth scopes

458# oauth_resource = "https://docs.example.com/" # optional OAuth resource

346 459 

347# --- Example: Streamable HTTP transport ---460# --- Example: Streamable HTTP transport ---

348# [mcp_servers.github]461# [mcp_servers.github]

355# startup_timeout_sec = 10.0 # optional468# startup_timeout_sec = 10.0 # optional

356# tool_timeout_sec = 60.0 # optional469# tool_timeout_sec = 60.0 # optional

357# enabled_tools = ["list_issues"] # optional allow-list470# enabled_tools = ["list_issues"] # optional allow-list

471# disabled_tools = ["delete_issue"] # optional deny-list

472# scopes = ["repo"] # optional OAuth scopes

358 473 

359################################################################################474################################################################################

360# Model Providers475# Model Providers

361################################################################################476################################################################################

362 477 

363# Built-ins include:478# Built-ins include:

364# - openai (Responses API; requires login or OPENAI_API_KEY via auth flow)479# - openai

365# - oss (Chat Completions API; defaults to http://localhost:11434/v1)480# - ollama

481# - lmstudio

482# - amazon-bedrock

483# These IDs are reserved. Use a different ID for custom providers.

366 484 

367[model_providers]485[model_providers]

368 486 

487# --- Example: built-in Amazon Bedrock provider options ---

488# model_provider = "amazon-bedrock"

489# model = "<bedrock-model-id>"

490# [model_providers.amazon-bedrock.aws]

491# profile = "default"

492# region = "eu-central-1"

493 

369# --- Example: OpenAI data residency with explicit base URL or headers ---494# --- Example: OpenAI data residency with explicit base URL or headers ---

370# [model_providers.openaidr]495# [model_providers.openaidr]

371# name = "OpenAI Data Residency"496# name = "OpenAI Data Residency"

372# base_url = "https://us.api.openai.com/v1" # example with 'us' domain prefix497# base_url = "https://us.api.openai.com/v1" # example with 'us' domain prefix

373# wire_api = "responses" # "responses" | "chat" (default varies)498# wire_api = "responses" # only supported value

374# # requires_openai_auth = true # built-in OpenAI defaults to true499# # requires_openai_auth = true # use only for providers backed by OpenAI auth

375# # request_max_retries = 4 # default 4; max 100500# # request_max_retries = 4 # default 4; max 100

376# # stream_max_retries = 5 # default 5; max 100501# # stream_max_retries = 5 # default 5; max 100

377# # stream_idle_timeout_ms = 300000 # default 300_000 (5m)502# # stream_idle_timeout_ms = 300000 # default 300_000 (5m)

503# # supports_websockets = true # optional

378# # experimental_bearer_token = "sk-example" # optional dev-only direct bearer token504# # experimental_bearer_token = "sk-example" # optional dev-only direct bearer token

379# # http_headers = { "X-Example" = "value" }505# # http_headers = { "X-Example" = "value" }

380# # env_http_headers = { "OpenAI-Organization" = "OPENAI_ORGANIZATION", "OpenAI-Project" = "OPENAI_PROJECT" }506# # env_http_headers = { "OpenAI-Organization" = "OPENAI_ORGANIZATION", "OpenAI-Project" = "OPENAI_PROJECT" }

381 507 

382# --- Example: Azure (Chat/Responses depending on endpoint) ---508# --- Example: Azure/OpenAI-compatible provider ---

383# [model_providers.azure]509# [model_providers.azure]

384# name = "Azure"510# name = "Azure"

385# base_url = "https://YOUR_PROJECT_NAME.openai.azure.com/openai"511# base_url = "https://YOUR_PROJECT_NAME.openai.azure.com/openai"

386# wire_api = "responses" # or "chat" per endpoint512# wire_api = "responses"

387# query_params = { api-version = "2025-04-01-preview" }513# query_params = { api-version = "2025-04-01-preview" }

388# env_key = "AZURE_OPENAI_API_KEY"514# env_key = "AZURE_OPENAI_API_KEY"

389# # env_key_instructions = "Set AZURE_OPENAI_API_KEY in your environment"515# env_key_instructions = "Set AZURE_OPENAI_API_KEY in your environment"

516# # supports_websockets = false

517 

518# --- Example: command-backed bearer token auth ---

519# [model_providers.proxy]

520# name = "OpenAI using LLM proxy"

521# base_url = "https://proxy.example.com/v1"

522# wire_api = "responses"

523#

524# [model_providers.proxy.auth]

525# command = "/usr/local/bin/fetch-codex-token"

526# args = ["--audience", "codex"]

527# timeout_ms = 5000

528# refresh_interval_ms = 300000

390 529 

391# --- Example: Local OSS (e.g., Ollama-compatible) ---530# --- Example: Local OSS (e.g., Ollama-compatible) ---

392# [model_providers.ollama]531# [model_providers.local_ollama]

393# name = "Ollama"532# name = "Ollama"

394# base_url = "http://localhost:11434/v1"533# base_url = "http://localhost:11434/v1"

395# wire_api = "chat"534# wire_api = "responses"

535 

536################################################################################

537# Apps / Connectors

538################################################################################

539 

540# Optional per-app controls.

541[apps]

542# [_default] applies to all apps unless overridden per app.

543# [apps._default]

544# enabled = true

545# destructive_enabled = true

546# open_world_enabled = true

547#

548# [apps.google_drive]

549# enabled = false

550# destructive_enabled = false # block destructive-hint tools for this app

551# default_tools_enabled = true

552# default_tools_approval_mode = "prompt" # auto | prompt | approve

553#

554# [apps.google_drive.tools."files/delete"]

555# enabled = false

556# approval_mode = "approve"

557 

558# Optional tool suggestion allowlist for connectors or plugins Codex can offer to install.

559# [tool_suggest]

560# discoverables = [

561# { type = "connector", id = "gmail" },

562# { type = "plugin", id = "figma@openai-curated" },

563# ]

564# disabled_tools = [

565# { type = "plugin", id = "slack@openai-curated" },

566# { type = "connector", id = "connector_googlecalendar" },

567# ]

396 568 

397################################################################################569################################################################################

398# Profiles (named presets)570# Profiles (named presets)

401[profiles]573[profiles]

402 574 

403# [profiles.default]575# [profiles.default]

404# model = "gpt-5.2-codex"576# model = "gpt-5.4"

405# model_provider = "openai"577# model_provider = "openai"

406# approval_policy = "on-request"578# approval_policy = "on-request"

407# sandbox_mode = "read-only"579# sandbox_mode = "read-only"

580# service_tier = "flex"

408# oss_provider = "ollama"581# oss_provider = "ollama"

409# model_reasoning_effort = "medium"582# model_reasoning_effort = "medium"

583# plan_mode_reasoning_effort = "high"

410# model_reasoning_summary = "auto"584# model_reasoning_summary = "auto"

411# model_verbosity = "medium"585# model_verbosity = "medium"

412# personality = "friendly" # or "pragmatic" or "none"586# personality = "pragmatic" # or "friendly" or "none"

413# chatgpt_base_url = "https://chatgpt.com/backend-api/"587# chatgpt_base_url = "https://chatgpt.com/backend-api/"

588# model_catalog_json = "./models.json"

589# model_instructions_file = "/absolute/or/relative/path/to/instructions.txt"

414# experimental_compact_prompt_file = "./compact_prompt.txt"590# experimental_compact_prompt_file = "./compact_prompt.txt"

415# include_apply_patch_tool = false591# tools_view_image = true

416# experimental_use_unified_exec_tool = false

417# experimental_use_freeform_apply_patch = false

418# tools.web_search = false # deprecated legacy alias; prefer top-level `web_search`

419# features = { unified_exec = false }592# features = { unified_exec = false }

420 593 

421################################################################################

422# Apps / Connectors

423################################################################################

424 

425# Optional per-app controls.

426[apps]

427# [apps.google_drive]

428# enabled = false

429# disabled_reason = "user" # or "unknown"

430 

431################################################################################594################################################################################

432# Projects (trust levels)595# Projects (trust levels)

433################################################################################596################################################################################

434 597 

435# Mark specific worktrees as trusted or untrusted.

436[projects]598[projects]

599# Mark specific worktrees as trusted or untrusted.

437# [projects."/absolute/path/to/project"]600# [projects."/absolute/path/to/project"]

438# trust_level = "trusted" # or "untrusted"601# trust_level = "trusted" # or "untrusted"

439 602 

603################################################################################

604# Tools

605################################################################################

606 

607[tools]

608# view_image = true

609 

440################################################################################610################################################################################

441# OpenTelemetry (OTEL) - disabled by default611# OpenTelemetry (OTEL) - disabled by default

442################################################################################612################################################################################

450exporter = "none"620exporter = "none"

451# Trace exporter: none (default) | otlp-http | otlp-grpc621# Trace exporter: none (default) | otlp-http | otlp-grpc

452trace_exporter = "none"622trace_exporter = "none"

623# Metrics exporter: none | statsig | otlp-http | otlp-grpc

624metrics_exporter = "statsig"

453 625 

454# Example OTLP/HTTP exporter configuration626# Example OTLP/HTTP exporter configuration

455# [otel.exporter."otlp-http"]627# [otel.exporter."otlp-http"]

459# [otel.exporter."otlp-http".headers]631# [otel.exporter."otlp-http".headers]

460# "x-otlp-api-key" = "${OTLP_TOKEN}"632# "x-otlp-api-key" = "${OTLP_TOKEN}"

461 633 

462# Example OTLP/gRPC exporter configuration

463# [otel.exporter."otlp-grpc"]

464# endpoint = "https://otel.example.com:4317",

465# headers = { "x-otlp-meta" = "abc123" }

466 

467# Example OTLP exporter with mutual TLS

468# [otel.exporter."otlp-http"]

469# endpoint = "https://otel.example.com/v1/logs"

470# protocol = "binary"

471 

472# [otel.exporter."otlp-http".headers]

473# "x-otlp-api-key" = "${OTLP_TOKEN}"

474 

475# [otel.exporter."otlp-http".tls]634# [otel.exporter."otlp-http".tls]

476# ca-certificate = "certs/otel-ca.pem"635# ca-certificate = "certs/otel-ca.pem"

477# client-certificate = "/etc/codex/certs/client.pem"636# client-certificate = "/etc/codex/certs/client.pem"

478# client-private-key = "/etc/codex/certs/client-key.pem"637# client-private-key = "/etc/codex/certs/client-key.pem"

638 

639# Example OTLP/gRPC trace exporter configuration

640# [otel.trace_exporter."otlp-grpc"]

641# endpoint = "https://otel.example.com:4317"

642# headers = { "x-otlp-meta" = "abc123" }

643 

644################################################################################

645# Windows

646################################################################################

647 

648[windows]

649# Native Windows sandbox mode (Windows only): unelevated | elevated

650sandbox = "unelevated"

479```651```