config-sample.md +226 −113
1# Sample Configuration1# Sample Configuration
2 2
33Use this example configuration as a starting point. It includes most keys Codex reads from `config.toml`, along with defaults and short notes.Use this example configuration as a starting point. It includes most keys Codex reads from `config.toml`, along with default behaviors, recommended values where helpful, and short notes.
4 4
5For explanations and guidance, see:5For explanations and guidance, see:
6 6
7- [Config basics](https://developers.openai.com/codex/config-basic)7- [Config basics](https://developers.openai.com/codex/config-basic)
8- [Advanced Config](https://developers.openai.com/codex/config-advanced)8- [Advanced Config](https://developers.openai.com/codex/config-advanced)
9- [Config Reference](https://developers.openai.com/codex/config-reference)9- [Config Reference](https://developers.openai.com/codex/config-reference)
1010- [Sandbox and approvals](https://developers.openai.com/codex/security#sandbox-and-approvals)- [Sandbox and approvals](https://developers.openai.com/codex/agent-approvals-security#sandbox-and-approvals)
1111- [Managed configuration](https://developers.openai.com/codex/security#managed-configuration)- [Managed configuration](https://developers.openai.com/codex/enterprise/managed-configuration)
12 12
13Use the snippet below as a reference. Copy only the keys and sections you need into `~/.codex/config.toml` (or into a project-scoped `.codex/config.toml`), then adjust values for your setup.13Use the snippet below as a reference. Copy only the keys and sections you need into `~/.codex/config.toml` (or into a project-scoped `.codex/config.toml`), then adjust values for your setup.
14 14
15```toml15```toml
16# Codex example configuration (config.toml)16# Codex example configuration (config.toml)
17#17#
1818# This file lists all keys Codex reads from config.toml, their default values,# This file lists the main keys Codex reads from config.toml, along with default
1919# and concise explanations. Values here mirror the effective defaults compiled# behaviors, recommended examples, and concise explanations. Adjust as needed.
20# into the CLI. Adjust as needed.
21#20#
22# Notes21# Notes
23# - Root keys must appear before tables in TOML.22# - Root keys must appear before tables in TOML.
28# Core Model Selection27# Core Model Selection
29################################################################################28################################################################################
30 29
3130# Primary model used by Codex. Default: "gpt-5.2-codex" on all platforms.# Primary model used by Codex. Recommended example for most users: "gpt-5.4".
3231model = "gpt-5.2-codex"model = "gpt-5.4"
33 32
3433# Default communication style for supported models. Default: "friendly".# Communication style for supported models. Allowed values: none | friendly | pragmatic
3534# Allowed values: none | friendly | pragmatic# personality = "pragmatic"
36# personality = "friendly"
37 35
38# Optional model override for /review. Default: unset (uses current session model).36# Optional model override for /review. Default: unset (uses current session model).
3937# review_model = "gpt-5.2-codex"# review_model = "gpt-5.4"
40 38
41# Provider id selected from [model_providers]. Default: "openai".39# Provider id selected from [model_providers]. Default: "openai".
42model_provider = "openai"40model_provider = "openai"
44# 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.
45# oss_provider = "ollama"43# oss_provider = "ollama"
46 44
4745# Optional manual model metadata. When unset, Codex auto-detects from model.# Preferred service tier. `fast` is honored only when enabled in [features].
4846# Uncomment to force values.# service_tier = "flex" # fast | flex
47
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
5050# model_auto_compact_token_limit = 0 # tokens; unset uses model defaults# model_auto_compact_token_limit = 64000 # tokens; unset uses model defaults
5151# tool_output_token_limit = 10000 # tokens stored per tool output; default: 10000 for gpt-5.2-codex# tool_output_token_limit = 12000 # tokens stored per tool output
52# model_catalog_json = "/absolute/path/to/models.json" # optional startup-only model catalog override
53# background_terminal_max_timeout = 300000 # ms; max empty write_stdin poll window (default 5m)
52# log_dir = "/absolute/path/to/codex-logs" # directory for Codex logs; default: "$CODEX_HOME/log"54# log_dir = "/absolute/path/to/codex-logs" # directory for Codex logs; default: "$CODEX_HOME/log"
55# sqlite_home = "/absolute/path/to/codex-state" # optional SQLite-backed runtime state directory
53 56
54################################################################################57################################################################################
55# Reasoning & Verbosity (Responses API capable models)58# Reasoning & Verbosity (Responses API capable models)
56################################################################################59################################################################################
57 60
5861# Reasoning effort: minimal | low | medium | high | xhigh (default: medium; xhigh on gpt-5.2-codex and gpt-5.2)# Reasoning effort: minimal | low | medium | high | xhigh
5962model_reasoning_effort = "medium"# model_reasoning_effort = "medium"
63
64# Optional override used when Codex runs in plan mode: none | minimal | low | medium | high | xhigh
65# plan_mode_reasoning_effort = "high"
60 66
6167# Reasoning summary: auto | concise | detailed | none (default: auto)# Reasoning summary: auto | concise | detailed | none
62# model_reasoning_summary = "auto"68# model_reasoning_summary = "auto"
63 69
6470# Text verbosity for GPT-5 family (Responses API): low | medium | high (default: medium)# Text verbosity for GPT-5 family (Responses API): low | medium | high
65# model_verbosity = "medium"71# model_verbosity = "medium"
66 72
6773# Force enable or disable reasoning summaries for current model# Force enable or disable reasoning summaries for current model.
68# model_supports_reasoning_summaries = true74# model_supports_reasoning_summaries = true
69 75
70################################################################################76################################################################################
74# Additional user instructions are injected before AGENTS.md. Default: unset.80# Additional user instructions are injected before AGENTS.md. Default: unset.
75# developer_instructions = ""81# developer_instructions = ""
76 82
77# (Ignored) Optional legacy base instructions override (prefer AGENTS.md). Default: unset.
78# instructions = ""
79
80# Inline override for the history compaction prompt. Default: unset.83# Inline override for the history compaction prompt. Default: unset.
81# compact_prompt = ""84# compact_prompt = ""
82 85
86# Override the default commit co-author trailer. Set to "" to disable it.
87# commit_attribution = "Jane Doe <jane@example.com>"
88
83# Override built-in base instructions with a file path. Default: unset.89# Override built-in base instructions with a file path. Default: unset.
84# model_instructions_file = "/absolute/or/relative/path/to/instructions.txt"90# model_instructions_file = "/absolute/or/relative/path/to/instructions.txt"
85 91
86# Migration note: experimental_instructions_file was renamed to model_instructions_file (deprecated).
87
88# Load the compact prompt override from a file. Default: unset.92# Load the compact prompt override from a file. Default: unset.
89# experimental_compact_prompt_file = "/absolute/or/relative/path/to/compact_prompt.txt"93# experimental_compact_prompt_file = "/absolute/or/relative/path/to/compact_prompt.txt"
90 94
91# Legacy name for apply_patch_freeform. Default: false
92include_apply_patch_tool = false
93
94################################################################################95################################################################################
95# Notifications96# Notifications
96################################################################################97################################################################################
97 98
98# External notifier program (argv array). When unset: disabled.99# External notifier program (argv array). When unset: disabled.
99100# Example: notify = ["notify-send", "Codex"]# notify = ["notify-send", "Codex"]
100notify = [ ]
101 101
102################################################################################102################################################################################
103# Approval & Sandbox103# Approval & Sandbox
107# - untrusted: only known-safe read-only commands auto-run; others prompt107# - untrusted: only known-safe read-only commands auto-run; others prompt
108# - on-request: model decides when to ask (default)108# - on-request: model decides when to ask (default)
109# - never: never prompt (risky)109# - never: never prompt (risky)
110# - { granular = { ... } }: allow or auto-reject selected prompt categories
110approval_policy = "on-request"111approval_policy = "on-request"
112# Who reviews eligible approval prompts: user (default) | guardian_subagent
113# approvals_reviewer = "user"
114
115# Example granular policy:
116# approval_policy = { granular = {
117# sandbox_approval = true,
118# rules = true,
119# mcp_elicitations = true,
120# request_permissions = false,
121# skill_approval = false
122# } }
123
124# Allow login-shell semantics for shell-based tools when they request `login = true`.
125# Default: true. Set false to force non-login shells and reject explicit login-shell requests.
126allow_login_shell = true
111 127
112# Filesystem/network sandbox policy for tool calls:128# Filesystem/network sandbox policy for tool calls:
113# - read-only (default)129# - read-only (default)
114# - workspace-write130# - workspace-write
115# - danger-full-access (no sandbox; extremely risky)131# - danger-full-access (no sandbox; extremely risky)
116sandbox_mode = "read-only"132sandbox_mode = "read-only"
133# Named permissions profile to apply by default. Required before using [permissions.<name>].
134# default_permissions = "workspace"
117 135
118################################################################################136################################################################################
119# Authentication & Login137# Authentication & Login
122# Where to persist CLI login credentials: file (default) | keyring | auto140# Where to persist CLI login credentials: file (default) | keyring | auto
123cli_auth_credentials_store = "file"141cli_auth_credentials_store = "file"
124 142
125143# Base URL for ChatGPT auth flow (not OpenAI API). Default:# Base URL for ChatGPT auth flow (not OpenAI API).
126chatgpt_base_url = "https://chatgpt.com/backend-api/"144chatgpt_base_url = "https://chatgpt.com/backend-api/"
127 145
146# Optional base URL override for the built-in OpenAI provider.
147# openai_base_url = "https://us.api.openai.com/v1"
148
128# Restrict ChatGPT login to a specific workspace id. Default: unset.149# Restrict ChatGPT login to a specific workspace id. Default: unset.
129150# forced_chatgpt_workspace_id = ""# forced_chatgpt_workspace_id = "00000000-0000-0000-0000-000000000000"
130 151
131# Force login mechanism when Codex would normally auto-select. Default: unset.152# Force login mechanism when Codex would normally auto-select. Default: unset.
132# Allowed values: chatgpt | api153# Allowed values: chatgpt | api
134 155
135# Preferred store for MCP OAuth credentials: auto (default) | file | keyring156# Preferred store for MCP OAuth credentials: auto (default) | file | keyring
136mcp_oauth_credentials_store = "auto"157mcp_oauth_credentials_store = "auto"
137
138# Optional fixed port for MCP OAuth callback: 1-65535. Default: unset.158# Optional fixed port for MCP OAuth callback: 1-65535. Default: unset.
139# mcp_oauth_callback_port = 4321159# mcp_oauth_callback_port = 4321
160# Optional redirect URI override for MCP OAuth login (for example, remote devbox ingress).
161# Custom callback paths are supported. `mcp_oauth_callback_port` still controls the listener port.
162# mcp_oauth_callback_url = "https://devbox.example.internal/callback"
140 163
141################################################################################164################################################################################
142# Project Documentation Controls165# Project Documentation Controls
187# If you use --yolo or another full access sandbox setting, web search defaults to live.210# If you use --yolo or another full access sandbox setting, web search defaults to live.
188web_search = "cached"211web_search = "cached"
189 212
213# Active profile name. When unset, no profile is applied.
214# profile = "default"
215
216# Suppress the warning shown when under-development feature flags are enabled.
217# suppress_unstable_features_warning = true
218
190################################################################################219################################################################################
191220# Profiles (named presets)# Agents (multi-agent roles and limits)
192################################################################################221################################################################################
193 222
194223# Active profile name. When unset, no profile is applied.[agents]
195224# profile = "default"# Maximum concurrently open agent threads. Default: 6
225# max_threads = 6
226# Maximum nested spawn depth. Root session starts at depth 0. Default: 1
227# max_depth = 1
228# Default timeout per worker for spawn_agents_on_csv jobs. When unset, the tool defaults to 1800 seconds.
229# job_max_runtime_seconds = 1800
230
231# [agents.reviewer]
232# description = "Find correctness, security, and test risks in code."
233# config_file = "./agents/reviewer.toml" # relative to the config.toml that defines it
234# nickname_candidates = ["Athena", "Ada"]
196 235
197################################################################################236################################################################################
198# Skills (per-skill overrides)237# Skills (per-skill overrides)
200 239
201# Disable or re-enable a specific skill without deleting it.240# Disable or re-enable a specific skill without deleting it.
202[[skills.config]]241[[skills.config]]
203242# path = "/path/to/skill"# path = "/path/to/skill/SKILL.md"
204# enabled = false243# enabled = false
205 244
206################################################################################
207# Experimental toggles (legacy; prefer [features])
208################################################################################
209
210experimental_use_unified_exec_tool = false
211
212# Include apply_patch via freeform editing path (affects default tool set). Default: false
213experimental_use_freeform_apply_patch = false
214
215################################################################################245################################################################################
216# Sandbox settings (tables)246# Sandbox settings (tables)
217################################################################################247################################################################################
234[shell_environment_policy]264[shell_environment_policy]
235# inherit: all (default) | core | none265# inherit: all (default) | core | none
236inherit = "all"266inherit = "all"
237267# Skip default excludes for names containing KEY/SECRET/TOKEN (case-insensitive). Default: true# Skip default excludes for names containing KEY/SECRET/TOKEN (case-insensitive). Default: false
238268ignore_default_excludes = trueignore_default_excludes = false
239# Case-insensitive glob patterns to remove (e.g., "AWS_*", "AZURE_*"). Default: []269# Case-insensitive glob patterns to remove (e.g., "AWS_*", "AZURE_*"). Default: []
240exclude = []270exclude = []
241# Explicit key/value overrides (always win). Default: {}271# Explicit key/value overrides (always win). Default: {}
245# Experimental: run via user shell profile. Default: false275# Experimental: run via user shell profile. Default: false
246experimental_use_profile = false276experimental_use_profile = false
247 277
278################################################################################
279# Managed network proxy settings
280################################################################################
281
282# Set `default_permissions = "workspace"` before enabling this profile.
283# [permissions.workspace.network]
284# enabled = true
285# proxy_url = "http://127.0.0.1:43128"
286# admin_url = "http://127.0.0.1:43129"
287# enable_socks5 = false
288# socks_url = "http://127.0.0.1:43130"
289# enable_socks5_udp = false
290# allow_upstream_proxy = false
291# dangerously_allow_non_loopback_proxy = false
292# dangerously_allow_non_loopback_admin = false
293# dangerously_allow_all_unix_sockets = false
294# mode = "limited" # limited | full
295# allow_local_binding = false
296#
297# [permissions.workspace.network.domains]
298# "api.openai.com" = "allow"
299# "example.com" = "deny"
300#
301# [permissions.workspace.network.unix_sockets]
302# "/var/run/docker.sock" = "allow"
303
248################################################################################304################################################################################
249# History (table)305# History (table)
250################################################################################306################################################################################
253# save-all (default) | none309# save-all (default) | none
254persistence = "save-all"310persistence = "save-all"
255# Maximum bytes for history file; oldest entries are trimmed when exceeded. Example: 5242880311# Maximum bytes for history file; oldest entries are trimmed when exceeded. Example: 5242880
256312# max_bytes = 0# max_bytes = 5242880
257 313
258################################################################################314################################################################################
259# UI, Notifications, and Misc (tables)315# UI, Notifications, and Misc (tables)
276# Control alternate screen usage (auto skips it in Zellij to preserve scrollback).332# Control alternate screen usage (auto skips it in Zellij to preserve scrollback).
277# alternate_screen = "auto"333# alternate_screen = "auto"
278 334
279335# Ordered list of footer status-line item IDs. Default: null (disabled).# Ordered list of footer status-line item IDs. When unset, Codex uses:
336# ["model-with-reasoning", "context-remaining", "current-dir"].
337# Set to [] to hide the footer.
280# status_line = ["model", "context-remaining", "git-branch"]338# status_line = ["model", "context-remaining", "git-branch"]
281 339
340# Ordered list of terminal window/tab title item IDs. When unset, Codex uses:
341# ["spinner", "project"]. Set to [] to clear the title.
342# Available IDs include app-name, project, spinner, status, thread, git-branch, model,
343# and task-progress.
344# terminal_title = ["spinner", "project"]
345
346# Syntax-highlighting theme (kebab-case). Use /theme in the TUI to preview and save.
347# You can also add custom .tmTheme files under $CODEX_HOME/themes.
348# theme = "catppuccin-mocha"
349
350# Internal tooltip state keyed by model slug. Usually managed by Codex.
351# [tui.model_availability_nux]
352# "gpt-5.4" = 1
353
354# Enable or disable analytics for this machine. When unset, Codex uses its default behavior.
355[analytics]
356enabled = true
357
282# Control whether users can submit feedback from `/feedback`. Default: true358# Control whether users can submit feedback from `/feedback`. Default: true
283[feedback]359[feedback]
284enabled = true360enabled = true
290# hide_rate_limit_model_nudge = true366# hide_rate_limit_model_nudge = true
291# hide_gpt5_1_migration_prompt = true367# hide_gpt5_1_migration_prompt = true
292# "hide_gpt-5.1-codex-max_migration_prompt" = true368# "hide_gpt-5.1-codex-max_migration_prompt" = true
293369# model_migrations = { "gpt-4.1" = "gpt-5.1" }# model_migrations = { "gpt-5.3-codex" = "gpt-5.4" }
294
295# Suppress the warning shown when under-development feature flags are enabled.
296# suppress_unstable_features_warning = true
297 370
298################################################################################371################################################################################
299# Centralized Feature Flags (preferred)372# Centralized Feature Flags (preferred)
301 374
302[features]375[features]
303# Leave this table empty to accept defaults. Set explicit booleans to opt in/out.376# Leave this table empty to accept defaults. Set explicit booleans to opt in/out.
304377shell_tool = true# shell_tool = true
305# apps = false378# apps = false
306379# apps_mcp_gateway = false# codex_hooks = false
307380# Deprecated legacy toggles; prefer the top-level `web_search` setting.# unified_exec = true
308381# web_search = false# shell_snapshot = true
309382# web_search_cached = false# multi_agent = true
310# web_search_request = false
311unified_exec = false
312shell_snapshot = false
313apply_patch_freeform = false
314# search_tool = false
315# personality = true383# personality = true
316384request_rule = true# fast_mode = true
317385collaboration_modes = true# guardian_approval = false
318386use_linux_sandbox_bwrap = false# enable_request_compression = true
319387experimental_windows_sandbox = false# skill_mcp_dependency_install = true
320388elevated_windows_sandbox = false# prevent_idle_sleep = false
321remote_models = false
322runtime_metrics = false
323powershell_utf8 = true
324child_agents_md = false
325 389
326################################################################################390################################################################################
327# Define MCP servers under this table. Leave empty to disable.391# Define MCP servers under this table. Leave empty to disable.
343# tool_timeout_sec = 60.0 # optional; default 60.0 seconds407# tool_timeout_sec = 60.0 # optional; default 60.0 seconds
344# enabled_tools = ["search", "summarize"] # optional allow-list408# enabled_tools = ["search", "summarize"] # optional allow-list
345# disabled_tools = ["slow-tool"] # optional deny-list (applied after allow-list)409# disabled_tools = ["slow-tool"] # optional deny-list (applied after allow-list)
410# scopes = ["read:docs"] # optional OAuth scopes
411# oauth_resource = "https://docs.example.com/" # optional OAuth resource
346 412
347# --- Example: Streamable HTTP transport ---413# --- Example: Streamable HTTP transport ---
348# [mcp_servers.github]414# [mcp_servers.github]
355# startup_timeout_sec = 10.0 # optional421# startup_timeout_sec = 10.0 # optional
356# tool_timeout_sec = 60.0 # optional422# tool_timeout_sec = 60.0 # optional
357# enabled_tools = ["list_issues"] # optional allow-list423# enabled_tools = ["list_issues"] # optional allow-list
424# disabled_tools = ["delete_issue"] # optional deny-list
425# scopes = ["repo"] # optional OAuth scopes
358 426
359################################################################################427################################################################################
360# Model Providers428# Model Providers
361################################################################################429################################################################################
362 430
363# Built-ins include:431# Built-ins include:
364432# - openai (Responses API; requires login or OPENAI_API_KEY via auth flow)# - openai
365433# - oss (Chat Completions API; defaults to http://localhost:11434/v1)# - ollama
434# - lmstudio
435# These IDs are reserved. Use a different ID for custom providers.
366 436
367[model_providers]437[model_providers]
368 438
370# [model_providers.openaidr]440# [model_providers.openaidr]
371# name = "OpenAI Data Residency"441# name = "OpenAI Data Residency"
372# base_url = "https://us.api.openai.com/v1" # example with 'us' domain prefix442# base_url = "https://us.api.openai.com/v1" # example with 'us' domain prefix
373443# wire_api = "responses" # "responses" | "chat" (default varies)# wire_api = "responses" # only supported value
374444# # requires_openai_auth = true # built-in OpenAI defaults to true# # requires_openai_auth = true # use only for providers backed by OpenAI auth
375# # request_max_retries = 4 # default 4; max 100445# # request_max_retries = 4 # default 4; max 100
376# # stream_max_retries = 5 # default 5; max 100446# # stream_max_retries = 5 # default 5; max 100
377# # stream_idle_timeout_ms = 300000 # default 300_000 (5m)447# # stream_idle_timeout_ms = 300000 # default 300_000 (5m)
448# # supports_websockets = true # optional
378# # experimental_bearer_token = "sk-example" # optional dev-only direct bearer token449# # experimental_bearer_token = "sk-example" # optional dev-only direct bearer token
379# # http_headers = { "X-Example" = "value" }450# # http_headers = { "X-Example" = "value" }
380# # env_http_headers = { "OpenAI-Organization" = "OPENAI_ORGANIZATION", "OpenAI-Project" = "OPENAI_PROJECT" }451# # env_http_headers = { "OpenAI-Organization" = "OPENAI_ORGANIZATION", "OpenAI-Project" = "OPENAI_PROJECT" }
381 452
382453# --- Example: Azure (Chat/Responses depending on endpoint) ---# --- Example: Azure/OpenAI-compatible provider ---
383# [model_providers.azure]454# [model_providers.azure]
384# name = "Azure"455# name = "Azure"
385# base_url = "https://YOUR_PROJECT_NAME.openai.azure.com/openai"456# base_url = "https://YOUR_PROJECT_NAME.openai.azure.com/openai"
386457# wire_api = "responses" # or "chat" per endpoint# wire_api = "responses"
387# query_params = { api-version = "2025-04-01-preview" }458# query_params = { api-version = "2025-04-01-preview" }
388# env_key = "AZURE_OPENAI_API_KEY"459# env_key = "AZURE_OPENAI_API_KEY"
389460# # env_key_instructions = "Set AZURE_OPENAI_API_KEY in your environment"# env_key_instructions = "Set AZURE_OPENAI_API_KEY in your environment"
461# # supports_websockets = false
462
463# --- Example: command-backed bearer token auth ---
464# [model_providers.proxy]
465# name = "OpenAI using LLM proxy"
466# base_url = "https://proxy.example.com/v1"
467# wire_api = "responses"
468#
469# [model_providers.proxy.auth]
470# command = "/usr/local/bin/fetch-codex-token"
471# args = ["--audience", "codex"]
472# timeout_ms = 5000
473# refresh_interval_ms = 300000
390 474
391# --- Example: Local OSS (e.g., Ollama-compatible) ---475# --- Example: Local OSS (e.g., Ollama-compatible) ---
392476# [model_providers.ollama]# [model_providers.local_ollama]
393# name = "Ollama"477# name = "Ollama"
394# base_url = "http://localhost:11434/v1"478# base_url = "http://localhost:11434/v1"
395479# wire_api = "chat"# wire_api = "responses"
480
481################################################################################
482# Apps / Connectors
483################################################################################
484
485# Optional per-app controls.
486[apps]
487# [_default] applies to all apps unless overridden per app.
488# [apps._default]
489# enabled = true
490# destructive_enabled = true
491# open_world_enabled = true
492#
493# [apps.google_drive]
494# enabled = false
495# destructive_enabled = false # block destructive-hint tools for this app
496# default_tools_enabled = true
497# default_tools_approval_mode = "prompt" # auto | prompt | approve
498#
499# [apps.google_drive.tools."files/delete"]
500# enabled = false
501# approval_mode = "approve"
502
503# Optional tool suggestion allowlist for connectors or plugins Codex can offer to install.
504# [tool_suggest]
505# discoverables = [
506# { type = "connector", id = "gmail" },
507# { type = "plugin", id = "figma@openai-curated" },
508# ]
396 509
397################################################################################510################################################################################
398# Profiles (named presets)511# Profiles (named presets)
401[profiles]514[profiles]
402 515
403# [profiles.default]516# [profiles.default]
404517# model = "gpt-5.2-codex"# model = "gpt-5.4"
405# model_provider = "openai"518# model_provider = "openai"
406# approval_policy = "on-request"519# approval_policy = "on-request"
407# sandbox_mode = "read-only"520# sandbox_mode = "read-only"
521# service_tier = "flex"
408# oss_provider = "ollama"522# oss_provider = "ollama"
409# model_reasoning_effort = "medium"523# model_reasoning_effort = "medium"
524# plan_mode_reasoning_effort = "high"
410# model_reasoning_summary = "auto"525# model_reasoning_summary = "auto"
411# model_verbosity = "medium"526# model_verbosity = "medium"
412527# personality = "friendly" # or "pragmatic" or "none"# personality = "pragmatic" # or "friendly" or "none"
413# chatgpt_base_url = "https://chatgpt.com/backend-api/"528# chatgpt_base_url = "https://chatgpt.com/backend-api/"
529# model_catalog_json = "./models.json"
530# model_instructions_file = "/absolute/or/relative/path/to/instructions.txt"
414# experimental_compact_prompt_file = "./compact_prompt.txt"531# experimental_compact_prompt_file = "./compact_prompt.txt"
415532# include_apply_patch_tool = false# tools_view_image = true
416# experimental_use_unified_exec_tool = false
417# experimental_use_freeform_apply_patch = false
418# tools.web_search = false # deprecated legacy alias; prefer top-level `web_search`
419# features = { unified_exec = false }533# features = { unified_exec = false }
420 534
421################################################################################
422# Apps / Connectors
423################################################################################
424
425# Optional per-app controls.
426[apps]
427# [apps.google_drive]
428# enabled = false
429# disabled_reason = "user" # or "unknown"
430
431################################################################################535################################################################################
432# Projects (trust levels)536# Projects (trust levels)
433################################################################################537################################################################################
434 538
435# Mark specific worktrees as trusted or untrusted.
436[projects]539[projects]
540# Mark specific worktrees as trusted or untrusted.
437# [projects."/absolute/path/to/project"]541# [projects."/absolute/path/to/project"]
438# trust_level = "trusted" # or "untrusted"542# trust_level = "trusted" # or "untrusted"
439 543
544################################################################################
545# Tools
546################################################################################
547
548[tools]
549# view_image = true
550
440################################################################################551################################################################################
441# OpenTelemetry (OTEL) - disabled by default552# OpenTelemetry (OTEL) - disabled by default
442################################################################################553################################################################################
450exporter = "none"561exporter = "none"
451# Trace exporter: none (default) | otlp-http | otlp-grpc562# Trace exporter: none (default) | otlp-http | otlp-grpc
452trace_exporter = "none"563trace_exporter = "none"
564# Metrics exporter: none | statsig | otlp-http | otlp-grpc
565metrics_exporter = "statsig"
453 566
454# Example OTLP/HTTP exporter configuration567# Example OTLP/HTTP exporter configuration
455# [otel.exporter."otlp-http"]568# [otel.exporter."otlp-http"]
459# [otel.exporter."otlp-http".headers]572# [otel.exporter."otlp-http".headers]
460# "x-otlp-api-key" = "${OTLP_TOKEN}"573# "x-otlp-api-key" = "${OTLP_TOKEN}"
461 574
462# Example OTLP/gRPC exporter configuration
463# [otel.exporter."otlp-grpc"]
464# endpoint = "https://otel.example.com:4317",
465# headers = { "x-otlp-meta" = "abc123" }
466
467# Example OTLP exporter with mutual TLS
468# [otel.exporter."otlp-http"]
469# endpoint = "https://otel.example.com/v1/logs"
470# protocol = "binary"
471
472# [otel.exporter."otlp-http".headers]
473# "x-otlp-api-key" = "${OTLP_TOKEN}"
474
475# [otel.exporter."otlp-http".tls]575# [otel.exporter."otlp-http".tls]
476# ca-certificate = "certs/otel-ca.pem"576# ca-certificate = "certs/otel-ca.pem"
477# client-certificate = "/etc/codex/certs/client.pem"577# client-certificate = "/etc/codex/certs/client.pem"
478# client-private-key = "/etc/codex/certs/client-key.pem"578# client-private-key = "/etc/codex/certs/client-key.pem"
579
580# Example OTLP/gRPC trace exporter configuration
581# [otel.trace_exporter."otlp-grpc"]
582# endpoint = "https://otel.example.com:4317"
583# headers = { "x-otlp-meta" = "abc123" }
584
585################################################################################
586# Windows
587################################################################################
588
589[windows]
590# Native Windows sandbox mode (Windows only): unelevated | elevated
591sandbox = "unelevated"
479```592```