config-sample.md Codex Docs, 2026-03-20 00:35 UTC → 2026-04-22 18:29 UTC

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_subagent

113# approvals_reviewer = "user"

114 

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

113# approval_policy = { granular = {116# approval_policy = { granular = {

114# sandbox_approval = true,117# sandbox_approval = true,

127# - workspace-write130# - workspace-write

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

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

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

134# default_permissions = "workspace"

135 

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

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

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

139# [permissions.workspace.filesystem]

140# glob_scan_max_depth = 3

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

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

130 143 

131################################################################################144################################################################################

132# Authentication & Login145# Authentication & Login

274# Managed network proxy settings287# Managed network proxy settings

275################################################################################288################################################################################

276 289 

277[permissions.network]290# Set `default_permissions = "workspace"` before enabling this profile.

291# [permissions.workspace.network]

278# enabled = true292# enabled = true

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

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

286# dangerously_allow_non_loopback_admin = false300# dangerously_allow_non_loopback_admin = false

287# dangerously_allow_all_unix_sockets = false301# dangerously_allow_all_unix_sockets = false

288# mode = "limited" # limited | full302# 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 = false303# allow_local_binding = false

304#

305# [permissions.workspace.network.domains]

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

307# "example.com" = "deny"

308#

309# [permissions.workspace.network.unix_sockets]

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

293 311 

294################################################################################312################################################################################

295# History (table)313# History (table)

313# Notification mechanism for terminal alerts: auto | osc9 | bel. Default: "auto"331# Notification mechanism for terminal alerts: auto | osc9 | bel. Default: "auto"

314# notification_method = "auto"332# notification_method = "auto"

315 333 

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

335# notification_condition = "unfocused"

336 

316# Enables welcome/status/spinner animations. Default: true337# Enables welcome/status/spinner animations. Default: true

317animations = true338animations = true

318 339 

327# Set to [] to hide the footer.348# Set to [] to hide the footer.

328# status_line = ["model", "context-remaining", "git-branch"]349# status_line = ["model", "context-remaining", "git-branch"]

329 350 

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

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

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

354# and task-progress.

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

356 

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

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

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

350# hide_rate_limit_model_nudge = true377# hide_rate_limit_model_nudge = true

351# hide_gpt5_1_migration_prompt = true378# hide_gpt5_1_migration_prompt = true

352# "hide_gpt-5.1-codex-max_migration_prompt" = true379# "hide_gpt-5.1-codex-max_migration_prompt" = true

353# model_migrations = { "gpt-4.1" = "gpt-5.1" }380# model_migrations = { "gpt-5.3-codex" = "gpt-5.4" }

354 381 

355################################################################################382################################################################################

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

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

361# shell_tool = true388# shell_tool = true

362# apps = false389# apps = false

390# codex_hooks = false

363# unified_exec = true391# unified_exec = true

364# shell_snapshot = true392# shell_snapshot = true

365# multi_agent = true393# multi_agent = true

366# personality = true394# personality = true

367# fast_mode = true395# fast_mode = true

368# smart_approvals = false396# guardian_approval = false

369# enable_request_compression = true397# enable_request_compression = true

370# skill_mcp_dependency_install = true398# skill_mcp_dependency_install = true

371# prevent_idle_sleep = false399# prevent_idle_sleep = false

372 400 

401################################################################################

402# Memories (table)

403################################################################################

404 

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

406# [memories]

407# generate_memories = true

408# use_memories = true

409# disable_on_external_context = false # legacy alias: no_memories_if_mcp_or_web_search

410 

373################################################################################411################################################################################

374# Define MCP servers under this table. Leave empty to disable.412# Define MCP servers under this table. Leave empty to disable.

375################################################################################413################################################################################

383# command = "docs-server" # required421# command = "docs-server" # required

384# args = ["--port", "4000"] # optional422# args = ["--port", "4000"] # optional

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

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

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

387# cwd = "/path/to/server" # optional working directory override426# cwd = "/path/to/server" # optional working directory override

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

388# startup_timeout_sec = 10.0 # optional; default 10.0 seconds428# startup_timeout_sec = 10.0 # optional; default 10.0 seconds

389# # startup_timeout_ms = 10000 # optional alias for startup timeout (milliseconds)429# # startup_timeout_ms = 10000 # optional alias for startup timeout (milliseconds)

390# tool_timeout_sec = 60.0 # optional; default 60.0 seconds430# tool_timeout_sec = 60.0 # optional; default 60.0 seconds

415# - openai455# - openai

416# - ollama456# - ollama

417# - lmstudio457# - lmstudio

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

418 459 

419[model_providers]460[model_providers]

420 461 

423# name = "OpenAI Data Residency"464# name = "OpenAI Data Residency"

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

425# wire_api = "responses" # only supported value466# wire_api = "responses" # only supported value

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

427# # request_max_retries = 4 # default 4; max 100468# # request_max_retries = 4 # default 4; max 100

428# # stream_max_retries = 5 # default 5; max 100469# # stream_max_retries = 5 # default 5; max 100

429# # stream_idle_timeout_ms = 300000 # default 300_000 (5m)470# # stream_idle_timeout_ms = 300000 # default 300_000 (5m)

442# env_key_instructions = "Set AZURE_OPENAI_API_KEY in your environment"483# env_key_instructions = "Set AZURE_OPENAI_API_KEY in your environment"

443# # supports_websockets = false484# # supports_websockets = false

444 485 

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

487# [model_providers.proxy]

488# name = "OpenAI using LLM proxy"

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

490# wire_api = "responses"

491#

492# [model_providers.proxy.auth]

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

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

495# timeout_ms = 5000

496# refresh_interval_ms = 300000

497 

445# --- Example: Local OSS (e.g., Ollama-compatible) ---498# --- Example: Local OSS (e.g., Ollama-compatible) ---

446# [model_providers.ollama]499# [model_providers.local_ollama]

447# name = "Ollama"500# name = "Ollama"

448# base_url = "http://localhost:11434/v1"501# base_url = "http://localhost:11434/v1"

449# wire_api = "responses"502# wire_api = "responses"

470# enabled = false523# enabled = false

471# approval_mode = "approve"524# approval_mode = "approve"

472 525 

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

527# [tool_suggest]

528# discoverables = [

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

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

531# ]

532 

473################################################################################533################################################################################

474# Profiles (named presets)534# Profiles (named presets)

475################################################################################535################################################################################