config-sample.md Codex Docs, 2026-04-20 06:53 UTC → 2026-05-05 23:00 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"

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

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

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

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

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

114 114 

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

130# - workspace-write130# - workspace-write

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

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

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

134# default_permissions = "workspace"134# :read-only | :workspace | :danger-no-sandbox

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

136# default_permissions = ":workspace"

137 

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

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

140# glob_scan_max_depth when using unbounded patterns such as `**`.

141# [permissions.workspace.filesystem]

142# glob_scan_max_depth = 3

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

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

135 145 

136################################################################################146################################################################################

137# Authentication & Login147# Authentication & Login

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

324# notification_method = "auto"334# notification_method = "auto"

325 335 

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

337# notification_condition = "unfocused"

338 

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

327animations = true340animations = true

328 341 

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

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

349 362 

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

364# Use [] to unbind an action.

365# [tui.keymap.global]

366# open_transcript = "ctrl-t"

367# open_external_editor = []

368#

369# [tui.keymap.composer]

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

371 

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

351# [tui.model_availability_nux]373# [tui.model_availability_nux]

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

382# multi_agent = true404# multi_agent = true

383# personality = true405# personality = true

384# fast_mode = true406# fast_mode = true

385# guardian_approval = false

386# enable_request_compression = true407# enable_request_compression = true

387# skill_mcp_dependency_install = true408# skill_mcp_dependency_install = true

388# prevent_idle_sleep = false409# prevent_idle_sleep = false

389 410 

411################################################################################

412# Memories (table)

413################################################################################

414 

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

416# [memories]

417# generate_memories = true

418# use_memories = true

419# disable_on_external_context = false # legacy alias: no_memories_if_mcp_or_web_search

420 

421################################################################################

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

423################################################################################

424 

425# [hooks]

426# [[hooks.PreToolUse]]

427# matcher = "^Bash$"

428#

429# [[hooks.PreToolUse.hooks]]

430# type = "command"

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

432# timeout = 30

433# statusMessage = "Checking Bash command"

434 

390################################################################################435################################################################################

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

392################################################################################437################################################################################

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

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

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

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

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

404# cwd = "/path/to/server" # optional working directory override450# cwd = "/path/to/server" # optional working directory override

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

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

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

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

432# - openai479# - openai

433# - ollama480# - ollama

434# - lmstudio481# - lmstudio

482# - amazon-bedrock

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

436 484 

437[model_providers]485[model_providers]

438 486 

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

488# model_provider = "amazon-bedrock"

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

490# [model_providers.amazon-bedrock.aws]

491# profile = "default"

492# region = "eu-central-1"

493 

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

440# [model_providers.openaidr]495# [model_providers.openaidr]

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

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

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

508# ]563# ]

564# disabled_tools = [

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

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

567# ]

509 568 

510################################################################################569################################################################################

511# Profiles (named presets)570# Profiles (named presets)