config-sample.md Codex Docs, 2026-03-05 06:22 UTC → 2026-05-18 22:01 UTC

1# Sample Configuration1# Sample Configuration

2 2 

3Use this example configuration as a starting point. It includes most keys Codex reads from `config.toml`, along with defaults and short notes.3Use 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 4 

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

6 6 

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

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

9- [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/security#sandbox-and-approvals)10- [Sandbox and approvals](https://developers.openai.com/codex/agent-approvals-security#sandbox-and-approvals)

11- [Managed configuration](https://developers.openai.com/codex/security#managed-configuration)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. Built-in examples: fast | flex; model catalogs can add more.

48# Uncomment to force values.46# service_tier = "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 override52# 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)53# background_terminal_max_timeout = 300000 # ms; max empty write_stdin poll window (default 5m)

54# 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"

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

59################################################################################59################################################################################

60 60 

61# 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

62model_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"

63 66 

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

65# model_reasoning_summary = "auto"68# model_reasoning_summary = "auto"

66 69 

67# 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

68# model_verbosity = "medium"71# model_verbosity = "medium"

69 72 

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

71# model_supports_reasoning_summaries = true74# model_supports_reasoning_summaries = true

72 75 

73################################################################################76################################################################################

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

78# developer_instructions = ""81# developer_instructions = ""

79 82 

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

81# instructions = ""

82 

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

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

85 85 

86# Override the default commit co-author trailer. This only takes effect when

87# [features].codex_git_commit is enabled. When enabled and unset, Codex uses

88# "Codex <noreply@openai.com>". Set to "" to disable it.

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

90 

86# Override built-in base instructions with a file path. Default: unset.91# Override built-in base instructions with a file path. Default: unset.

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

88 93 

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

90 

91# Load the compact prompt override from a file. Default: unset.94# Load the compact prompt override from a file. Default: unset.

92# experimental_compact_prompt_file = "/absolute/or/relative/path/to/compact_prompt.txt"95# experimental_compact_prompt_file = "/absolute/or/relative/path/to/compact_prompt.txt"

93 96 

94# Legacy name for apply_patch_freeform. Default: false

95include_apply_patch_tool = false

96 

97################################################################################97################################################################################

98# Notifications98# Notifications

99################################################################################99################################################################################

100 100 

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

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

103notify = [ ]

104 103 

105################################################################################104################################################################################

106# Approval & Sandbox105# Approval & Sandbox

110# - untrusted: only known-safe read-only commands auto-run; others prompt109# - untrusted: only known-safe read-only commands auto-run; others prompt

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

112# - never: never prompt (risky)111# - never: never prompt (risky)

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

114approval_policy = "on-request"113approval_policy = "on-request"

115# Example granular auto-reject policy:114# Who reviews eligible approval prompts: user (default) | auto_review

116# approval_policy = { reject = { sandbox_approval = true, rules = false, mcp_elicitations = false } }115# approvals_reviewer = "user"

116 

117# Example granular policy:

118# approval_policy = { granular = {

119# sandbox_approval = true,

120# rules = true,

121# mcp_elicitations = true,

122# request_permissions = false,

123# skill_approval = false

124# } }

117 125 

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

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

124# - workspace-write132# - workspace-write

125# - danger-full-access (no sandbox; extremely risky)133# - danger-full-access (no sandbox; extremely risky)

126sandbox_mode = "read-only"134sandbox_mode = "read-only"

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

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

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

138# default_permissions = ":workspace"

127 139 

128[windows]140# Example filesystem profile. Use `"none"` to deny reads for exact paths or

129# Native Windows sandbox mode (Windows only): unelevated | elevated141# glob patterns. On platforms that need pre-expanded glob matches, set

130sandbox = "unelevated"142# glob_scan_max_depth when using unbounded patterns such as `**`.

143# [permissions.workspace.filesystem]

144# glob_scan_max_depth = 3

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

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

131 147 

132################################################################################148################################################################################

133# Authentication & Login149# Authentication & Login

136# Where to persist CLI login credentials: file (default) | keyring | auto152# Where to persist CLI login credentials: file (default) | keyring | auto

137cli_auth_credentials_store = "file"153cli_auth_credentials_store = "file"

138 154 

139# Base URL for ChatGPT auth flow (not OpenAI API). Default:155# Base URL for ChatGPT auth flow (not OpenAI API).

140chatgpt_base_url = "https://chatgpt.com/backend-api/"156chatgpt_base_url = "https://chatgpt.com/backend-api/"

141 157 

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

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

160 

142# Restrict ChatGPT login to a specific workspace id. Default: unset.161# Restrict ChatGPT login to a specific workspace id. Default: unset.

143# forced_chatgpt_workspace_id = ""162# forced_chatgpt_workspace_id = "00000000-0000-0000-0000-000000000000"

144 163 

145# Force login mechanism when Codex would normally auto-select. Default: unset.164# Force login mechanism when Codex would normally auto-select. Default: unset.

146# Allowed values: chatgpt | api165# Allowed values: chatgpt | api

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

206web_search = "cached"223web_search = "cached"

207 224 

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

209# Profiles (named presets)

210################################################################################

211 

212# Active profile name. When unset, no profile is applied.225# Active profile name. When unset, no profile is applied.

213# profile = "default"226# profile = "default"

214 227 

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

229# suppress_unstable_features_warning = true

230 

215################################################################################231################################################################################

216# Agents (multi-agent roles and limits)232# Agents (multi-agent roles and limits)

217################################################################################233################################################################################

218 234 

219# [agents]235[agents]

220# Maximum concurrently open agent threads. Default: 6236# Maximum concurrently open agent threads. Default: 6

221# max_threads = 6237# max_threads = 6

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

225# job_max_runtime_seconds = 1800241# job_max_runtime_seconds = 1800

226 242 

227# [agents.reviewer]243# [agents.reviewer]

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

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

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

230 247 

231################################################################################248################################################################################

232# Skills (per-skill overrides)249# Skills (per-skill overrides)

237# path = "/path/to/skill/SKILL.md"254# path = "/path/to/skill/SKILL.md"

238# enabled = false255# enabled = false

239 256 

240################################################################################

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

242################################################################################

243 

244experimental_use_unified_exec_tool = false

245 

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

247experimental_use_freeform_apply_patch = false

248 

249################################################################################257################################################################################

250# Sandbox settings (tables)258# Sandbox settings (tables)

251################################################################################259################################################################################

268[shell_environment_policy]276[shell_environment_policy]

269# inherit: all (default) | core | none277# inherit: all (default) | core | none

270inherit = "all"278inherit = "all"

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

272ignore_default_excludes = true280ignore_default_excludes = false

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

274exclude = []282exclude = []

275# Explicit key/value overrides (always win). Default: {}283# Explicit key/value overrides (always win). Default: {}

279# Experimental: run via user shell profile. Default: false287# Experimental: run via user shell profile. Default: false

280experimental_use_profile = false288experimental_use_profile = false

281 289 

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

291# Sandboxed networking settings

292################################################################################

293 

294# Enable the feature before configuring sandboxed networking rules.

295# [features.network_proxy]

296# enabled = true

297# domains = { "api.openai.com" = "allow", "example.com" = "deny" }

298#

299# Exact hosts match only themselves.

300# "*.example.com" matches subdomains only; "**.example.com" matches the apex plus subdomains.

301# "*" allows any public host that is not denied, so prefer scoped rules when possible.

302# `allow_local_binding = false` blocks loopback and private destinations by default.

303# Add an exact local IP literal or `localhost` allow rule for one target, or set it to true only when broader local access is required.

304#

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

306# [permissions.workspace.network]

307# enabled = true

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

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

310# enable_socks5 = false

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

312# enable_socks5_udp = false

313# allow_upstream_proxy = false

314# dangerously_allow_non_loopback_proxy = false

315# dangerously_allow_non_loopback_admin = false

316# dangerously_allow_all_unix_sockets = false

317# allow_local_binding = false

318#

319# [permissions.workspace.network.domains]

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

321# "example.com" = "deny"

322#

323# [permissions.workspace.network.unix_sockets]

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

325 

282################################################################################326################################################################################

283# History (table)327# History (table)

284################################################################################328################################################################################

287# save-all (default) | none331# save-all (default) | none

288persistence = "save-all"332persistence = "save-all"

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

290# max_bytes = 0334# max_bytes = 5242880

291 335 

292################################################################################336################################################################################

293# UI, Notifications, and Misc (tables)337# UI, Notifications, and Misc (tables)

301# Notification mechanism for terminal alerts: auto | osc9 | bel. Default: "auto"345# Notification mechanism for terminal alerts: auto | osc9 | bel. Default: "auto"

302# notification_method = "auto"346# notification_method = "auto"

303 347 

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

349# notification_condition = "unfocused"

350 

304# Enables welcome/status/spinner animations. Default: true351# Enables welcome/status/spinner animations. Default: true

305animations = true352animations = true

306 353 

315# Set to [] to hide the footer.362# Set to [] to hide the footer.

316# status_line = ["model", "context-remaining", "git-branch"]363# status_line = ["model", "context-remaining", "git-branch"]

317 364 

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

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

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

368# and task-progress.

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

370 

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

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

320# theme = "catppuccin-mocha"373# theme = "catppuccin-mocha"

321 374 

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

376# Use [] to unbind an action.

377# [tui.keymap.global]

378# open_transcript = "ctrl-t"

379# open_external_editor = []

380#

381# [tui.keymap.composer]

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

383 

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

385# [tui.model_availability_nux]

386# "gpt-5.4" = 1

387 

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

389[analytics]

390enabled = true

391 

322# Control whether users can submit feedback from `/feedback`. Default: true392# Control whether users can submit feedback from `/feedback`. Default: true

323[feedback]393[feedback]

324enabled = true394enabled = true

330# hide_rate_limit_model_nudge = true400# hide_rate_limit_model_nudge = true

331# hide_gpt5_1_migration_prompt = true401# hide_gpt5_1_migration_prompt = true

332# "hide_gpt-5.1-codex-max_migration_prompt" = true402# "hide_gpt-5.1-codex-max_migration_prompt" = true

333# model_migrations = { "gpt-4.1" = "gpt-5.1" }403# model_migrations = { "gpt-5.3-codex" = "gpt-5.4" }

334 

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

336# suppress_unstable_features_warning = true

337 404 

338################################################################################405################################################################################

339# Centralized Feature Flags (preferred)406# Centralized Feature Flags (preferred)

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

344# shell_tool = true411# shell_tool = true

345# apps = false412# apps = false

346# apps_mcp_gateway = false413# hooks = false

347# web_search_cached = false414# plugin_hooks = false # Default off; set true to opt into plugin-bundled hooks.

348# web_search_request = false415# codex_git_commit = false

349# unified_exec = false416# unified_exec = true

350# shell_snapshot = false417# shell_snapshot = true

351# apply_patch_freeform = false418# multi_agent = true

352# multi_agent = false

353# search_tool = false

354# personality = true419# personality = true

355# request_rule = true420# network_proxy = false

356# collaboration_modes = true421# fast_mode = true

357# use_linux_sandbox_bwrap = false422# enable_request_compression = true

358# remote_models = false423# skill_mcp_dependency_install = true

359# runtime_metrics = false424# prevent_idle_sleep = false

360# powershell_utf8 = true425 

361# child_agents_md = false426################################################################################

427# Memories (table)

428################################################################################

429 

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

431# [memories]

432# generate_memories = true

433# use_memories = true

434# disable_on_external_context = false # legacy alias: no_memories_if_mcp_or_web_search

435 

436################################################################################

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

438################################################################################

439 

440# [hooks]

441# [[hooks.PreToolUse]]

442# matcher = "^Bash$"

443#

444# [[hooks.PreToolUse.hooks]]

445# type = "command"

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

447# timeout = 30

448# statusMessage = "Checking Bash command"

362 449 

363################################################################################450################################################################################

364# Define MCP servers under this table. Leave empty to disable.451# Define MCP servers under this table. Leave empty to disable.

373# command = "docs-server" # required460# command = "docs-server" # required

374# args = ["--port", "4000"] # optional461# args = ["--port", "4000"] # optional

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

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

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

377# cwd = "/path/to/server" # optional working directory override465# cwd = "/path/to/server" # optional working directory override

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

378# startup_timeout_sec = 10.0 # optional; default 10.0 seconds467# startup_timeout_sec = 10.0 # optional; default 10.0 seconds

379# # startup_timeout_ms = 10000 # optional alias for startup timeout (milliseconds)468# # startup_timeout_ms = 10000 # optional alias for startup timeout (milliseconds)

380# tool_timeout_sec = 60.0 # optional; default 60.0 seconds469# tool_timeout_sec = 60.0 # optional; default 60.0 seconds

381# enabled_tools = ["search", "summarize"] # optional allow-list470# enabled_tools = ["search", "summarize"] # optional allow-list

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

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

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

383 474 

384# --- Example: Streamable HTTP transport ---475# --- Example: Streamable HTTP transport ---

385# [mcp_servers.github]476# [mcp_servers.github]

392# startup_timeout_sec = 10.0 # optional483# startup_timeout_sec = 10.0 # optional

393# tool_timeout_sec = 60.0 # optional484# tool_timeout_sec = 60.0 # optional

394# enabled_tools = ["list_issues"] # optional allow-list485# enabled_tools = ["list_issues"] # optional allow-list

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

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

395 488 

396################################################################################489################################################################################

397# Model Providers490# Model Providers

398################################################################################491################################################################################

399 492 

400# Built-ins include:493# Built-ins include:

401# - openai (Responses API; requires login or OPENAI_API_KEY via auth flow)494# - openai

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

496# - lmstudio

497# - amazon-bedrock

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

403 499 

404[model_providers]500[model_providers]

405 501 

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

503# model_provider = "amazon-bedrock"

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

505# [model_providers.amazon-bedrock.aws]

506# profile = "default"

507# region = "eu-central-1"

508 

406# --- Example: OpenAI data residency with explicit base URL or headers ---509# --- Example: OpenAI data residency with explicit base URL or headers ---

407# [model_providers.openaidr]510# [model_providers.openaidr]

408# name = "OpenAI Data Residency"511# name = "OpenAI Data Residency"

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

410# wire_api = "responses" # "responses" | "chat" (default varies)513# wire_api = "responses" # only supported value

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

412# # request_max_retries = 4 # default 4; max 100515# # request_max_retries = 4 # default 4; max 100

413# # stream_max_retries = 5 # default 5; max 100516# # stream_max_retries = 5 # default 5; max 100

414# # stream_idle_timeout_ms = 300000 # default 300_000 (5m)517# # stream_idle_timeout_ms = 300000 # default 300_000 (5m)

518# # supports_websockets = true # optional

415# # experimental_bearer_token = "sk-example" # optional dev-only direct bearer token519# # experimental_bearer_token = "sk-example" # optional dev-only direct bearer token

416# # http_headers = { "X-Example" = "value" }520# # http_headers = { "X-Example" = "value" }

417# # env_http_headers = { "OpenAI-Organization" = "OPENAI_ORGANIZATION", "OpenAI-Project" = "OPENAI_PROJECT" }521# # env_http_headers = { "OpenAI-Organization" = "OPENAI_ORGANIZATION", "OpenAI-Project" = "OPENAI_PROJECT" }

418 522 

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

420# [model_providers.azure]524# [model_providers.azure]

421# name = "Azure"525# name = "Azure"

422# base_url = "https://YOUR_PROJECT_NAME.openai.azure.com/openai"526# base_url = "https://YOUR_PROJECT_NAME.openai.azure.com/openai"

423# wire_api = "responses" # or "chat" per endpoint527# wire_api = "responses"

424# query_params = { api-version = "2025-04-01-preview" }528# query_params = { api-version = "2025-04-01-preview" }

425# env_key = "AZURE_OPENAI_API_KEY"529# env_key = "AZURE_OPENAI_API_KEY"

426# # env_key_instructions = "Set AZURE_OPENAI_API_KEY in your environment"530# env_key_instructions = "Set AZURE_OPENAI_API_KEY in your environment"

531# # supports_websockets = false

532 

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

534# [model_providers.proxy]

535# name = "OpenAI using LLM proxy"

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

537# wire_api = "responses"

538#

539# [model_providers.proxy.auth]

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

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

542# timeout_ms = 5000

543# refresh_interval_ms = 300000

427 544 

428# --- Example: Local OSS (e.g., Ollama-compatible) ---545# --- Example: Local OSS (e.g., Ollama-compatible) ---

429# [model_providers.ollama]546# [model_providers.local_ollama]

430# name = "Ollama"547# name = "Ollama"

431# base_url = "http://localhost:11434/v1"548# base_url = "http://localhost:11434/v1"

432# wire_api = "chat"549# wire_api = "responses"

433 

434################################################################################

435# Profiles (named presets)

436################################################################################

437 

438[profiles]

439 

440# [profiles.default]

441# model = "gpt-5.2-codex"

442# model_provider = "openai"

443# approval_policy = "on-request"

444# sandbox_mode = "read-only"

445# oss_provider = "ollama"

446# model_reasoning_effort = "medium"

447# model_reasoning_summary = "auto"

448# model_verbosity = "medium"

449# personality = "friendly" # or "pragmatic" or "none"

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

451# model_catalog_json = "./models.json"

452# experimental_compact_prompt_file = "./compact_prompt.txt"

453# include_apply_patch_tool = false

454# experimental_use_unified_exec_tool = false

455# experimental_use_freeform_apply_patch = false

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

457# features = { unified_exec = false }

458 550 

459################################################################################551################################################################################

460# Apps / Connectors552# Apps / Connectors

478# enabled = false570# enabled = false

479# approval_mode = "approve"571# approval_mode = "approve"

480 572 

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

574# [tool_suggest]

575# discoverables = [

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

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

578# ]

579# disabled_tools = [

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

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

582# ]

583 

584################################################################################

585# Profiles (named presets)

586################################################################################

587 

588[profiles]

589 

590# [profiles.default]

591# model = "gpt-5.4"

592# model_provider = "openai"

593# approval_policy = "on-request"

594# sandbox_mode = "read-only"

595# service_tier = "flex" # or another supported service tier id

596# oss_provider = "ollama"

597# model_reasoning_effort = "medium"

598# plan_mode_reasoning_effort = "high"

599# model_reasoning_summary = "auto"

600# model_verbosity = "medium"

601# personality = "pragmatic" # or "friendly" or "none"

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

603# model_catalog_json = "./models.json"

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

605# experimental_compact_prompt_file = "./compact_prompt.txt"

606# tools_view_image = true

607# features = { unified_exec = false }

608 

481################################################################################609################################################################################

482# Projects (trust levels)610# Projects (trust levels)

483################################################################################611################################################################################

484 612 

485# Mark specific worktrees as trusted or untrusted.

486[projects]613[projects]

614# Mark specific worktrees as trusted or untrusted.

487# [projects."/absolute/path/to/project"]615# [projects."/absolute/path/to/project"]

488# trust_level = "trusted" # or "untrusted"616# trust_level = "trusted" # or "untrusted"

489 617 

618################################################################################

619# Tools

620################################################################################

621 

622[tools]

623# view_image = true

624 

490################################################################################625################################################################################

491# OpenTelemetry (OTEL) - disabled by default626# OpenTelemetry (OTEL) - disabled by default

492################################################################################627################################################################################

500exporter = "none"635exporter = "none"

501# Trace exporter: none (default) | otlp-http | otlp-grpc636# Trace exporter: none (default) | otlp-http | otlp-grpc

502trace_exporter = "none"637trace_exporter = "none"

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

639metrics_exporter = "statsig"

503 640 

504# Example OTLP/HTTP exporter configuration641# Example OTLP/HTTP exporter configuration

505# [otel.exporter."otlp-http"]642# [otel.exporter."otlp-http"]

509# [otel.exporter."otlp-http".headers]646# [otel.exporter."otlp-http".headers]

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

511 648 

512# Example OTLP/gRPC exporter configuration

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

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

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

516 

517# Example OTLP exporter with mutual TLS

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

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

520# protocol = "binary"

521 

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

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

524 

525# [otel.exporter."otlp-http".tls]649# [otel.exporter."otlp-http".tls]

526# ca-certificate = "certs/otel-ca.pem"650# ca-certificate = "certs/otel-ca.pem"

527# client-certificate = "/etc/codex/certs/client.pem"651# client-certificate = "/etc/codex/certs/client.pem"

528# client-private-key = "/etc/codex/certs/client-key.pem"652# client-private-key = "/etc/codex/certs/client-key.pem"

529```

530 653 

531################################################################################654# Example OTLP/gRPC trace exporter configuration

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

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

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

532 658 

659################################################################################

533# Windows660# Windows

534 

535################################################################################661################################################################################

536 662 

537[windows]663[windows]

538 

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

540 

541sandbox = "unelevated"665sandbox = "unelevated"

666```