config-sample.md +226 −111
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)
10- [Sandbox and approvals](https://developers.openai.com/codex/agent-approvals-security#sandbox-and-approvals)
11- [Managed configuration](https://developers.openai.com/codex/enterprise/managed-configuration)
10 12
11Use 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.
12 14
13```toml15```toml
14# Codex example configuration (config.toml)16# Codex example configuration (config.toml)
15#17#
1618# 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
1719# and concise explanations. Values here mirror the effective defaults compiled# behaviors, recommended examples, and concise explanations. Adjust as needed.
18# into the CLI. Adjust as needed.
19#20#
20# Notes21# Notes
21# - Root keys must appear before tables in TOML.22# - Root keys must appear before tables in TOML.
26# Core Model Selection27# Core Model Selection
27################################################################################28################################################################################
28 29
2930# 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".
3031model = "gpt-5.2-codex"model = "gpt-5.4"
31 32
3233# Default communication style for supported models. Default: "friendly".# Communication style for supported models. Allowed values: none | friendly | pragmatic
3334# Allowed values: none | friendly | pragmatic# personality = "pragmatic"
34# personality = "friendly"
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).
3737# review_model = "gpt-5.2-codex"# review_model = "gpt-5.4"
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"
42# 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.
43# oss_provider = "ollama"43# oss_provider = "ollama"
44 44
4545# Optional manual model metadata. When unset, Codex auto-detects from model.# Preferred service tier. `fast` is honored only when enabled in [features].
4646# Uncomment to force values.# service_tier = "flex" # fast | flex
47
48# Optional manual model metadata. When unset, Codex uses model or preset defaults.
47# model_context_window = 128000 # tokens; default: auto for model49# model_context_window = 128000 # tokens; default: auto for model
4850# model_auto_compact_token_limit = 0 # tokens; unset uses model defaults# model_auto_compact_token_limit = 64000 # tokens; unset uses model defaults
4951# 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)
50# 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
51 56
52################################################################################57################################################################################
53# Reasoning & Verbosity (Responses API capable models)58# Reasoning & Verbosity (Responses API capable models)
54################################################################################59################################################################################
55 60
5661# 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
5762model_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"
58 66
5967# Reasoning summary: auto | concise | detailed | none (default: auto)# Reasoning summary: auto | concise | detailed | none
60# model_reasoning_summary = "auto"68# model_reasoning_summary = "auto"
61 69
6270# Text verbosity for GPT-5 family (Responses API): low | medium | high (default: medium)# Text verbosity for GPT-5 family (Responses API): low | medium | high
63# model_verbosity = "medium"71# model_verbosity = "medium"
64 72
6573# Force enable or disable reasoning summaries for current model# Force enable or disable reasoning summaries for current model.
66# model_supports_reasoning_summaries = true74# model_supports_reasoning_summaries = true
67 75
68################################################################################76################################################################################
72# Additional user instructions are injected before AGENTS.md. Default: unset.80# Additional user instructions are injected before AGENTS.md. Default: unset.
73# developer_instructions = ""81# developer_instructions = ""
74 82
75# (Ignored) Optional legacy base instructions override (prefer AGENTS.md). Default: unset.
76# instructions = ""
77
78# Inline override for the history compaction prompt. Default: unset.83# Inline override for the history compaction prompt. Default: unset.
79# compact_prompt = ""84# compact_prompt = ""
80 85
86# Override the default commit co-author trailer. Set to "" to disable it.
87# commit_attribution = "Jane Doe <jane@example.com>"
88
81# Override built-in base instructions with a file path. Default: unset.89# Override built-in base instructions with a file path. Default: unset.
82# model_instructions_file = "/absolute/or/relative/path/to/instructions.txt"90# model_instructions_file = "/absolute/or/relative/path/to/instructions.txt"
83 91
84# Migration note: experimental_instructions_file was renamed to model_instructions_file (deprecated).
85
86# Load the compact prompt override from a file. Default: unset.92# Load the compact prompt override from a file. Default: unset.
87# 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"
88 94
89# Legacy name for apply_patch_freeform. Default: false
90include_apply_patch_tool = false
91
92################################################################################95################################################################################
93# Notifications96# Notifications
94################################################################################97################################################################################
95 98
96# External notifier program (argv array). When unset: disabled.99# External notifier program (argv array). When unset: disabled.
97100# Example: notify = ["notify-send", "Codex"]# notify = ["notify-send", "Codex"]
98notify = [ ]
99 101
100################################################################################102################################################################################
101# Approval & Sandbox103# Approval & Sandbox
105# - untrusted: only known-safe read-only commands auto-run; others prompt107# - untrusted: only known-safe read-only commands auto-run; others prompt
106# - on-request: model decides when to ask (default)108# - on-request: model decides when to ask (default)
107# - never: never prompt (risky)109# - never: never prompt (risky)
110# - { granular = { ... } }: allow or auto-reject selected prompt categories
108approval_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
109 127
110# Filesystem/network sandbox policy for tool calls:128# Filesystem/network sandbox policy for tool calls:
111# - read-only (default)129# - read-only (default)
112# - workspace-write130# - workspace-write
113# - danger-full-access (no sandbox; extremely risky)131# - danger-full-access (no sandbox; extremely risky)
114sandbox_mode = "read-only"132sandbox_mode = "read-only"
133# Named permissions profile to apply by default. Required before using [permissions.<name>].
134# default_permissions = "workspace"
115 135
116################################################################################136################################################################################
117# Authentication & Login137# Authentication & Login
120# Where to persist CLI login credentials: file (default) | keyring | auto140# Where to persist CLI login credentials: file (default) | keyring | auto
121cli_auth_credentials_store = "file"141cli_auth_credentials_store = "file"
122 142
123143# Base URL for ChatGPT auth flow (not OpenAI API). Default:# Base URL for ChatGPT auth flow (not OpenAI API).
124chatgpt_base_url = "https://chatgpt.com/backend-api/"144chatgpt_base_url = "https://chatgpt.com/backend-api/"
125 145
146# Optional base URL override for the built-in OpenAI provider.
147# openai_base_url = "https://us.api.openai.com/v1"
148
126# Restrict ChatGPT login to a specific workspace id. Default: unset.149# Restrict ChatGPT login to a specific workspace id. Default: unset.
127150# forced_chatgpt_workspace_id = ""# forced_chatgpt_workspace_id = "00000000-0000-0000-0000-000000000000"
128 151
129# Force login mechanism when Codex would normally auto-select. Default: unset.152# Force login mechanism when Codex would normally auto-select. Default: unset.
130# Allowed values: chatgpt | api153# Allowed values: chatgpt | api
132 155
133# Preferred store for MCP OAuth credentials: auto (default) | file | keyring156# Preferred store for MCP OAuth credentials: auto (default) | file | keyring
134mcp_oauth_credentials_store = "auto"157mcp_oauth_credentials_store = "auto"
135
136# Optional fixed port for MCP OAuth callback: 1-65535. Default: unset.158# Optional fixed port for MCP OAuth callback: 1-65535. Default: unset.
137# 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"
138 163
139################################################################################164################################################################################
140# Project Documentation Controls165# Project Documentation Controls
185# 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.
186web_search = "cached"211web_search = "cached"
187 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
188################################################################################219################################################################################
189220# Profiles (named presets)# Agents (multi-agent roles and limits)
190################################################################################221################################################################################
191 222
192223# Active profile name. When unset, no profile is applied.[agents]
193224# 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"]
194 235
195################################################################################236################################################################################
196# Skills (per-skill overrides)237# Skills (per-skill overrides)
198 239
199# Disable or re-enable a specific skill without deleting it.240# Disable or re-enable a specific skill without deleting it.
200[[skills.config]]241[[skills.config]]
201242# path = "/path/to/skill"# path = "/path/to/skill/SKILL.md"
202# enabled = false243# enabled = false
203 244
204################################################################################
205# Experimental toggles (legacy; prefer [features])
206################################################################################
207
208experimental_use_unified_exec_tool = false
209
210# Include apply_patch via freeform editing path (affects default tool set). Default: false
211experimental_use_freeform_apply_patch = false
212
213################################################################################245################################################################################
214# Sandbox settings (tables)246# Sandbox settings (tables)
215################################################################################247################################################################################
232[shell_environment_policy]264[shell_environment_policy]
233# inherit: all (default) | core | none265# inherit: all (default) | core | none
234inherit = "all"266inherit = "all"
235267# 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
236268ignore_default_excludes = trueignore_default_excludes = false
237# Case-insensitive glob patterns to remove (e.g., "AWS_*", "AZURE_*"). Default: []269# Case-insensitive glob patterns to remove (e.g., "AWS_*", "AZURE_*"). Default: []
238exclude = []270exclude = []
239# Explicit key/value overrides (always win). Default: {}271# Explicit key/value overrides (always win). Default: {}
243# Experimental: run via user shell profile. Default: false275# Experimental: run via user shell profile. Default: false
244experimental_use_profile = false276experimental_use_profile = false
245 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
246################################################################################304################################################################################
247# History (table)305# History (table)
248################################################################################306################################################################################
251# save-all (default) | none309# save-all (default) | none
252persistence = "save-all"310persistence = "save-all"
253# 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
254312# max_bytes = 0# max_bytes = 5242880
255 313
256################################################################################314################################################################################
257# UI, Notifications, and Misc (tables)315# UI, Notifications, and Misc (tables)
274# 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).
275# alternate_screen = "auto"333# alternate_screen = "auto"
276 334
277335# 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.
278# status_line = ["model", "context-remaining", "git-branch"]338# status_line = ["model", "context-remaining", "git-branch"]
279 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
280# Control whether users can submit feedback from `/feedback`. Default: true358# Control whether users can submit feedback from `/feedback`. Default: true
281[feedback]359[feedback]
282enabled = true360enabled = true
288# hide_rate_limit_model_nudge = true366# hide_rate_limit_model_nudge = true
289# hide_gpt5_1_migration_prompt = true367# hide_gpt5_1_migration_prompt = true
290# "hide_gpt-5.1-codex-max_migration_prompt" = true368# "hide_gpt-5.1-codex-max_migration_prompt" = true
291369# model_migrations = { "gpt-4.1" = "gpt-5.1" }# model_migrations = { "gpt-5.3-codex" = "gpt-5.4" }
292
293# Suppress the warning shown when under-development feature flags are enabled.
294# suppress_unstable_features_warning = true
295 370
296################################################################################371################################################################################
297# Centralized Feature Flags (preferred)372# Centralized Feature Flags (preferred)
299 374
300[features]375[features]
301# 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.
302377shell_tool = true# shell_tool = true
303# apps = false378# apps = false
304379# apps_mcp_gateway = false# codex_hooks = false
305380# Deprecated legacy toggles; prefer the top-level `web_search` setting.# unified_exec = true
306381# web_search = false# shell_snapshot = true
307382# web_search_cached = false# multi_agent = true
308# web_search_request = false
309unified_exec = false
310shell_snapshot = false
311apply_patch_freeform = false
312# search_tool = false
313# personality = true383# personality = true
314384request_rule = true# fast_mode = true
315385collaboration_modes = true# guardian_approval = false
316386use_linux_sandbox_bwrap = false# enable_request_compression = true
317387experimental_windows_sandbox = false# skill_mcp_dependency_install = true
318388elevated_windows_sandbox = false# prevent_idle_sleep = false
319remote_models = false
320runtime_metrics = false
321powershell_utf8 = true
322child_agents_md = false
323 389
324################################################################################390################################################################################
325# Define MCP servers under this table. Leave empty to disable.391# Define MCP servers under this table. Leave empty to disable.
341# tool_timeout_sec = 60.0 # optional; default 60.0 seconds407# tool_timeout_sec = 60.0 # optional; default 60.0 seconds
342# enabled_tools = ["search", "summarize"] # optional allow-list408# enabled_tools = ["search", "summarize"] # optional allow-list
343# 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
344 412
345# --- Example: Streamable HTTP transport ---413# --- Example: Streamable HTTP transport ---
346# [mcp_servers.github]414# [mcp_servers.github]
353# startup_timeout_sec = 10.0 # optional421# startup_timeout_sec = 10.0 # optional
354# tool_timeout_sec = 60.0 # optional422# tool_timeout_sec = 60.0 # optional
355# 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
356 426
357################################################################################427################################################################################
358# Model Providers428# Model Providers
359################################################################################429################################################################################
360 430
361# Built-ins include:431# Built-ins include:
362432# - openai (Responses API; requires login or OPENAI_API_KEY via auth flow)# - openai
363433# - 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.
364 436
365[model_providers]437[model_providers]
366 438
368# [model_providers.openaidr]440# [model_providers.openaidr]
369# name = "OpenAI Data Residency"441# name = "OpenAI Data Residency"
370# 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
371443# wire_api = "responses" # "responses" | "chat" (default varies)# wire_api = "responses" # only supported value
372444# # requires_openai_auth = true # built-in OpenAI defaults to true# # requires_openai_auth = true # use only for providers backed by OpenAI auth
373# # request_max_retries = 4 # default 4; max 100445# # request_max_retries = 4 # default 4; max 100
374# # stream_max_retries = 5 # default 5; max 100446# # stream_max_retries = 5 # default 5; max 100
375# # stream_idle_timeout_ms = 300000 # default 300_000 (5m)447# # stream_idle_timeout_ms = 300000 # default 300_000 (5m)
448# # supports_websockets = true # optional
376# # experimental_bearer_token = "sk-example" # optional dev-only direct bearer token449# # experimental_bearer_token = "sk-example" # optional dev-only direct bearer token
377# # http_headers = { "X-Example" = "value" }450# # http_headers = { "X-Example" = "value" }
378# # env_http_headers = { "OpenAI-Organization" = "OPENAI_ORGANIZATION", "OpenAI-Project" = "OPENAI_PROJECT" }451# # env_http_headers = { "OpenAI-Organization" = "OPENAI_ORGANIZATION", "OpenAI-Project" = "OPENAI_PROJECT" }
379 452
380453# --- Example: Azure (Chat/Responses depending on endpoint) ---# --- Example: Azure/OpenAI-compatible provider ---
381# [model_providers.azure]454# [model_providers.azure]
382# name = "Azure"455# name = "Azure"
383# base_url = "https://YOUR_PROJECT_NAME.openai.azure.com/openai"456# base_url = "https://YOUR_PROJECT_NAME.openai.azure.com/openai"
384457# wire_api = "responses" # or "chat" per endpoint# wire_api = "responses"
385# query_params = { api-version = "2025-04-01-preview" }458# query_params = { api-version = "2025-04-01-preview" }
386# env_key = "AZURE_OPENAI_API_KEY"459# env_key = "AZURE_OPENAI_API_KEY"
387460# # 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
388 474
389# --- Example: Local OSS (e.g., Ollama-compatible) ---475# --- Example: Local OSS (e.g., Ollama-compatible) ---
390476# [model_providers.ollama]# [model_providers.local_ollama]
391# name = "Ollama"477# name = "Ollama"
392# base_url = "http://localhost:11434/v1"478# base_url = "http://localhost:11434/v1"
393479# 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# ]
394 509
395################################################################################510################################################################################
396# Profiles (named presets)511# Profiles (named presets)
399[profiles]514[profiles]
400 515
401# [profiles.default]516# [profiles.default]
402517# model = "gpt-5.2-codex"# model = "gpt-5.4"
403# model_provider = "openai"518# model_provider = "openai"
404# approval_policy = "on-request"519# approval_policy = "on-request"
405# sandbox_mode = "read-only"520# sandbox_mode = "read-only"
521# service_tier = "flex"
406# oss_provider = "ollama"522# oss_provider = "ollama"
407# model_reasoning_effort = "medium"523# model_reasoning_effort = "medium"
524# plan_mode_reasoning_effort = "high"
408# model_reasoning_summary = "auto"525# model_reasoning_summary = "auto"
409# model_verbosity = "medium"526# model_verbosity = "medium"
410527# personality = "friendly" # or "pragmatic" or "none"# personality = "pragmatic" # or "friendly" or "none"
411# 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"
412# experimental_compact_prompt_file = "./compact_prompt.txt"531# experimental_compact_prompt_file = "./compact_prompt.txt"
413532# include_apply_patch_tool = false# tools_view_image = true
414# experimental_use_unified_exec_tool = false
415# experimental_use_freeform_apply_patch = false
416# tools.web_search = false # deprecated legacy alias; prefer top-level `web_search`
417# features = { unified_exec = false }533# features = { unified_exec = false }
418 534
419################################################################################
420# Apps / Connectors
421################################################################################
422
423# Optional per-app controls.
424[apps]
425# [apps.google_drive]
426# enabled = false
427# disabled_reason = "user" # or "unknown"
428
429################################################################################535################################################################################
430# Projects (trust levels)536# Projects (trust levels)
431################################################################################537################################################################################
432 538
433# Mark specific worktrees as trusted or untrusted.
434[projects]539[projects]
540# Mark specific worktrees as trusted or untrusted.
435# [projects."/absolute/path/to/project"]541# [projects."/absolute/path/to/project"]
436# trust_level = "trusted" # or "untrusted"542# trust_level = "trusted" # or "untrusted"
437 543
544################################################################################
545# Tools
546################################################################################
547
548[tools]
549# view_image = true
550
438################################################################################551################################################################################
439# OpenTelemetry (OTEL) - disabled by default552# OpenTelemetry (OTEL) - disabled by default
440################################################################################553################################################################################
448exporter = "none"561exporter = "none"
449# Trace exporter: none (default) | otlp-http | otlp-grpc562# Trace exporter: none (default) | otlp-http | otlp-grpc
450trace_exporter = "none"563trace_exporter = "none"
564# Metrics exporter: none | statsig | otlp-http | otlp-grpc
565metrics_exporter = "statsig"
451 566
452# Example OTLP/HTTP exporter configuration567# Example OTLP/HTTP exporter configuration
453# [otel.exporter."otlp-http"]568# [otel.exporter."otlp-http"]
457# [otel.exporter."otlp-http".headers]572# [otel.exporter."otlp-http".headers]
458# "x-otlp-api-key" = "${OTLP_TOKEN}"573# "x-otlp-api-key" = "${OTLP_TOKEN}"
459 574
460# Example OTLP/gRPC exporter configuration
461# [otel.exporter."otlp-grpc"]
462# endpoint = "https://otel.example.com:4317",
463# headers = { "x-otlp-meta" = "abc123" }
464
465# Example OTLP exporter with mutual TLS
466# [otel.exporter."otlp-http"]
467# endpoint = "https://otel.example.com/v1/logs"
468# protocol = "binary"
469
470# [otel.exporter."otlp-http".headers]
471# "x-otlp-api-key" = "${OTLP_TOKEN}"
472
473# [otel.exporter."otlp-http".tls]575# [otel.exporter."otlp-http".tls]
474# ca-certificate = "certs/otel-ca.pem"576# ca-certificate = "certs/otel-ca.pem"
475# client-certificate = "/etc/codex/certs/client.pem"577# client-certificate = "/etc/codex/certs/client.pem"
476# 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"
477```592```