config-sample.md Codex Docs, 2026-03-07 06:14 UTC → 2026-04-07 00:40 UTC

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, along with default18# This file lists the main keys Codex reads from config.toml, along with default

19# behaviors, recommended examples, and concise explanations. Adjust as needed.19# behaviors, recommended examples, and concise explanations. Adjust as needed.

20#20#

21# Notes21# Notes

30# Primary model used by Codex. Recommended example for most users: "gpt-5.4".30# Primary model used by Codex. Recommended example for most users: "gpt-5.4".

31model = "gpt-5.4"31model = "gpt-5.4"

32 32 

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

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

35# personality = "friendly"

36 35 

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

38# review_model = "gpt-5.4"37# review_model = "gpt-5.4"

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

44# oss_provider = "ollama"43# oss_provider = "ollama"

45 44 

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

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

47 

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

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

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

50# tool_output_token_limit = 10000 # tokens stored per tool output51# tool_output_token_limit = 12000 # tokens stored per tool output

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

52# 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)

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

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` availability is model-dependent)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. Set to "" to disable it.

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

88 

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

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

87 91 

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.92# Load the compact prompt override from a file. Default: unset.

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

92 94 

93# Legacy name for apply_patch_freeform. Default: false

94include_apply_patch_tool = false

95 

96################################################################################95################################################################################

97# Notifications96# Notifications

98################################################################################97################################################################################

99 98 

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

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

102notify = [ ]

103 101 

104################################################################################102################################################################################

105# Approval & Sandbox103# Approval & Sandbox

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

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

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

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

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

114# Example granular auto-reject policy:112# Example granular policy:

115# approval_policy = { reject = { sandbox_approval = true, rules = false, mcp_elicitations = false } }113# approval_policy = { granular = {

114# sandbox_approval = true,

115# rules = true,

116# mcp_elicitations = true,

117# request_permissions = false,

118# skill_approval = false

119# } }

116 120 

117# Allow login-shell semantics for shell-based tools when they request `login = true`.121# 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.122# Default: true. Set false to force non-login shells and reject explicit login-shell requests.

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

125sandbox_mode = "read-only"129sandbox_mode = "read-only"

126 130 

127[windows]

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

129sandbox = "unelevated"

130 

131################################################################################131################################################################################

132# Authentication & Login132# Authentication & Login

133################################################################################133################################################################################

135# Where to persist CLI login credentials: file (default) | keyring | auto135# Where to persist CLI login credentials: file (default) | keyring | auto

136cli_auth_credentials_store = "file"136cli_auth_credentials_store = "file"

137 137 

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

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

140 140 

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

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

143 

141# Restrict ChatGPT login to a specific workspace id. Default: unset.144# Restrict ChatGPT login to a specific workspace id. Default: unset.

142# forced_chatgpt_workspace_id = ""145# forced_chatgpt_workspace_id = "00000000-0000-0000-0000-000000000000"

143 146 

144# Force login mechanism when Codex would normally auto-select. Default: unset.147# Force login mechanism when Codex would normally auto-select. Default: unset.

145# Allowed values: chatgpt | api148# Allowed values: chatgpt | api

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

205web_search = "cached"206web_search = "cached"

206 207 

207################################################################################

208# Profiles (named presets)

209################################################################################

210 

211# Active profile name. When unset, no profile is applied.208# Active profile name. When unset, no profile is applied.

212# profile = "default"209# profile = "default"

213 210 

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

212# suppress_unstable_features_warning = true

213 

214################################################################################214################################################################################

215# Agents (multi-agent roles and limits)215# Agents (multi-agent roles and limits)

216################################################################################216################################################################################

217 217 

218# [agents]218[agents]

219# Maximum concurrently open agent threads. Default: 6219# Maximum concurrently open agent threads. Default: 6

220# max_threads = 6220# max_threads = 6

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

224# job_max_runtime_seconds = 1800224# job_max_runtime_seconds = 1800

225 225 

226# [agents.reviewer]226# [agents.reviewer]

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

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

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

229 230 

230################################################################################231################################################################################

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

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

237# enabled = false238# enabled = false

238 239 

239################################################################################

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

241################################################################################

242 

243experimental_use_unified_exec_tool = false

244 

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

246experimental_use_freeform_apply_patch = false

247 

248################################################################################240################################################################################

249# Sandbox settings (tables)241# Sandbox settings (tables)

250################################################################################242################################################################################

267[shell_environment_policy]259[shell_environment_policy]

268# inherit: all (default) | core | none260# inherit: all (default) | core | none

269inherit = "all"261inherit = "all"

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

271ignore_default_excludes = true263ignore_default_excludes = false

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

273exclude = []265exclude = []

274# Explicit key/value overrides (always win). Default: {}266# Explicit key/value overrides (always win). Default: {}

278# Experimental: run via user shell profile. Default: false270# Experimental: run via user shell profile. Default: false

279experimental_use_profile = false271experimental_use_profile = false

280 272 

273################################################################################

274# Managed network proxy settings

275################################################################################

276 

277[permissions.network]

278# enabled = true

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

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

281# enable_socks5 = false

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

283# enable_socks5_udp = false

284# allow_upstream_proxy = false

285# dangerously_allow_non_loopback_proxy = false

286# dangerously_allow_non_loopback_admin = false

287# dangerously_allow_all_unix_sockets = false

288# mode = "limited" # limited | full

289# allowed_domains = ["api.openai.com"]

290# denied_domains = ["example.com"]

291# allow_unix_sockets = ["/var/run/docker.sock"]

292# allow_local_binding = false

293 

281################################################################################294################################################################################

282# History (table)295# History (table)

283################################################################################296################################################################################

286# save-all (default) | none299# save-all (default) | none

287persistence = "save-all"300persistence = "save-all"

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

289# max_bytes = 0302# max_bytes = 5242880

290 303 

291################################################################################304################################################################################

292# UI, Notifications, and Misc (tables)305# UI, Notifications, and Misc (tables)

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

319# theme = "catppuccin-mocha"332# theme = "catppuccin-mocha"

320 333 

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

335# [tui.model_availability_nux]

336# "gpt-5.4" = 1

337 

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

339[analytics]

340enabled = true

341 

321# Control whether users can submit feedback from `/feedback`. Default: true342# Control whether users can submit feedback from `/feedback`. Default: true

322[feedback]343[feedback]

323enabled = true344enabled = true

331# "hide_gpt-5.1-codex-max_migration_prompt" = true352# "hide_gpt-5.1-codex-max_migration_prompt" = true

332# model_migrations = { "gpt-4.1" = "gpt-5.1" }353# model_migrations = { "gpt-4.1" = "gpt-5.1" }

333 354 

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

335# suppress_unstable_features_warning = true

336 

337################################################################################355################################################################################

338# Centralized Feature Flags (preferred)356# Centralized Feature Flags (preferred)

339################################################################################357################################################################################

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

343# shell_tool = true361# shell_tool = true

344# apps = false362# apps = false

345# apps_mcp_gateway = false363# codex_hooks = false

346# web_search_cached = false364# unified_exec = true

347# web_search_request = false365# shell_snapshot = true

348# unified_exec = false366# multi_agent = true

349# shell_snapshot = false

350# apply_patch_freeform = false

351# multi_agent = false

352# search_tool = false

353# personality = true367# personality = true

354# request_rule = true368# fast_mode = true

355# collaboration_modes = true369# smart_approvals = false

356# use_linux_sandbox_bwrap = false370# enable_request_compression = true

357# remote_models = false371# skill_mcp_dependency_install = true

358# runtime_metrics = false372# prevent_idle_sleep = false

359# powershell_utf8 = true

360# child_agents_md = false

361 373 

362################################################################################374################################################################################

363# Define MCP servers under this table. Leave empty to disable.375# Define MCP servers under this table. Leave empty to disable.

379# tool_timeout_sec = 60.0 # optional; default 60.0 seconds391# tool_timeout_sec = 60.0 # optional; default 60.0 seconds

380# enabled_tools = ["search", "summarize"] # optional allow-list392# enabled_tools = ["search", "summarize"] # optional allow-list

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

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

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

382 396 

383# --- Example: Streamable HTTP transport ---397# --- Example: Streamable HTTP transport ---

384# [mcp_servers.github]398# [mcp_servers.github]

391# startup_timeout_sec = 10.0 # optional405# startup_timeout_sec = 10.0 # optional

392# tool_timeout_sec = 60.0 # optional406# tool_timeout_sec = 60.0 # optional

393# enabled_tools = ["list_issues"] # optional allow-list407# enabled_tools = ["list_issues"] # optional allow-list

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

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

394 410 

395################################################################################411################################################################################

396# Model Providers412# Model Providers

397################################################################################413################################################################################

398 414 

399# Built-ins include:415# Built-ins include:

400# - openai (Responses API; requires login or OPENAI_API_KEY via auth flow)416# - openai

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

418# - lmstudio

402 419 

403[model_providers]420[model_providers]

404 421 

406# [model_providers.openaidr]423# [model_providers.openaidr]

407# name = "OpenAI Data Residency"424# name = "OpenAI Data Residency"

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

409# wire_api = "responses" # "responses" | "chat" (default varies)426# wire_api = "responses" # only supported value

410# # requires_openai_auth = true # built-in OpenAI defaults to true427# # requires_openai_auth = true # built-in OpenAI defaults to true

411# # request_max_retries = 4 # default 4; max 100428# # request_max_retries = 4 # default 4; max 100

412# # stream_max_retries = 5 # default 5; max 100429# # stream_max_retries = 5 # default 5; max 100

413# # stream_idle_timeout_ms = 300000 # default 300_000 (5m)430# # stream_idle_timeout_ms = 300000 # default 300_000 (5m)

431# # supports_websockets = true # optional

414# # experimental_bearer_token = "sk-example" # optional dev-only direct bearer token432# # experimental_bearer_token = "sk-example" # optional dev-only direct bearer token

415# # http_headers = { "X-Example" = "value" }433# # http_headers = { "X-Example" = "value" }

416# # env_http_headers = { "OpenAI-Organization" = "OPENAI_ORGANIZATION", "OpenAI-Project" = "OPENAI_PROJECT" }434# # env_http_headers = { "OpenAI-Organization" = "OPENAI_ORGANIZATION", "OpenAI-Project" = "OPENAI_PROJECT" }

417 435 

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

419# [model_providers.azure]437# [model_providers.azure]

420# name = "Azure"438# name = "Azure"

421# base_url = "https://YOUR_PROJECT_NAME.openai.azure.com/openai"439# base_url = "https://YOUR_PROJECT_NAME.openai.azure.com/openai"

422# wire_api = "responses" # or "chat" per endpoint440# wire_api = "responses"

423# query_params = { api-version = "2025-04-01-preview" }441# query_params = { api-version = "2025-04-01-preview" }

424# env_key = "AZURE_OPENAI_API_KEY"442# env_key = "AZURE_OPENAI_API_KEY"

425# # env_key_instructions = "Set AZURE_OPENAI_API_KEY in your environment"443# env_key_instructions = "Set AZURE_OPENAI_API_KEY in your environment"

444# # supports_websockets = false

426 445 

427# --- Example: Local OSS (e.g., Ollama-compatible) ---446# --- Example: Local OSS (e.g., Ollama-compatible) ---

428# [model_providers.ollama]447# [model_providers.ollama]

429# name = "Ollama"448# name = "Ollama"

430# base_url = "http://localhost:11434/v1"449# base_url = "http://localhost:11434/v1"

431# wire_api = "chat"450# wire_api = "responses"

432 

433################################################################################

434# Profiles (named presets)

435################################################################################

436 

437[profiles]

438 

439# [profiles.default]

440# model = "gpt-5.4"

441# model_provider = "openai"

442# approval_policy = "on-request"

443# sandbox_mode = "read-only"

444# oss_provider = "ollama"

445# model_reasoning_effort = "medium"

446# model_reasoning_summary = "auto"

447# model_verbosity = "medium"

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

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

450# model_catalog_json = "./models.json"

451# experimental_compact_prompt_file = "./compact_prompt.txt"

452# include_apply_patch_tool = false

453# experimental_use_unified_exec_tool = false

454# experimental_use_freeform_apply_patch = false

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

456# features = { unified_exec = false }

457 451 

458################################################################################452################################################################################

459# Apps / Connectors453# Apps / Connectors

477# enabled = false471# enabled = false

478# approval_mode = "approve"472# approval_mode = "approve"

479 473 

474################################################################################

475# Profiles (named presets)

476################################################################################

477 

478[profiles]

479 

480# [profiles.default]

481# model = "gpt-5.4"

482# model_provider = "openai"

483# approval_policy = "on-request"

484# sandbox_mode = "read-only"

485# service_tier = "flex"

486# oss_provider = "ollama"

487# model_reasoning_effort = "medium"

488# plan_mode_reasoning_effort = "high"

489# model_reasoning_summary = "auto"

490# model_verbosity = "medium"

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

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

493# model_catalog_json = "./models.json"

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

495# experimental_compact_prompt_file = "./compact_prompt.txt"

496# tools_view_image = true

497# features = { unified_exec = false }

498 

480################################################################################499################################################################################

481# Projects (trust levels)500# Projects (trust levels)

482################################################################################501################################################################################

483 502 

484# Mark specific worktrees as trusted or untrusted.

485[projects]503[projects]

504# Mark specific worktrees as trusted or untrusted.

486# [projects."/absolute/path/to/project"]505# [projects."/absolute/path/to/project"]

487# trust_level = "trusted" # or "untrusted"506# trust_level = "trusted" # or "untrusted"

488 507 

508################################################################################

509# Tools

510################################################################################

511 

512[tools]

513# view_image = true

514 

489################################################################################515################################################################################

490# OpenTelemetry (OTEL) - disabled by default516# OpenTelemetry (OTEL) - disabled by default

491################################################################################517################################################################################

499exporter = "none"525exporter = "none"

500# Trace exporter: none (default) | otlp-http | otlp-grpc526# Trace exporter: none (default) | otlp-http | otlp-grpc

501trace_exporter = "none"527trace_exporter = "none"

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

529metrics_exporter = "statsig"

502 530 

503# Example OTLP/HTTP exporter configuration531# Example OTLP/HTTP exporter configuration

504# [otel.exporter."otlp-http"]532# [otel.exporter."otlp-http"]

508# [otel.exporter."otlp-http".headers]536# [otel.exporter."otlp-http".headers]

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

510 538 

511# Example OTLP/gRPC exporter configuration

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

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

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

515 

516# Example OTLP exporter with mutual TLS

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

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

519# protocol = "binary"

520 

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

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

523 

524# [otel.exporter."otlp-http".tls]539# [otel.exporter."otlp-http".tls]

525# ca-certificate = "certs/otel-ca.pem"540# ca-certificate = "certs/otel-ca.pem"

526# client-certificate = "/etc/codex/certs/client.pem"541# client-certificate = "/etc/codex/certs/client.pem"

527# client-private-key = "/etc/codex/certs/client-key.pem"542# client-private-key = "/etc/codex/certs/client-key.pem"

528```

529 543 

530################################################################################544# Example OTLP/gRPC trace exporter configuration

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

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

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

531 548 

549################################################################################

532# Windows550# Windows

533 

534################################################################################551################################################################################

535 552 

536[windows]553[windows]

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

538# Native Windows sandbox mode (Windows only). The example below uses the555sandbox = "unelevated"

539 556```

540# recommended elevated mode.

541 

542sandbox = “elevated”