config-sample.md Codex Docs, 2026-04-13 18:37 UTC → 2026-05-12 01:59 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"

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

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

324# notification_method = "auto"336# notification_method = "auto"

325 337 

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

339# notification_condition = "unfocused"

340 

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

327animations = true342animations = true

328 343 

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

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

349 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 

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

351# [tui.model_availability_nux]375# [tui.model_availability_nux]

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

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

377# shell_tool = true401# shell_tool = true

378# apps = false402# apps = false

403# codex_git_commit = false

379# codex_hooks = false404# codex_hooks = false

380# unified_exec = true405# unified_exec = true

381# shell_snapshot = true406# shell_snapshot = true

382# multi_agent = true407# multi_agent = true

383# personality = true408# personality = true

384# fast_mode = true409# fast_mode = true

385# smart_approvals = false

386# enable_request_compression = true410# enable_request_compression = true

387# skill_mcp_dependency_install = true411# skill_mcp_dependency_install = true

388# prevent_idle_sleep = false412# prevent_idle_sleep = false

389 413 

414################################################################################

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

437 

390################################################################################438################################################################################

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

392################################################################################440################################################################################

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

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

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

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

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

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

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

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

432# - openai482# - openai

433# - ollama483# - ollama

434# - lmstudio484# - lmstudio

485# - amazon-bedrock

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

436 487 

437[model_providers]488[model_providers]

438 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 

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

440# [model_providers.openaidr]498# [model_providers.openaidr]

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

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

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

508# ]566# ]

567# disabled_tools = [

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

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

570# ]

509 571 

510################################################################################572################################################################################

511# Profiles (named presets)573# Profiles (named presets)