config-sample.md +187 −127
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 override52# 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)53# background_terminal_max_timeout = 300000 # ms; max empty write_stdin poll window (default 5m)
54# 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
55 56
56################################################################################57################################################################################
57# Reasoning & Verbosity (Responses API capable models)58# Reasoning & Verbosity (Responses API capable models)
58################################################################################59################################################################################
59 60
6061# 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
6162model_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"
62 66
6367# Reasoning summary: auto | concise | detailed | none (default: auto)# Reasoning summary: auto | concise | detailed | none
64# model_reasoning_summary = "auto"68# model_reasoning_summary = "auto"
65 69
6670# Text verbosity for GPT-5 family (Responses API): low | medium | high (default: medium)# Text verbosity for GPT-5 family (Responses API): low | medium | high
67# model_verbosity = "medium"71# model_verbosity = "medium"
68 72
6973# Force enable or disable reasoning summaries for current model# Force enable or disable reasoning summaries for current model.
70# model_supports_reasoning_summaries = true74# model_supports_reasoning_summaries = true
71 75
72################################################################################76################################################################################
76# Additional user instructions are injected before AGENTS.md. Default: unset.80# Additional user instructions are injected before AGENTS.md. Default: unset.
77# developer_instructions = ""81# developer_instructions = ""
78 82
79# (Ignored) Optional legacy base instructions override (prefer AGENTS.md). Default: unset.
80# instructions = ""
81
82# Inline override for the history compaction prompt. Default: unset.83# Inline override for the history compaction prompt. Default: unset.
83# compact_prompt = ""84# compact_prompt = ""
84 85
86# Override the default commit co-author trailer. Set to "" to disable it.
87# commit_attribution = "Jane Doe <jane@example.com>"
88
85# Override built-in base instructions with a file path. Default: unset.89# Override built-in base instructions with a file path. Default: unset.
86# model_instructions_file = "/absolute/or/relative/path/to/instructions.txt"90# model_instructions_file = "/absolute/or/relative/path/to/instructions.txt"
87 91
88# Migration note: experimental_instructions_file was renamed to model_instructions_file (deprecated).
89
90# Load the compact prompt override from a file. Default: unset.92# Load the compact prompt override from a file. Default: unset.
91# 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"
92 94
93# Legacy name for apply_patch_freeform. Default: false
94include_apply_patch_tool = false
95
96################################################################################95################################################################################
97# Notifications96# Notifications
98################################################################################97################################################################################
99 98
100# External notifier program (argv array). When unset: disabled.99# External notifier program (argv array). When unset: disabled.
101100# Example: notify = ["notify-send", "Codex"]# notify = ["notify-send", "Codex"]
102notify = [ ]
103 101
104################################################################################102################################################################################
105# Approval & Sandbox103# Approval & Sandbox
109# - untrusted: only known-safe read-only commands auto-run; others prompt107# - untrusted: only known-safe read-only commands auto-run; others prompt
110# - on-request: model decides when to ask (default)108# - on-request: model decides when to ask (default)
111# - never: never prompt (risky)109# - never: never prompt (risky)
112110# - { reject = { ... } }: auto-reject selected prompt categories# - { granular = { ... } }: allow or auto-reject selected prompt categories
113approval_policy = "on-request"111approval_policy = "on-request"
114112# Example granular auto-reject policy:# Who reviews eligible approval prompts: user (default) | guardian_subagent
115113# approval_policy = { reject = { sandbox_approval = true, rules = false, mcp_elicitations = false } }# 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# } }
116 123
117# Allow login-shell semantics for shell-based tools when they request `login = true`.124# Allow login-shell semantics for shell-based tools when they request `login = true`.
118# Default: true. Set false to force non-login shells and reject explicit login-shell requests.125# Default: true. Set false to force non-login shells and reject explicit login-shell requests.
123# - workspace-write130# - workspace-write
124# - danger-full-access (no sandbox; extremely risky)131# - danger-full-access (no sandbox; extremely risky)
125sandbox_mode = "read-only"132sandbox_mode = "read-only"
133# Named permissions profile to apply by default. Required before using [permissions.<name>].
134# default_permissions = "workspace"
126 135
127################################################################################136################################################################################
128# Authentication & Login137# Authentication & Login
131# Where to persist CLI login credentials: file (default) | keyring | auto140# Where to persist CLI login credentials: file (default) | keyring | auto
132cli_auth_credentials_store = "file"141cli_auth_credentials_store = "file"
133 142
134143# Base URL for ChatGPT auth flow (not OpenAI API). Default:# Base URL for ChatGPT auth flow (not OpenAI API).
135chatgpt_base_url = "https://chatgpt.com/backend-api/"144chatgpt_base_url = "https://chatgpt.com/backend-api/"
136 145
146# Optional base URL override for the built-in OpenAI provider.
147# openai_base_url = "https://us.api.openai.com/v1"
148
137# Restrict ChatGPT login to a specific workspace id. Default: unset.149# Restrict ChatGPT login to a specific workspace id. Default: unset.
138150# forced_chatgpt_workspace_id = ""# forced_chatgpt_workspace_id = "00000000-0000-0000-0000-000000000000"
139 151
140# Force login mechanism when Codex would normally auto-select. Default: unset.152# Force login mechanism when Codex would normally auto-select. Default: unset.
141# Allowed values: chatgpt | api153# Allowed values: chatgpt | api
200# 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.
201web_search = "cached"211web_search = "cached"
202 212
203################################################################################
204# Profiles (named presets)
205################################################################################
206
207# Active profile name. When unset, no profile is applied.213# Active profile name. When unset, no profile is applied.
208# profile = "default"214# profile = "default"
209 215
216# Suppress the warning shown when under-development feature flags are enabled.
217# suppress_unstable_features_warning = true
218
210################################################################################219################################################################################
211# Agents (multi-agent roles and limits)220# Agents (multi-agent roles and limits)
212################################################################################221################################################################################
213 222
214223# [agents][agents]
215# Maximum concurrently open agent threads. Default: 6224# Maximum concurrently open agent threads. Default: 6
216# max_threads = 6225# max_threads = 6
217# Maximum nested spawn depth. Root session starts at depth 0. Default: 1226# Maximum nested spawn depth. Root session starts at depth 0. Default: 1
218# max_depth = 1227# 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
219 230
220# [agents.reviewer]231# [agents.reviewer]
221232# description = "Find security, correctness, and test risks in code."# description = "Find correctness, security, and test risks in code."
222# config_file = "./agents/reviewer.toml" # relative to the config.toml that defines it233# config_file = "./agents/reviewer.toml" # relative to the config.toml that defines it
234# nickname_candidates = ["Athena", "Ada"]
223 235
224################################################################################236################################################################################
225# Skills (per-skill overrides)237# Skills (per-skill overrides)
227 239
228# Disable or re-enable a specific skill without deleting it.240# Disable or re-enable a specific skill without deleting it.
229[[skills.config]]241[[skills.config]]
230242# path = "/path/to/skill"# path = "/path/to/skill/SKILL.md"
231# enabled = false243# enabled = false
232 244
233################################################################################
234# Experimental toggles (legacy; prefer [features])
235################################################################################
236
237experimental_use_unified_exec_tool = false
238
239# Include apply_patch via freeform editing path (affects default tool set). Default: false
240experimental_use_freeform_apply_patch = false
241
242################################################################################245################################################################################
243# Sandbox settings (tables)246# Sandbox settings (tables)
244################################################################################247################################################################################
261[shell_environment_policy]264[shell_environment_policy]
262# inherit: all (default) | core | none265# inherit: all (default) | core | none
263inherit = "all"266inherit = "all"
264267# 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
265268ignore_default_excludes = trueignore_default_excludes = false
266# Case-insensitive glob patterns to remove (e.g., "AWS_*", "AZURE_*"). Default: []269# Case-insensitive glob patterns to remove (e.g., "AWS_*", "AZURE_*"). Default: []
267exclude = []270exclude = []
268# Explicit key/value overrides (always win). Default: {}271# Explicit key/value overrides (always win). Default: {}
272# Experimental: run via user shell profile. Default: false275# Experimental: run via user shell profile. Default: false
273experimental_use_profile = false276experimental_use_profile = false
274 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
275################################################################################304################################################################################
276# History (table)305# History (table)
277################################################################################306################################################################################
280# save-all (default) | none309# save-all (default) | none
281persistence = "save-all"310persistence = "save-all"
282# 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
283312# max_bytes = 0# max_bytes = 5242880
284 313
285################################################################################314################################################################################
286# UI, Notifications, and Misc (tables)315# UI, Notifications, and Misc (tables)
308# Set to [] to hide the footer.337# Set to [] to hide the footer.
309# status_line = ["model", "context-remaining", "git-branch"]338# status_line = ["model", "context-remaining", "git-branch"]
310 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
311# Syntax-highlighting theme (kebab-case). Use /theme in the TUI to preview and save.346# Syntax-highlighting theme (kebab-case). Use /theme in the TUI to preview and save.
312# You can also add custom .tmTheme files under $CODEX_HOME/themes.347# You can also add custom .tmTheme files under $CODEX_HOME/themes.
313# theme = "catppuccin-mocha"348# theme = "catppuccin-mocha"
314 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
315# Control whether users can submit feedback from `/feedback`. Default: true358# Control whether users can submit feedback from `/feedback`. Default: true
316[feedback]359[feedback]
317enabled = true360enabled = true
323# hide_rate_limit_model_nudge = true366# hide_rate_limit_model_nudge = true
324# hide_gpt5_1_migration_prompt = true367# hide_gpt5_1_migration_prompt = true
325# "hide_gpt-5.1-codex-max_migration_prompt" = true368# "hide_gpt-5.1-codex-max_migration_prompt" = true
326369# model_migrations = { "gpt-4.1" = "gpt-5.1" }# model_migrations = { "gpt-5.3-codex" = "gpt-5.4" }
327
328# Suppress the warning shown when under-development feature flags are enabled.
329# suppress_unstable_features_warning = true
330 370
331################################################################################371################################################################################
332# Centralized Feature Flags (preferred)372# Centralized Feature Flags (preferred)
336# 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.
337# shell_tool = true377# shell_tool = true
338# apps = false378# apps = false
339379# apps_mcp_gateway = false# codex_hooks = false
340380# web_search_cached = false# unified_exec = true
341381# web_search_request = false# shell_snapshot = true
342382# unified_exec = false# multi_agent = true
343# shell_snapshot = false
344# apply_patch_freeform = false
345# multi_agent = false
346# search_tool = false
347# personality = true383# personality = true
348384# request_rule = true# fast_mode = true
349385# collaboration_modes = true# smart_approvals = false
350386# use_linux_sandbox_bwrap = false# enable_request_compression = true
351387# remote_models = false# skill_mcp_dependency_install = true
352388# runtime_metrics = false# prevent_idle_sleep = false
353# powershell_utf8 = true
354# child_agents_md = false
355 389
356################################################################################390################################################################################
357# Define MCP servers under this table. Leave empty to disable.391# Define MCP servers under this table. Leave empty to disable.
373# tool_timeout_sec = 60.0 # optional; default 60.0 seconds407# tool_timeout_sec = 60.0 # optional; default 60.0 seconds
374# enabled_tools = ["search", "summarize"] # optional allow-list408# enabled_tools = ["search", "summarize"] # optional allow-list
375# 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
376 412
377# --- Example: Streamable HTTP transport ---413# --- Example: Streamable HTTP transport ---
378# [mcp_servers.github]414# [mcp_servers.github]
385# startup_timeout_sec = 10.0 # optional421# startup_timeout_sec = 10.0 # optional
386# tool_timeout_sec = 60.0 # optional422# tool_timeout_sec = 60.0 # optional
387# 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
388 426
389################################################################################427################################################################################
390# Model Providers428# Model Providers
391################################################################################429################################################################################
392 430
393# Built-ins include:431# Built-ins include:
394432# - openai (Responses API; requires login or OPENAI_API_KEY via auth flow)# - openai
395433# - 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.
396 436
397[model_providers]437[model_providers]
398 438
400# [model_providers.openaidr]440# [model_providers.openaidr]
401# name = "OpenAI Data Residency"441# name = "OpenAI Data Residency"
402# 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
403443# wire_api = "responses" # "responses" | "chat" (default varies)# wire_api = "responses" # only supported value
404444# # requires_openai_auth = true # built-in OpenAI defaults to true# # requires_openai_auth = true # use only for providers backed by OpenAI auth
405# # request_max_retries = 4 # default 4; max 100445# # request_max_retries = 4 # default 4; max 100
406# # stream_max_retries = 5 # default 5; max 100446# # stream_max_retries = 5 # default 5; max 100
407# # stream_idle_timeout_ms = 300000 # default 300_000 (5m)447# # stream_idle_timeout_ms = 300000 # default 300_000 (5m)
448# # supports_websockets = true # optional
408# # experimental_bearer_token = "sk-example" # optional dev-only direct bearer token449# # experimental_bearer_token = "sk-example" # optional dev-only direct bearer token
409# # http_headers = { "X-Example" = "value" }450# # http_headers = { "X-Example" = "value" }
410# # env_http_headers = { "OpenAI-Organization" = "OPENAI_ORGANIZATION", "OpenAI-Project" = "OPENAI_PROJECT" }451# # env_http_headers = { "OpenAI-Organization" = "OPENAI_ORGANIZATION", "OpenAI-Project" = "OPENAI_PROJECT" }
411 452
412453# --- Example: Azure (Chat/Responses depending on endpoint) ---# --- Example: Azure/OpenAI-compatible provider ---
413# [model_providers.azure]454# [model_providers.azure]
414# name = "Azure"455# name = "Azure"
415# base_url = "https://YOUR_PROJECT_NAME.openai.azure.com/openai"456# base_url = "https://YOUR_PROJECT_NAME.openai.azure.com/openai"
416457# wire_api = "responses" # or "chat" per endpoint# wire_api = "responses"
417# query_params = { api-version = "2025-04-01-preview" }458# query_params = { api-version = "2025-04-01-preview" }
418# env_key = "AZURE_OPENAI_API_KEY"459# env_key = "AZURE_OPENAI_API_KEY"
419460# # 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
420 474
421# --- Example: Local OSS (e.g., Ollama-compatible) ---475# --- Example: Local OSS (e.g., Ollama-compatible) ---
422476# [model_providers.ollama]# [model_providers.local_ollama]
423# name = "Ollama"477# name = "Ollama"
424# base_url = "http://localhost:11434/v1"478# base_url = "http://localhost:11434/v1"
425479# wire_api = "chat"# wire_api = "responses"
426
427################################################################################
428# Profiles (named presets)
429################################################################################
430
431[profiles]
432
433# [profiles.default]
434# model = "gpt-5.2-codex"
435# model_provider = "openai"
436# approval_policy = "on-request"
437# sandbox_mode = "read-only"
438# oss_provider = "ollama"
439# model_reasoning_effort = "medium"
440# model_reasoning_summary = "auto"
441# model_verbosity = "medium"
442# personality = "friendly" # or "pragmatic" or "none"
443# chatgpt_base_url = "https://chatgpt.com/backend-api/"
444# model_catalog_json = "./models.json"
445# experimental_compact_prompt_file = "./compact_prompt.txt"
446# include_apply_patch_tool = false
447# experimental_use_unified_exec_tool = false
448# experimental_use_freeform_apply_patch = false
449# tools.web_search = false # deprecated legacy alias; prefer top-level `web_search`
450# features = { unified_exec = false }
451 480
452################################################################################481################################################################################
453# Apps / Connectors482# Apps / Connectors
471# enabled = false500# enabled = false
472# approval_mode = "approve"501# approval_mode = "approve"
473 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# ]
509
510################################################################################
511# Profiles (named presets)
512################################################################################
513
514[profiles]
515
516# [profiles.default]
517# model = "gpt-5.4"
518# model_provider = "openai"
519# approval_policy = "on-request"
520# sandbox_mode = "read-only"
521# service_tier = "flex"
522# oss_provider = "ollama"
523# model_reasoning_effort = "medium"
524# plan_mode_reasoning_effort = "high"
525# model_reasoning_summary = "auto"
526# model_verbosity = "medium"
527# personality = "pragmatic" # or "friendly" or "none"
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"
531# experimental_compact_prompt_file = "./compact_prompt.txt"
532# tools_view_image = true
533# features = { unified_exec = false }
534
474################################################################################535################################################################################
475# Projects (trust levels)536# Projects (trust levels)
476################################################################################537################################################################################
477 538
478# Mark specific worktrees as trusted or untrusted.
479[projects]539[projects]
540# Mark specific worktrees as trusted or untrusted.
480# [projects."/absolute/path/to/project"]541# [projects."/absolute/path/to/project"]
481# trust_level = "trusted" # or "untrusted"542# trust_level = "trusted" # or "untrusted"
482 543
544################################################################################
545# Tools
546################################################################################
547
548[tools]
549# view_image = true
550
483################################################################################551################################################################################
484# OpenTelemetry (OTEL) - disabled by default552# OpenTelemetry (OTEL) - disabled by default
485################################################################################553################################################################################
493exporter = "none"561exporter = "none"
494# Trace exporter: none (default) | otlp-http | otlp-grpc562# Trace exporter: none (default) | otlp-http | otlp-grpc
495trace_exporter = "none"563trace_exporter = "none"
564# Metrics exporter: none | statsig | otlp-http | otlp-grpc
565metrics_exporter = "statsig"
496 566
497# Example OTLP/HTTP exporter configuration567# Example OTLP/HTTP exporter configuration
498# [otel.exporter."otlp-http"]568# [otel.exporter."otlp-http"]
502# [otel.exporter."otlp-http".headers]572# [otel.exporter."otlp-http".headers]
503# "x-otlp-api-key" = "${OTLP_TOKEN}"573# "x-otlp-api-key" = "${OTLP_TOKEN}"
504 574
505# Example OTLP/gRPC exporter configuration
506# [otel.exporter."otlp-grpc"]
507# endpoint = "https://otel.example.com:4317",
508# headers = { "x-otlp-meta" = "abc123" }
509
510# Example OTLP exporter with mutual TLS
511# [otel.exporter."otlp-http"]
512# endpoint = "https://otel.example.com/v1/logs"
513# protocol = "binary"
514
515# [otel.exporter."otlp-http".headers]
516# "x-otlp-api-key" = "${OTLP_TOKEN}"
517
518# [otel.exporter."otlp-http".tls]575# [otel.exporter."otlp-http".tls]
519# ca-certificate = "certs/otel-ca.pem"576# ca-certificate = "certs/otel-ca.pem"
520# client-certificate = "/etc/codex/certs/client.pem"577# client-certificate = "/etc/codex/certs/client.pem"
521# client-private-key = "/etc/codex/certs/client-key.pem"578# client-private-key = "/etc/codex/certs/client-key.pem"
522```
523 579
524580################################################################################# 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" }
525 584
585################################################################################
526# Windows586# Windows
527
528################################################################################587################################################################################
529 588
530[windows]589[windows]
531
532# Native Windows sandbox mode (Windows only): unelevated | elevated590# Native Windows sandbox mode (Windows only): unelevated | elevated
533
534sandbox = "unelevated"591sandbox = "unelevated"
592```