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

27# Core Model Selection27# Core Model Selection

28################################################################################28################################################################################

29 29 

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.5".

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

32 32 

33# Communication style for supported models. Allowed values: none | friendly | pragmatic33# Communication style for supported models. Allowed values: none | friendly | pragmatic

34# personality = "pragmatic"34# personality = "pragmatic"

35 35 

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

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

38 38 

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

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

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

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

44 44 

45# Preferred service tier. `fast` is honored only when enabled in [features].45# Preferred service tier. Built-in examples: fast | flex; model catalogs can add more.

46# service_tier = "flex" # fast | flex46# service_tier = "flex"

47 47 

48# Optional manual model metadata. When unset, Codex uses model or preset defaults.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

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. Set to "" to disable it.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.

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

88 90 

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

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

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

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

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

113# approvals_reviewer = "user"115# approvals_reviewer = "user"

114 116 

115# Example granular policy:117# Example granular policy:

130# - workspace-write132# - workspace-write

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

132sandbox_mode = "read-only"134sandbox_mode = "read-only"

133# Named permissions profile to apply by default. Required before using [permissions.<name>].135# Named permissions profile to apply by default. Built-ins:

134# default_permissions = "workspace"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"

135 147 

136################################################################################148################################################################################

137# Authentication & Login149# Authentication & Login

276experimental_use_profile = false288experimental_use_profile = false

277 289 

278################################################################################290################################################################################

279# Managed network proxy settings291# Sandboxed networking settings

280################################################################################292################################################################################

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

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

283# [permissions.workspace.network]306# [permissions.workspace.network]

284# enabled = true307# enabled = true

291# dangerously_allow_non_loopback_proxy = false314# dangerously_allow_non_loopback_proxy = false

292# dangerously_allow_non_loopback_admin = false315# dangerously_allow_non_loopback_admin = false

293# dangerously_allow_all_unix_sockets = false316# dangerously_allow_all_unix_sockets = false

294# mode = "limited" # limited | full

295# allow_local_binding = false317# allow_local_binding = false

296#318#

297# [permissions.workspace.network.domains]319# [permissions.workspace.network.domains]

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

324# notification_method = "auto"346# notification_method = "auto"

325 347 

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

349# notification_condition = "unfocused"

350 

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

327animations = true352animations = true

328 353 

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

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

349 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 

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

351# [tui.model_availability_nux]385# [tui.model_availability_nux]

352# "gpt-5.4" = 1386# "gpt-5.4" = 1

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

377# shell_tool = true411# shell_tool = true

378# apps = false412# apps = false

379# codex_hooks = false413# hooks = false

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

415# codex_git_commit = false

380# unified_exec = true416# unified_exec = true

381# shell_snapshot = true417# shell_snapshot = true

382# multi_agent = true418# multi_agent = true

383# personality = true419# personality = true

420# network_proxy = false

384# fast_mode = true421# fast_mode = true

385# smart_approvals = false

386# enable_request_compression = true422# enable_request_compression = true

387# skill_mcp_dependency_install = true423# skill_mcp_dependency_install = true

388# prevent_idle_sleep = false424# prevent_idle_sleep = false

389 425 

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

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"

449 

390################################################################################450################################################################################

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

392################################################################################452################################################################################

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

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

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

403# 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" }]

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

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

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

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

432# - openai494# - openai

433# - ollama495# - ollama

434# - lmstudio496# - lmstudio

497# - amazon-bedrock

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

436 499 

437[model_providers]500[model_providers]

438 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 

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

440# [model_providers.openaidr]510# [model_providers.openaidr]

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

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

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

508# ]578# ]

579# disabled_tools = [

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

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

582# ]

509 583 

510################################################################################584################################################################################

511# Profiles (named presets)585# Profiles (named presets)

518# model_provider = "openai"592# model_provider = "openai"

519# approval_policy = "on-request"593# approval_policy = "on-request"

520# sandbox_mode = "read-only"594# sandbox_mode = "read-only"

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

522# oss_provider = "ollama"596# oss_provider = "ollama"

523# model_reasoning_effort = "medium"597# model_reasoning_effort = "medium"

524# plan_mode_reasoning_effort = "high"598# plan_mode_reasoning_effort = "high"