config-sample.md Codex Docs, 2026-02-24 06:27 UTC → 2026-05-13 00:57 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. `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 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"

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

55 56 

56################################################################################57################################################################################

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

58################################################################################59################################################################################

59 60 

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

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

62 66 

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

64# model_reasoning_summary = "auto"68# model_reasoning_summary = "auto"

65 69 

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

67# model_verbosity = "medium"71# model_verbosity = "medium"

68 72 

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

70# model_supports_reasoning_summaries = true74# model_supports_reasoning_summaries = true

71 75 

72################################################################################76################################################################################

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

77# developer_instructions = ""81# developer_instructions = ""

78 82 

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

80# instructions = ""

81 

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

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

84 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 

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

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

87 93 

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

89 

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

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

92 96 

93# Legacy name for apply_patch_freeform. Default: false

94include_apply_patch_tool = false

95 

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

97# Notifications98# Notifications

98################################################################################99################################################################################

99 100 

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

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

102notify = [ ]

103 103 

104################################################################################104################################################################################

105# Approval & Sandbox105# Approval & Sandbox

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

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

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

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

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

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

115# 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# } }

116 125 

117# 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`.

118# 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.

123# - workspace-write132# - workspace-write

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

125sandbox_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"

139 

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

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

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"

126 147 

127################################################################################148################################################################################

128# Authentication & Login149# Authentication & Login

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

132cli_auth_credentials_store = "file"153cli_auth_credentials_store = "file"

133 154 

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

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

136 157 

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

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

160 

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

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

139 163 

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

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

200# 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.

201web_search = "cached"223web_search = "cached"

202 224 

203################################################################################

204# Profiles (named presets)

205################################################################################

206 

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

208# profile = "default"226# profile = "default"

209 227 

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

229# suppress_unstable_features_warning = true

230 

210################################################################################231################################################################################

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

212################################################################################233################################################################################

213 234 

214# [agents]235[agents]

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

216# max_threads = 6237# max_threads = 6

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

218# max_depth = 1239# max_depth = 1

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

241# job_max_runtime_seconds = 1800

219 242 

220# [agents.reviewer]243# [agents.reviewer]

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

222# 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"]

223 247 

224################################################################################248################################################################################

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

227 251 

228# Disable or re-enable a specific skill without deleting it.252# Disable or re-enable a specific skill without deleting it.

229[[skills.config]]253[[skills.config]]

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

231# enabled = false255# enabled = false

232 256 

233################################################################################

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

235################################################################################

236 

237experimental_use_unified_exec_tool = false

238 

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

240experimental_use_freeform_apply_patch = false

241 

242################################################################################257################################################################################

243# Sandbox settings (tables)258# Sandbox settings (tables)

244################################################################################259################################################################################

261[shell_environment_policy]276[shell_environment_policy]

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

263inherit = "all"278inherit = "all"

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

265ignore_default_excludes = true280ignore_default_excludes = false

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

267exclude = []282exclude = []

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

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

273experimental_use_profile = false288experimental_use_profile = false

274 289 

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

291# Managed network proxy settings

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

293 

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

295# [permissions.workspace.network]

296# enabled = true

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

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

299# enable_socks5 = false

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

301# enable_socks5_udp = false

302# allow_upstream_proxy = false

303# dangerously_allow_non_loopback_proxy = false

304# dangerously_allow_non_loopback_admin = false

305# dangerously_allow_all_unix_sockets = false

306# mode = "limited" # limited | full

307# allow_local_binding = false

308#

309# [permissions.workspace.network.domains]

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

311# "example.com" = "deny"

312#

313# [permissions.workspace.network.unix_sockets]

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

315 

275################################################################################316################################################################################

276# History (table)317# History (table)

277################################################################################318################################################################################

280# save-all (default) | none321# save-all (default) | none

281persistence = "save-all"322persistence = "save-all"

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

283# max_bytes = 0324# max_bytes = 5242880

284 325 

285################################################################################326################################################################################

286# UI, Notifications, and Misc (tables)327# UI, Notifications, and Misc (tables)

294# Notification mechanism for terminal alerts: auto | osc9 | bel. Default: "auto"335# Notification mechanism for terminal alerts: auto | osc9 | bel. Default: "auto"

295# notification_method = "auto"336# notification_method = "auto"

296 337 

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

339# notification_condition = "unfocused"

340 

297# Enables welcome/status/spinner animations. Default: true341# Enables welcome/status/spinner animations. Default: true

298animations = true342animations = true

299 343 

308# Set to [] to hide the footer.352# Set to [] to hide the footer.

309# status_line = ["model", "context-remaining", "git-branch"]353# status_line = ["model", "context-remaining", "git-branch"]

310 354 

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

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

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

358# and task-progress.

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

360 

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

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

313# theme = "catppuccin-mocha"363# theme = "catppuccin-mocha"

314 364 

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

366# Use [] to unbind an action.

367# [tui.keymap.global]

368# open_transcript = "ctrl-t"

369# open_external_editor = []

370#

371# [tui.keymap.composer]

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

373 

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

375# [tui.model_availability_nux]

376# "gpt-5.4" = 1

377 

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

379[analytics]

380enabled = true

381 

315# Control whether users can submit feedback from `/feedback`. Default: true382# Control whether users can submit feedback from `/feedback`. Default: true

316[feedback]383[feedback]

317enabled = true384enabled = true

323# hide_rate_limit_model_nudge = true390# hide_rate_limit_model_nudge = true

324# hide_gpt5_1_migration_prompt = true391# hide_gpt5_1_migration_prompt = true

325# "hide_gpt-5.1-codex-max_migration_prompt" = true392# "hide_gpt-5.1-codex-max_migration_prompt" = true

326# model_migrations = { "gpt-4.1" = "gpt-5.1" }393# model_migrations = { "gpt-5.3-codex" = "gpt-5.4" }

327 

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

329# suppress_unstable_features_warning = true

330 394 

331################################################################################395################################################################################

332# Centralized Feature Flags (preferred)396# Centralized Feature Flags (preferred)

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

337# shell_tool = true401# shell_tool = true

338# apps = false402# apps = false

339# apps_mcp_gateway = false403# codex_git_commit = false

340# web_search_cached = false404# codex_hooks = false

341# web_search_request = false405# unified_exec = true

342# unified_exec = false406# shell_snapshot = true

343# shell_snapshot = false407# multi_agent = true

344# apply_patch_freeform = false

345# multi_agent = false

346# search_tool = false

347# personality = true408# personality = true

348# request_rule = true409# fast_mode = true

349# collaboration_modes = true410# enable_request_compression = true

350# use_linux_sandbox_bwrap = false411# skill_mcp_dependency_install = true

351# remote_models = false412# prevent_idle_sleep = false

352# runtime_metrics = false413 

353# powershell_utf8 = true414################################################################################

354# child_agents_md = false415# Memories (table)

416################################################################################

417 

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

419# [memories]

420# generate_memories = true

421# use_memories = true

422# disable_on_external_context = false # legacy alias: no_memories_if_mcp_or_web_search

423 

424################################################################################

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

426################################################################################

427 

428# [hooks]

429# [[hooks.PreToolUse]]

430# matcher = "^Bash$"

431#

432# [[hooks.PreToolUse.hooks]]

433# type = "command"

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

435# timeout = 30

436# statusMessage = "Checking Bash command"

355 437 

356################################################################################438################################################################################

357# Define MCP servers under this table. Leave empty to disable.439# Define MCP servers under this table. Leave empty to disable.

366# command = "docs-server" # required448# command = "docs-server" # required

367# args = ["--port", "4000"] # optional449# args = ["--port", "4000"] # optional

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

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

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

370# cwd = "/path/to/server" # optional working directory override453# cwd = "/path/to/server" # optional working directory override

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

371# startup_timeout_sec = 10.0 # optional; default 10.0 seconds455# startup_timeout_sec = 10.0 # optional; default 10.0 seconds

372# # startup_timeout_ms = 10000 # optional alias for startup timeout (milliseconds)456# # startup_timeout_ms = 10000 # optional alias for startup timeout (milliseconds)

373# tool_timeout_sec = 60.0 # optional; default 60.0 seconds457# tool_timeout_sec = 60.0 # optional; default 60.0 seconds

374# enabled_tools = ["search", "summarize"] # optional allow-list458# enabled_tools = ["search", "summarize"] # optional allow-list

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

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

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

376 462 

377# --- Example: Streamable HTTP transport ---463# --- Example: Streamable HTTP transport ---

378# [mcp_servers.github]464# [mcp_servers.github]

385# startup_timeout_sec = 10.0 # optional471# startup_timeout_sec = 10.0 # optional

386# tool_timeout_sec = 60.0 # optional472# tool_timeout_sec = 60.0 # optional

387# enabled_tools = ["list_issues"] # optional allow-list473# enabled_tools = ["list_issues"] # optional allow-list

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

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

388 476 

389################################################################################477################################################################################

390# Model Providers478# Model Providers

391################################################################################479################################################################################

392 480 

393# Built-ins include:481# Built-ins include:

394# - openai (Responses API; requires login or OPENAI_API_KEY via auth flow)482# - openai

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

484# - lmstudio

485# - amazon-bedrock

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

396 487 

397[model_providers]488[model_providers]

398 489 

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

491# model_provider = "amazon-bedrock"

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

493# [model_providers.amazon-bedrock.aws]

494# profile = "default"

495# region = "eu-central-1"

496 

399# --- Example: OpenAI data residency with explicit base URL or headers ---497# --- Example: OpenAI data residency with explicit base URL or headers ---

400# [model_providers.openaidr]498# [model_providers.openaidr]

401# name = "OpenAI Data Residency"499# name = "OpenAI Data Residency"

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

403# wire_api = "responses" # "responses" | "chat" (default varies)501# wire_api = "responses" # only supported value

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

405# # request_max_retries = 4 # default 4; max 100503# # request_max_retries = 4 # default 4; max 100

406# # stream_max_retries = 5 # default 5; max 100504# # stream_max_retries = 5 # default 5; max 100

407# # stream_idle_timeout_ms = 300000 # default 300_000 (5m)505# # stream_idle_timeout_ms = 300000 # default 300_000 (5m)

506# # supports_websockets = true # optional

408# # experimental_bearer_token = "sk-example" # optional dev-only direct bearer token507# # experimental_bearer_token = "sk-example" # optional dev-only direct bearer token

409# # http_headers = { "X-Example" = "value" }508# # http_headers = { "X-Example" = "value" }

410# # env_http_headers = { "OpenAI-Organization" = "OPENAI_ORGANIZATION", "OpenAI-Project" = "OPENAI_PROJECT" }509# # env_http_headers = { "OpenAI-Organization" = "OPENAI_ORGANIZATION", "OpenAI-Project" = "OPENAI_PROJECT" }

411 510 

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

413# [model_providers.azure]512# [model_providers.azure]

414# name = "Azure"513# name = "Azure"

415# base_url = "https://YOUR_PROJECT_NAME.openai.azure.com/openai"514# base_url = "https://YOUR_PROJECT_NAME.openai.azure.com/openai"

416# wire_api = "responses" # or "chat" per endpoint515# wire_api = "responses"

417# query_params = { api-version = "2025-04-01-preview" }516# query_params = { api-version = "2025-04-01-preview" }

418# env_key = "AZURE_OPENAI_API_KEY"517# env_key = "AZURE_OPENAI_API_KEY"

419# # env_key_instructions = "Set AZURE_OPENAI_API_KEY in your environment"518# env_key_instructions = "Set AZURE_OPENAI_API_KEY in your environment"

519# # supports_websockets = false

520 

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

522# [model_providers.proxy]

523# name = "OpenAI using LLM proxy"

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

525# wire_api = "responses"

526#

527# [model_providers.proxy.auth]

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

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

530# timeout_ms = 5000

531# refresh_interval_ms = 300000

420 532 

421# --- Example: Local OSS (e.g., Ollama-compatible) ---533# --- Example: Local OSS (e.g., Ollama-compatible) ---

422# [model_providers.ollama]534# [model_providers.local_ollama]

423# name = "Ollama"535# name = "Ollama"

424# base_url = "http://localhost:11434/v1"536# base_url = "http://localhost:11434/v1"

425# wire_api = "chat"537# wire_api = "responses"

426 

427################################################################################

428# Profiles (named presets)

429################################################################################

430 

431[profiles]

432 

433# [profiles.default]

434# model = "gpt-5.2-codex"

435# model_provider = "openai"

436# approval_policy = "on-request"

437# sandbox_mode = "read-only"

438# oss_provider = "ollama"

439# model_reasoning_effort = "medium"

440# model_reasoning_summary = "auto"

441# model_verbosity = "medium"

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

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

444# model_catalog_json = "./models.json"

445# experimental_compact_prompt_file = "./compact_prompt.txt"

446# include_apply_patch_tool = false

447# experimental_use_unified_exec_tool = false

448# experimental_use_freeform_apply_patch = false

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

450# features = { unified_exec = false }

451 538 

452################################################################################539################################################################################

453# Apps / Connectors540# Apps / Connectors

471# enabled = false558# enabled = false

472# approval_mode = "approve"559# approval_mode = "approve"

473 560 

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

562# [tool_suggest]

563# discoverables = [

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

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

566# ]

567# disabled_tools = [

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

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

570# ]

571 

572################################################################################

573# Profiles (named presets)

574################################################################################

575 

576[profiles]

577 

578# [profiles.default]

579# model = "gpt-5.4"

580# model_provider = "openai"

581# approval_policy = "on-request"

582# sandbox_mode = "read-only"

583# service_tier = "flex"

584# oss_provider = "ollama"

585# model_reasoning_effort = "medium"

586# plan_mode_reasoning_effort = "high"

587# model_reasoning_summary = "auto"

588# model_verbosity = "medium"

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

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

591# model_catalog_json = "./models.json"

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

593# experimental_compact_prompt_file = "./compact_prompt.txt"

594# tools_view_image = true

595# features = { unified_exec = false }

596 

474################################################################################597################################################################################

475# Projects (trust levels)598# Projects (trust levels)

476################################################################################599################################################################################

477 600 

478# Mark specific worktrees as trusted or untrusted.

479[projects]601[projects]

602# Mark specific worktrees as trusted or untrusted.

480# [projects."/absolute/path/to/project"]603# [projects."/absolute/path/to/project"]

481# trust_level = "trusted" # or "untrusted"604# trust_level = "trusted" # or "untrusted"

482 605 

606################################################################################

607# Tools

608################################################################################

609 

610[tools]

611# view_image = true

612 

483################################################################################613################################################################################

484# OpenTelemetry (OTEL) - disabled by default614# OpenTelemetry (OTEL) - disabled by default

485################################################################################615################################################################################

493exporter = "none"623exporter = "none"

494# Trace exporter: none (default) | otlp-http | otlp-grpc624# Trace exporter: none (default) | otlp-http | otlp-grpc

495trace_exporter = "none"625trace_exporter = "none"

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

627metrics_exporter = "statsig"

496 628 

497# Example OTLP/HTTP exporter configuration629# Example OTLP/HTTP exporter configuration

498# [otel.exporter."otlp-http"]630# [otel.exporter."otlp-http"]

502# [otel.exporter."otlp-http".headers]634# [otel.exporter."otlp-http".headers]

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

504 636 

505# Example OTLP/gRPC exporter configuration

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

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

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

509 

510# Example OTLP exporter with mutual TLS

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

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

513# protocol = "binary"

514 

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

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

517 

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

519# ca-certificate = "certs/otel-ca.pem"638# ca-certificate = "certs/otel-ca.pem"

520# client-certificate = "/etc/codex/certs/client.pem"639# client-certificate = "/etc/codex/certs/client.pem"

521# client-private-key = "/etc/codex/certs/client-key.pem"640# client-private-key = "/etc/codex/certs/client-key.pem"

522```

523 641 

524################################################################################642# Example OTLP/gRPC trace exporter configuration

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

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

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

525 646 

647################################################################################

526# Windows648# Windows

527 

528################################################################################649################################################################################

529 650 

530[windows]651[windows]

531 

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

533 

534sandbox = "unelevated"653sandbox = "unelevated"

654```