config-sample.md Codex Docs, 2026-04-23 18:31 UTC → 2026-05-14 07:00 UTC

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.

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"

135 139 

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

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

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

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

360 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 

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

362# [tui.model_availability_nux]375# [tui.model_availability_nux]

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

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

388# shell_tool = true401# shell_tool = true

389# apps = false402# apps = false

403# codex_git_commit = false

390# codex_hooks = false404# codex_hooks = false

391# unified_exec = true405# unified_exec = true

392# shell_snapshot = true406# shell_snapshot = true

407# use_memories = true421# use_memories = true

408# disable_on_external_context = false # legacy alias: no_memories_if_mcp_or_web_search422# disable_on_external_context = false # legacy alias: no_memories_if_mcp_or_web_search

409 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 

410################################################################################438################################################################################

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

412################################################################################440################################################################################

454# - openai482# - openai

455# - ollama483# - ollama

456# - lmstudio484# - lmstudio

485# - amazon-bedrock

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

458 487 

459[model_providers]488[model_providers]

460 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 

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

462# [model_providers.openaidr]498# [model_providers.openaidr]

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

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

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

530# ]566# ]

567# disabled_tools = [

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

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

570# ]

531 571 

532################################################################################572################################################################################

533# Profiles (named presets)573# Profiles (named presets)