Configuration Reference
For the complete documentation index, see llms.txt . Markdown versions of documentation pages are available by appending .md to the page URL.
Use this page as a searchable reference for Codex configuration files. For conceptual guidance and examples, start with Config basics and Advanced Config .
config.tomlUser-level configuration lives in ~/.codex/config.toml. You can also add project-scoped overrides in .codex/config.toml files. Codex loads project-scoped config files only when you trust the project.
Project-scoped config can't override machine-local provider, auth,
host-owned app request metadata, notification, configuration profile selection,
or telemetry routing keys. Codex ignores openai_base_url,
chatgpt_base_url, apps_mcp_product_sku, model_provider,
model_providers, notify, profile, profiles,
experimental_realtime_ws_base_url, and otel when they appear in a
project-local .codex/config.toml; put provider, notification, and telemetry
keys in user-level config instead. Config profile files live next to
config.toml as $CODEX_HOME/profile-name.config.toml; select one with
--profile profile-name.
For sandbox and approval keys (approval_policy, sandbox_mode, and sandbox_workspace_write.*), pair this reference with Sandbox and approvals , Protected paths in writable roots , and Network access . For beta permission profiles, see Permissions .
Codex and ChatGPT Work no longer support approval_policy = "untrusted".
Remove the setting or choose a supported policy. Project entries with
trust_level = "untrusted" in user-level ~/.codex/config.toml remain supported. See
Migrate from the retired untrusted approval policy
for examples and approval tradeoffs.
<ConfigTable
options={[
{
key: "model",
type: "string",
description: "Model to use (e.g., gpt-6-sol).",
},
{
key: "review_model",
type: "string",
description:
"Optional model override used by /review (defaults to the current session model).",
},
{
key: "model_provider",
type: "string",
description: "Provider id from model_providers (default: openai).",
},
{
key: "openai_base_url",
type: "string",
description:
"Base URL override for the built-in openai model provider.",
},
{
key: "model_context_window",
type: "number",
description: "Context window tokens available to the active model.",
},
{
key: "model_auto_compact_token_limit",
type: "number",
description:
"Token threshold that triggers automatic history compaction (unset uses model defaults).",
},
{
key: "model_auto_compact_token_limit_scope",
type: "total | body_after_prefix",
description:
"Controls whether the auto-compaction threshold counts the full active context (total, the default) or only growth after the carried compaction-window prefix (body_after_prefix).",
},
{
key: "model_catalog_json",
type: "string (path)",
description:
"Optional path to a JSON model catalog loaded on startup. A selected $CODEX_HOME/profile-name.config.toml profile file can override this per profile.",
},
{
key: "oss_provider",
type: "lmstudio | ollama",
description:
"Default local provider used when running with --oss (defaults to prompting if unset).",
},
{
key: "approval_policy",
type: "on-request | never | { granular = { sandbox_approval = bool, rules = bool, mcp_elicitations = bool, request_permissions = bool, skill_approval = bool } }",
description:
"Controls when Codex pauses for approval before executing commands. You can also use approval_policy = { granular = { ... } } to allow or auto-reject specific prompt categories while keeping other prompts interactive. untrusted is unsupported, and on-failure is deprecated; use on-request for interactive runs or never for non-interactive runs.",
},
{
key: "approval_policy.granular.sandbox_approval",
type: "boolean",
description:
"When true, sandbox escalation approval prompts are allowed to surface.",
},
{
key: "approval_policy.granular.rules",
type: "boolean",
description:
"When true, approvals triggered by execpolicy prompt rules are allowed to surface.",
},
{
key: "approval_policy.granular.mcp_elicitations",
type: "boolean",
description:
"When true, MCP elicitation prompts are allowed to surface instead of being auto-rejected.",
},
{
key: "approval_policy.granular.request_permissions",
type: "boolean",
description:
"When true, prompts from the request_permissions tool are allowed to surface.",
},
{
key: "approval_policy.granular.skill_approval",
type: "boolean",
description:
"When true, skill-script approval prompts are allowed to surface.",
},
{
key: "approvals_reviewer",
type: "user | auto_review",
description:
"Who reviews eligible approval prompts under on-request or granular approval policies. Defaults to user; auto_review uses the reviewer subagent. This setting doesn't change sandboxing or review actions already allowed inside the sandbox.",
},
{
key: "auto_review.policy",
type: "string",
description:
"Local Markdown policy instructions for automatic review. Managed guardian_policy_config takes precedence. Blank values are ignored.",
},
{
key: "auto_review.extra_policy",
type: "string",
description:
"Additional local Markdown policy for automatic review, included alongside the main policy. Managed guardian_extra_policy takes precedence. Blank values are ignored.",
},
{
key: "allow_login_shell",
type: "boolean",
description:
"Allow shell-based tools to use login-shell semantics. Defaults to true; when false, login = true requests are rejected and omitted login defaults to non-login shells.",
},
{
key: "sandbox_mode",
type: "read-only | workspace-write | danger-full-access",
description:
"Sandbox policy for filesystem and network access during command execution.",
},
{
key: "sandbox_workspace_write.writable_roots",
type: "array",
description:
'Additional writable roots when sandbox_mode = "workspace-write".',
},
{
key: "sandbox_workspace_write.network_access",
type: "boolean",
description:
"Allow outbound network access inside the workspace-write sandbox.",
},
{
key: "sandbox_workspace_write.exclude_tmpdir_env_var",
type: "boolean",
description:
"Exclude $TMPDIR from writable roots in workspace-write mode.",
},
{
key: "sandbox_workspace_write.exclude_slash_tmp",
type: "boolean",
description:
"Exclude /tmp from writable roots in workspace-write mode.",
},
{
key: "windows.sandbox",
type: "unelevated | elevated | mxc",
description:
"Windows-only native sandbox mode when running Codex natively on Windows.",
},
{
key: "browser_use.allow_history_access",
type: "boolean",
description:
"Set to false to restrict browser-history access. Managed requirements can enforce this restriction.",
},
{
key: "browser_use.default_origin_policy",
type: "table",
description:
"Fallback browser-origin restrictions. Supports access, uploads, downloads, and full_cdp_access, each set to allow or deny.",
},
{
key: "browser_use.origins.",
type: "table",
description:
"Per-origin browser restrictions with the same fields as browser_use.default_origin_policy. Include an HTTP or HTTPS scheme and optional port; omit paths, queries, and fragments. Local values cannot relax managed denies.",
},
{
key: "computer_use.default_app_access",
type: "allow | deny",
description:
"Fallback native-app access policy for Computer Use. App-specific entries can supply a policy; local configuration cannot relax managed restrictions.",
},
{
key: "computer_use.macos.bundle_ids",
type: "map<string, allow | deny>",
description: "Native macOS app access keyed by bundle identifier.",
},
{
key: "computer_use.windows.aumids",
type: "map<string, allow | deny>",
description:
"Packaged Windows app access keyed by Application User Model ID (AUMID).",
},
{
key: "computer_use.windows.exes",
type: "array",
description:
"Windows executable access rules. Each rule requires publisher_name, product_name, and access (allow or deny); binary_name is optional.",
},
{
key: "computer_use.windows.always_allowed_app_ids",
type: "array",
description:
"Windows app identifiers that Computer Use can open without prompting. Apps not in the list require approval; remove saved entries from the ChatGPT desktop app's Computer Use settings.",
},
{
key: "notify",
type: "array",
description:
"Command invoked for notifications; receives a JSON payload from Codex.",
},
{
key: "check_for_update_on_startup",
type: "boolean",
description:
"Check for Codex updates on startup (set to false only when updates are centrally managed).",
},
{
key: "feedback.enabled",
type: "boolean",
description:
"Enable feedback submission via /feedback across local clients (default: true).",
},
{
key: "analytics.enabled",
type: "boolean",
description:
"Enable or disable analytics for this machine/profile. When unset, the client default applies.",
},
{
key: "instructions",
type: "string",
description:
"Reserved for future use; prefer model_instructions_file or AGENTS.md.",
},
{
key: "developer_instructions",
type: "string",
description:
"Additional developer instructions injected into the session (optional).",
},
{
key: "log_dir",
type: "string (path)",
description:
"Directory where Codex writes log files; defaults to $CODEX_HOME/log. Setting this explicitly also enables the opt-in plaintext TUI log, codex-tui.log, in that directory.",
},
{
key: "sqlite_home",
type: "string (path)",
description:
"Directory where Codex stores the SQLite-backed state DB used by agent jobs and other resumable runtime state.",
},
{
key: "compact_prompt",
type: "string",
description: "Inline override for the history compaction prompt.",
},
{
key: "model_instructions_file",
type: "string (path)",
description:
"Replacement for built-in instructions instead of AGENTS.md.",
},
{
key: "personality",
type: "none | friendly | pragmatic",
description:
"Default communication style for models that advertise supportsPersonality; can be overridden per thread/turn or via /personality.",
},
{
key: "service_tier",
type: "string",
description:
"Preferred service tier for new turns. Use fast or another tier advertised by the active model; fast maps to the request value priority.",
},
{
key: "experimental_compact_prompt_file",
type: "string (path)",
description:
"Load the compaction prompt override from a file (experimental).",
},
{
key: "skills.max_context_tokens",
type: "integer (positive)",
description:
"Token budget for the available-skills catalog. Defaults to 2% of the model's context window. Explicit values are capped at 10000 tokens.",
},
{
key: "skills.config",
type: "array",
description: "Per-skill enablement overrides stored in config.toml.",
},
{
key: "skills.config..path",
type: "string (path)",
description: "Path to a skill folder containing SKILL.md.",
},
{
key: "skills.config..enabled",
type: "boolean",
description: "Enable or disable the referenced skill.",
},
{
key: "apps..enabled",
type: "boolean",
description:
"Enable or disable a specific app/connector by id (default: true).",
},
{
key: "apps._default.enabled",
type: "boolean",
description:
"Default app enabled state for all apps unless overridden per app.",
},
{
key: "apps._default.destructive_enabled",
type: "boolean",
description:
"Default allow/deny for app tools with destructive_hint = true.",
},
{
key: "apps._default.open_world_enabled",
type: "boolean",
description:
"Default allow/deny for app tools with open_world_hint = true.",
},
{
key: "apps._default.approvals_reviewer",
type: "user | auto_review",
description:
"Default reviewer for app tool approval prompts unless overridden per app. When omitted, apps inherit the top-level approvals_reviewer value.",
},
{
key: "apps._default.default_tools_approval_mode",
type: "auto | prompt | writes | approve",
description:
"Default approval behavior for app tools without per-app or per-tool overrides.",
},
{
key: "apps..destructive_enabled",
type: "boolean",
description:
"Allow or block tools in this app that advertise destructive_hint = true.",
},
{
key: "apps..open_world_enabled",
type: "boolean",
description:
"Allow or block tools in this app that advertise open_world_hint = true.",
},
{
key: "apps..default_tools_enabled",
type: "boolean",
description:
"Default enabled state for tools in this app unless a per-tool override exists.",
},
{
key: "apps..approvals_reviewer",
type: "user | auto_review",
description:
"Reviewer for this app's tool approval prompts. Overrides apps._default.approvals_reviewer.",
},
{
key: "apps..default_tools_approval_mode",
type: "auto | prompt | writes | approve",
description:
"Default approval behavior for tools in this app unless a per-tool override exists.",
},
{
key: "apps..tools..enabled",
type: "boolean",
description:
"Per-tool enabled override for an app tool (for example repos/list).",
},
{
key: "apps..tools..approval_mode",
type: "auto | prompt | writes | approve",
description: "Per-tool approval behavior override for a single app tool.",
},
{
key: "tool_suggest.discoverables",
type: "array",
description:
'Allow tool suggestions for additional discoverable connectors or plugins. Each entry uses type = "connector" or "plugin" and an id.',
},
{
key: "tool_suggest.disabled_tools",
type: "array",
description:
'Disable suggestions for specific discoverable connectors or plugins. Each entry uses type = "connector" or "plugin" and an id.',
},
{
key: "features.apps",
type: "boolean",
description:
"Enable app (connector) integrations (stable; on by default). App and connector traffic is not controlled by the sandboxed-command network proxy or its domain allowlist.",
},
{
key: "features.hooks",
type: "boolean",
description:
"Enable lifecycle hooks loaded from hooks.json or inline [hooks] config. features.codex_hooks is a deprecated alias.",
},
{
key: "features.code_mode.enabled",
type: "boolean",
description:
"Enable code mode feature configuration. This feature is under development and off by default.",
},
{
key: "features.code_mode.excluded_tool_namespaces",
type: "array",
description:
"Tool namespaces code mode excludes from nested code-mode tool guidance and executor exposure.",
},
{
key: "features.code_mode.direct_only_tool_namespaces",
type: "array",
description:
"Tool namespaces code mode can use only through direct tool calls.",
},
{
key: "features.context_management.experimental_mode",
type: "boolean",
description:
"Enable experimental context management (off by default). Rather than repeatedly compressing context into a single summary, it uses notes and searchable history to preserve accumulated details. Requires ChatGPT sign-in on Plus, Pro, or Pro Lite.",
},
{
key: "features.rollout_budget.enabled",
type: "boolean",
description:
"Enable rollout budget tracking. This feature is under development and off by default. When enabled, features.rollout_budget.limit_tokens is required.",
},
{
key: "features.rollout_budget.limit_tokens",
type: "integer",
description:
"Positive token limit for rollout budget tracking. Required when rollout budget is enabled.",
},
{
key: "features.rollout_budget.reminder_interval_tokens",
type: "integer",
description:
"Positive token interval between rollout budget reminders. Defaults to 10% of limit_tokens, with a minimum of 1 token.",
},
{
key: "features.rollout_budget.sampling_token_weight",
type: "number",
description:
"Finite non-negative multiplier for sampled tokens in rollout budget accounting. Defaults to 1.0.",
},
{
key: "features.rollout_budget.prefill_token_weight",
type: "number",
description:
"Finite non-negative multiplier for prefill tokens in rollout budget accounting. Defaults to 1.0.",
},
{
key: "hooks",
type: "table",
description:
"Lifecycle hooks configured inline in config.toml. Uses the same event schema as hooks.json; see the Hooks guide for examples and supported events.",
},
{
key: "hooks.",
type: "array",
description:
"Matcher groups for hook events such as PreToolUse, PermissionRequest, PostToolUse, PreCompact, PostCompact, SessionStart, SessionEnd, SubagentStart, SubagentStop, UserPromptSubmit, Stop, or Interrupt.",
},
{
key: "hooks.[].hooks",
type: "array",
description:
"Hook handlers for a matcher group. Command and MCP tool hooks are supported while prompt and agent hook handlers are parsed but skipped.",
},
{
key: "hooks.[].hooks[].async",
type: "boolean",
description:
"Run a command hook in the background without delaying the triggering operation. Defaults to false; SessionEnd always runs synchronously. See Run hooks in the background .",
},
{
key: "hooks.[].hooks[].additionalContextLimit",
type: "integer",
description:
"Approximate per-handler token threshold for saving oversized additionalContext to disk and showing the model a shorter preview. Defaults to 2500; 0 passes the full context directly to the model. See Large hook output .",
},
{
key: "hooks.[].hooks[].commandWindows",
type: "string",
description:
"Windows-only command override for command hooks. The TOML alias command_windows is also accepted.",
},
{
key: "features.memories",
type: "boolean",
description:
"Enable Memories (off by default).",
},
{
key: "mcp_optional_startup_grace_ms",
type: "integer (milliseconds)",
description:
"Shared wait for optional MCP servers when building the initial tool catalog. Defaults to 1000. Set to 0 to wait for each server's startup_timeout_sec instead.",
},
{
key: "mcp_servers..command",
type: "string",
description: "Launcher command for an MCP stdio server.",
},
{
key: "mcp_servers..args",
type: "array",
description: "Arguments passed to the MCP stdio server command.",
},
{
key: "mcp_servers..env",
type: "map<string,string>",
description: "Environment variables forwarded to the MCP stdio server.",
},
{
key: "mcp_servers..env_vars",
type: 'array<string | { name = string, source = "local" | "remote" }>',
description:
'Additional environment variables to whitelist for an MCP stdio server. String entries default to source = "local"; use source = "remote" only with executor-backed remote stdio.',
},
{
key: "mcp_servers..cwd",
type: "string",
description: "Working directory for the MCP stdio server process.",
},
{
key: "mcp_servers..url",
type: "string",
description: "Endpoint for an MCP streamable HTTP server.",
},
{
key: "mcp_servers..auth",
type: "oauth | chatgpt",
description:
"Authentication fallback for an MCP HTTP server after configured bearer tokens and authorization headers. oauth (default) uses stored MCP OAuth credentials when available. chatgpt uses the current ChatGPT session for the trusted first-party ChatGPT origin, then falls back to stored OAuth. Both modes can connect without authentication if no credential source resolves.",
},
{
key: "mcp_servers..oauth.client_id",
type: "string",
description:
"Pre-registered OAuth client ID used for authorization and token exchange with this MCP server.",
},
{
key: "mcp_servers..oauth.callback_url",
type: "string",
description:
"Server-specific OAuth callback. Pre-registered clients reuse it when issuer identification is supported or the URL already ends in the server-specific callback ID. Otherwise, Codex uses the global or default callback with that ID appended. Clients without a pre-registered ID use this callback during client registration.",
},
{
key: "mcp_servers..oauth.callback_port",
type: "integer",
description:
"Fixed OAuth callback listener port for this MCP server. Overrides mcp_oauth_callback_port. For a direct loopback callback with an explicit URL port, configure the same listener port.",
},
{
key: "mcp_servers..bearer_token_env_var",
type: "string",
description:
"Environment variable sourcing the bearer token for an MCP HTTP server.",
},
{
key: "mcp_servers..http_headers",
type: "map<string,string>",
description: "Static HTTP headers included with each MCP HTTP request.",
},
{
key: "mcp_servers..http_headers_helper",
type: "string (command)",
description:
"Local command that prints a JSON object of HTTP header names and values. Supported only for locally connected HTTP MCP servers. Explicit bearer tokens and OAuth credentials take precedence over helper-provided Authorization headers.",
},
{
key: "mcp_servers..env_http_headers",
type: "map<string,string>",
description:
"HTTP headers populated from environment variables for an MCP HTTP server.",
},
{
key: "mcp_servers..enabled",
type: "boolean",
description: "Disable an MCP server without removing its configuration.",
},
{
key: "mcp_servers..required",
type: "boolean",
description:
"When true, fail startup/resume if this enabled MCP server cannot initialize.",
},
{
key: "mcp_servers..startup_timeout_sec",
type: "number",
description:
"Override the default 10s startup timeout for an MCP server.",
},
{
key: "mcp_servers..startup_timeout_ms",
type: "number",
description: "Alias for startup_timeout_sec in milliseconds.",
},
{
key: "mcp_servers..tool_timeout_sec",
type: "number",
description:
"Override the default 60s per-tool timeout for an MCP server.",
},
{
key: "mcp_servers..enabled_tools",
type: "array",
description: "Allow list of tool names exposed by the MCP server.",
},
{
key: "mcp_servers..disabled_tools",
type: "array",
description:
"Deny list applied after enabled_tools for the MCP server.",
},
{
key: "mcp_servers..default_tools_approval_mode",
type: "auto | prompt | writes | approve",
description:
"Default approval behavior for MCP tools on this server unless a per-tool override exists.",
},
{
key: "mcp_servers..tools..approval_mode",
type: "auto | prompt | writes | approve",
description:
"Per-tool approval behavior override for one MCP tool on this server.",
},
{
key: "mcp_servers..tools..output_token_limit",
type: "integer (positive)",
description:
"Token budget for one MCP tool's output, before the standard 20% serialization allowance. Overrides the model's default output truncation budget for that tool.",
},
{
key: "mcp_servers..scopes",
type: "array",
description:
"OAuth scopes to request when authenticating to that MCP server.",
},
{
key: "mcp_servers..oauth_resource",
type: "string",
description:
"Optional RFC 8707 OAuth resource parameter to include during MCP login.",
},
{
key: "mcp_servers..experimental_environment",
type: "local | remote",
description:
"Experimental placement for an MCP server. remote starts stdio servers through a remote executor environment; streamable HTTP remote placement is not implemented.",
},
{
key: "agents",
type: "table",
description:
"Multi-agent settings and custom role declarations. Scalar setting names are reserved and can't be used as custom role names.",
},
{
key: "agents.enabled",
type: "boolean",
description: "Enable or disable multi-agent tools (default: true).",
},
{
key: "agents.max_concurrent_threads_per_session",
type: "number",
description:
"Maximum number of spawned-agent threads that can be open concurrently, excluding the primary thread. When unset, Codex chooses the default.",
},
{
key: "agents.max_threads",
type: "number",
description:
"Legacy alias for agents.max_concurrent_threads_per_session.",
},
{
key: "agents.default_subagent_model",
type: "string",
description:
"Default model for spawned agents. An explicit spawn model takes precedence.",
},
{
key: "agents.default_subagent_reasoning_effort",
type: "string",
description:
"Default reasoning effort for spawned agents. An explicit spawn effort takes precedence.",
},
{
key: "agents.interrupt_message",
type: "boolean",
description:
"Record a model-visible message when an agent turn is interrupted (default: true).",
},
{
key: "agents..description",
type: "string",
description:
"Role guidance shown to Codex when choosing and spawning that agent type.",
},
{
key: "agents..config_file",
type: "string (path)",
description:
"Path to a TOML config layer for that role; relative paths resolve from the config file that declares the role.",
},
{
key: "memories.generate_memories",
type: "boolean",
description:
"When false, newly created threads are not stored as memory-generation inputs. Defaults to true.",
},
{
key: "memories.use_memories",
type: "boolean",
description:
"When false, Codex skips injecting existing memories into future sessions. Defaults to true.",
},
{
key: "memories.disable_on_external_context",
type: "boolean",
description:
"When true, threads that use external context such as MCP tool calls, web search, or tool search are kept out of memory generation. Defaults to false. Legacy alias: memories.no_memories_if_mcp_or_web_search.",
},
{
key: "memories.max_raw_memories_for_consolidation",
type: "number",
description:
"Maximum recent raw memories retained for global consolidation. Defaults to 256 and is capped at 4096.",
},
{
key: "memories.max_unused_days",
type: "number",
description:
"Maximum days since a memory was last used before it becomes ineligible for consolidation. Defaults to 30 and is clamped to 0-365.",
},
{
key: "memories.max_rollout_age_days",
type: "number",
description:
"Maximum age of threads considered for memory generation. Defaults to 30 and is clamped to 0-90.",
},
{
key: "memories.max_rollouts_per_startup",
type: "number",
description:
"Maximum rollout candidates processed per startup pass. Defaults to 16 and is capped at 128.",
},
{
key: "memories.min_rollout_idle_hours",
type: "number",
description:
"Minimum idle time before a thread is considered for memory generation. Defaults to 6 and is clamped to 1-48.",
},
{
key: "memories.min_rate_limit_remaining_percent",
type: "number",
description:
"Minimum remaining percentage required in Codex rate-limit windows before memory generation starts. Defaults to 25 and is clamped to 0-100.",
},
{
key: "memories.extract_model",
type: "string",
description: "Optional model override for per-thread memory extraction.",
},
{
key: "memories.consolidation_model",
type: "string",
description: "Optional model override for global memory consolidation.",
},
{
key: "features.unified_exec",
type: "boolean",
description:
"Use the unified PTY-backed exec tool (stable; enabled by default except on Windows).",
},
{
key: "features.shell_snapshot",
type: "boolean",
description:
"Snapshot shell environment to speed up repeated commands (stable; on by default).",
},
{
key: "features.multi_agent",
type: "boolean",
description:
"Enable multi-agent collaboration tools (spawn_agent, send_input, resume_agent, wait_agent, and close_agent) (stable; on by default).",
},
{
key: "features.goals",
type: "boolean",
description:
"Enable persisted goals and automatic continuation (stable; on by default).",
},
{
key: "features.remote_plugin",
type: "boolean",
description: "Enable the remote plugin catalog (stable; on by default).",
},
{
key: "features.personality",
type: "boolean",
description:
"Enable personality selection controls (stable; on by default).",
},
{
key: "features.network_proxy",
type: "boolean | table",
description:
"Start the network proxy for sandboxed commands (experimental; off by default). Required to enforce permission-profile domain rules unless enabled administrator-managed experimental_network requirements start the proxy. Use a table when setting feature-level policy options such as domains. Does not filter web search, apps, MCP, or other hosted tools.",
},
{
key: "features.network_proxy.enabled",
type: "boolean",
description:
"Start the sandboxed-command network proxy when command network access is enabled. Defaults to false; permission-profile domain rules are not enforced while the proxy is off.",
},
{
key: "features.network_proxy.domains",
type: "map<string, allow | deny>",
description:
"Domain policy for sandboxed networking. Unset by default, which means no external destinations are allowed until you add allow rules. Supports exact hosts, *.example.com for subdomains only, **.example.com for apex plus subdomains, and global * allow rules; prefer scoped rules because * broadly opens public outbound access. Add deny rules for blocked destinations; deny wins on conflicts.",
},
{
key: "features.network_proxy.unix_sockets",
type: "map<string, allow | deny>",
description:
"Unix socket policy for sandboxed networking. Unset by default; add allow entries for permitted sockets.",
},
{
key: "features.network_proxy.allow_local_binding",
type: "boolean",
description:
"Allow broader local/private-network access. Defaults to false; exact local IP literal or localhost allow rules can still permit specific local targets.",
},
{
key: "features.network_proxy.enable_socks5",
type: "boolean",
description: "Expose SOCKS5 support. Defaults to true.",
},
{
key: "features.network_proxy.enable_socks5_udp",
type: "boolean",
description: "Allow UDP over SOCKS5. Defaults to true.",
},
{
key: "features.network_proxy.allow_upstream_proxy",
type: "boolean",
description:
"Allow chaining through an upstream proxy from the environment. Defaults to true.",
},
{
key: "features.network_proxy.dangerously_allow_non_loopback_proxy",
type: "boolean",
description:
"Permit non-loopback listener addresses. Defaults to false; enabling it can expose proxy listeners beyond localhost.",
},
{
key: "features.network_proxy.dangerously_allow_all_unix_sockets",
type: "boolean",
description:
"Permit arbitrary Unix socket destinations instead of allowlist-only access. Defaults to false; use only in tightly controlled environments.",
},
{
key: "features.network_proxy.proxy_url",
type: "string",
description:
'HTTP listener URL for sandboxed networking. Defaults to "http://127.0.0.1:3128".',
},
{
key: "features.network_proxy.socks_url",
type: "string",
description:
'SOCKS5 listener URL. Defaults to "http://127.0.0.1:8081".',
},
{
key: "features.web_search",
type: "boolean",
description:
"Deprecated legacy toggle; prefer the top-level web_search setting.",
},
{
key: "features.web_search_cached",
type: "boolean",
description:
'Deprecated legacy toggle. When web_search is unset, true maps to web_search = "cached".',
},
{
key: "features.web_search_request",
type: "boolean",
description:
'Deprecated legacy toggle. When web_search is unset, true maps to web_search = "live".',
},
{
key: "features.shell_tool",
type: "boolean",
description:
"Enable the default shell tool for running commands (stable; on by default).",
},
{
key: "features.enable_request_compression",
type: "boolean",
description:
"Compress streaming request bodies with zstd when supported (stable; on by default).",
},
{
key: "features.skill_mcp_dependency_install",
type: "boolean",
description:
"Allow prompting and installing missing MCP dependencies for skills (stable; on by default).",
},
{
key: "features.fast_mode",
type: "boolean",
description:
"Enable model-catalog service tier selection in the TUI, including Fast-tier commands when the active model advertises them (stable; on by default).",
},
{
key: "features.prevent_idle_sleep",
type: "boolean",
description:
"Prevent the machine from sleeping while a turn is actively running (experimental; off by default).",
},
{
key: "suppress_unstable_features_warning",
type: "boolean",
description:
"Suppress the warning that appears when under-development feature flags are enabled.",
},
{
key: "model_providers.",
type: "table",
description:
"Custom provider definition. Built-in provider IDs (openai, ollama, and lmstudio) are reserved and cannot be overridden.",
},
{
key: "model_providers..name",
type: "string",
description: "Display name for a custom model provider.",
},
{
key: "model_providers..base_url",
type: "string",
description: "API base URL for the model provider.",
},
{
key: "model_providers..env_key",
type: "string",
description: "Environment variable supplying the provider API key.",
},
{
key: "model_providers..env_key_instructions",
type: "string",
description: "Optional setup guidance for the provider API key.",
},
{
key: "model_providers..experimental_bearer_token",
type: "string",
description:
"Direct bearer token for the provider (discouraged; use env_key).",
},
{
key: "model_providers..requires_openai_auth",
type: "boolean",
description:
"The provider uses OpenAI authentication (defaults to false).",
},
{
key: "model_providers..wire_api",
type: "responses",
description:
"Protocol used by the provider. responses is the only supported value, and it is the default when omitted.",
},
{
key: "model_providers..query_params",
type: "map<string,string>",
description: "Extra query parameters appended to provider requests.",
},
{
key: "model_providers..http_headers",
type: "map<string,string>",
description: "Static HTTP headers added to provider requests.",
},
{
key: "model_providers..env_http_headers",
type: "map<string,string>",
description:
"HTTP headers populated from environment variables when present.",
},
{
key: "model_providers..request_max_retries",
type: "number",
description:
"Retry count for HTTP requests to the provider (default: 4).",
},
{
key: "model_providers..stream_max_retries",
type: "number",
description: "Retry count for SSE streaming interruptions (default: 5).",
},
{
key: "model_providers..stream_idle_timeout_ms",
type: "number",
description:
"Idle timeout for SSE streams in milliseconds (default: 300000).",
},
{
key: "model_providers..supports_websockets",
type: "boolean",
description:
"Whether that provider supports the Responses API WebSocket transport.",
},
{
key: "model_providers..supports_standalone_web_search",
type: "boolean",
description:
"Advertise support for a compatible standalone web search endpoint (default: false). Standalone search remains under development and off by default; provider compatibility alone doesn't enable it.",
},
{
key: "model_providers..auth",
type: "table",
description:
"Command-backed bearer token configuration for a custom provider. Do not combine with env_key, experimental_bearer_token, or requires_openai_auth.",
},
{
key: "model_providers..auth.command",
type: "string",
description:
"Command to run when Codex needs a bearer token. The command must print the token to stdout.",
},
{
key: "model_providers..auth.args",
type: "array",
description: "Arguments passed to the token command.",
},
{
key: "model_providers..auth.timeout_ms",
type: "number",
description:
"Maximum token command runtime in milliseconds (default: 5000).",
},
{
key: "model_providers..auth.refresh_interval_ms",
type: "number",
description:
"How often Codex proactively refreshes the token in milliseconds (default: 300000). Set to 0 to refresh only after an authentication retry.",
},
{
key: "model_providers..auth.cwd",
type: "string (path)",
description: "Working directory for the token command.",
},
{
key: "model_providers.amazon-bedrock.aws.profile",
type: "string",
description:
"AWS profile name used by the built-in amazon-bedrock provider.",
},
{
key: "model_providers.amazon-bedrock.aws.region",
type: "string",
description: "AWS region used by the built-in amazon-bedrock provider.",
},
{
key: "model_reasoning_effort",
type: "string",
description:
"Reasoning effort advertised by the selected model, such as low, medium, high, xhigh, max, or ultra. Available levels depend on the model and client.",
},
{
key: "plan_mode_reasoning_effort",
type: "string",
description:
"Plan-mode-specific reasoning override using a level supported by the selected model. When unset, Plan mode uses its built-in preset default.",
},
{
key: "model_reasoning_summary",
type: "auto | concise | detailed | none",
description:
"Select reasoning summary detail or disable summaries entirely.",
},
{
key: "model_verbosity",
type: "low | medium | high",
description:
"Optional GPT-5 Responses API verbosity override; when unset, the selected model/preset default is used.",
},
{
key: "model_supports_reasoning_summaries",
type: "boolean",
description: "Force Codex to send or not send reasoning metadata.",
},
{
key: "shell_environment_policy.inherit",
type: "all | core | none",
description:
"Baseline environment inheritance when spawning subprocesses.",
},
{
key: "shell_environment_policy.ignore_default_excludes",
type: "boolean",
description:
"Keep variables containing KEY, SECRET, or TOKEN before other filters run (default: true). Set to false to apply automatic secret-name exclusions.",
},
{
key: "shell_environment_policy.filters",
type: "map<string, include | exclude>",
description:
"Canonical case-insensitive environment-variable pattern filters. Include entries create an allowlist and can't restore excluded values. Explicit set values apply after exclusions. Don't combine filters with legacy exclude or include_only arrays in the same layer.",
},
{
key: "shell_environment_policy.exclude",
type: "array",
description:
"Legacy environment-variable exclusion patterns. Use shell_environment_policy.filters for new configuration; don't combine both forms in the same layer.",
},
{
key: "shell_environment_policy.include_only",
type: "array",
description:
"Legacy allowlist of environment-variable patterns. Use shell_environment_policy.filters for new configuration; don't combine both forms in the same layer.",
},
{
key: "shell_environment_policy.set",
type: "map<string,string>",
description:
"Explicit environment values injected after exclusions; include filters can still remove them.",
},
{
key: "shell_environment_policy.experimental_use_profile",
type: "boolean",
description: "Use the user shell profile when spawning subprocesses.",
},
{
key: "project_root_markers",
type: "array",
description:
"List of project root marker filenames; used when searching parent directories for the project root.",
},
{
key: "project_doc_max_bytes",
type: "number",
description:
"Maximum bytes read from AGENTS.md when building project instructions.",
},
{
key: "project_doc_fallback_filenames",
type: "array",
description: "Additional filenames to try when AGENTS.md is missing.",
},
{
key: "history.persistence",
type: "save-all | none",
description:
"Control whether Codex saves session transcripts to history.jsonl.",
},
{
key: "tool_output_token_limit",
type: "number",
description:
"Token budget for storing individual tool/function outputs in history.",
},
{
key: "background_terminal_max_timeout",
type: "number",
description:
"Maximum poll window in milliseconds for empty write_stdin polls (background terminal polling). Default: 300000 (5 minutes). Replaces the older background_terminal_timeout key.",
},
{
key: "history.max_bytes",
type: "number",
description:
"If set, caps the history file size in bytes by dropping oldest entries.",
},
{
key: "file_opener",
type: "vscode | vscode-insiders | windsurf | cursor | none",
description:
"URI scheme used to open citations from Codex output (default: vscode).",
},
{
key: "otel.environment",
type: "string",
description:
"Environment tag applied to emitted OpenTelemetry events (default: dev).",
},
{
key: "otel.exporter",
type: "none | otlp-http | otlp-grpc",
description:
"Select the OpenTelemetry exporter and provide any endpoint metadata.",
},
{
key: "otel.trace_exporter",
type: "none | otlp-http | otlp-grpc",
description:
"Select the OpenTelemetry trace exporter and provide any endpoint metadata.",
},
{
key: "otel.metrics_exporter",
type: "none | statsig | otlp-http | otlp-grpc",
description:
"Select the OpenTelemetry metrics exporter (defaults to statsig).",
},
{
key: "otel.log_user_prompt",
type: "boolean",
description:
"Opt in to exporting raw user prompts with OpenTelemetry logs.",
},
{
key: "otel.exporter..endpoint",
type: "string",
description: "Exporter endpoint for OTEL logs.",
},
{
key: "otel.exporter..protocol",
type: "binary | json",
description: "Protocol used by the OTLP/HTTP exporter.",
},
{
key: "otel.exporter..headers",
type: "map<string,string>",
description: "Static headers included with OTEL exporter requests.",
},
{
key: "otel.trace_exporter..endpoint",
type: "string",
description: "Trace exporter endpoint for OTEL logs.",
},
{
key: "otel.trace_exporter..protocol",
type: "binary | json",
description: "Protocol used by the OTLP/HTTP trace exporter.",
},
{
key: "otel.trace_exporter..headers",
type: "map<string,string>",
description: "Static headers included with OTEL trace exporter requests.",
},
{
key: "otel.exporter..tls.ca-certificate",
type: "string",
description: "CA certificate path for OTEL exporter TLS.",
},
{
key: "otel.exporter..tls.client-certificate",
type: "string",
description: "Client certificate path for OTEL exporter TLS.",
},
{
key: "otel.exporter..tls.client-private-key",
type: "string",
description: "Client private key path for OTEL exporter TLS.",
},
{
key: "otel.trace_exporter..tls.ca-certificate",
type: "string",
description: "CA certificate path for OTEL trace exporter TLS.",
},
{
key: "otel.trace_exporter..tls.client-certificate",
type: "string",
description: "Client certificate path for OTEL trace exporter TLS.",
},
{
key: "otel.trace_exporter..tls.client-private-key",
type: "string",
description: "Client private key path for OTEL trace exporter TLS.",
},
{
key: "desktop.custom_file_handlers.",
type: "table",
description:
"User-level only. Defines an additional Open in target for the ChatGPT desktop app. See Add custom file handlers for examples and handler ID constraints.",
},
{
key: "desktop.custom_file_handlers..label",
type: "string",
description: "Display name shown in Open in menus. Required.",
},
{
key: "desktop.custom_file_handlers..icon",
type: "string",
description:
"Bundled asset path, Base64-encoded data:image/... URL, file URI, or absolute local path for the handler icon. Required; unsupported sources use the default VS Code icon.",
},
{
key: "desktop.custom_file_handlers..command",
type: "string",
description:
"Executable path or command name to detect and launch. Required.",
},
{
key: "desktop.custom_file_handlers..args",
type: "array",
description:
"Arguments inserted between the command and file input (default: []).",
},
{
key: "desktop.custom_file_handlers..input",
type: "path | json_argument | json_stdin",
description:
"How the app sends file input to the handler (default: path).",
},
{
key: "desktop.custom_file_handlers..supports_ssh",
type: "boolean",
description:
"Offer the handler for files in SSH workspaces (default: false).",
},
{
key: "tui",
type: "table",
description:
"TUI-specific options such as enabling inline desktop notifications.",
},
{
key: "tui.notifications",
type: "boolean | array",
description:
"Enable TUI notifications; optionally restrict to specific event types.",
},
{
key: "tui.notification_method",
type: "auto | osc9 | bel",
description:
"Notification method for terminal notifications (default: auto).",
},
{
key: "tui.notification_condition",
type: "unfocused | always",
description:
"Control whether TUI notifications fire only when the terminal is unfocused or regardless of focus. Defaults to unfocused.",
},
{
key: "tui.animations",
type: "boolean",
description:
"Enable terminal animations (welcome screen, shimmer, spinner) (default: true).",
},
{
key: "tui.alternate_screen",
type: "auto | always | never",
description:
"Control alternate screen usage for the TUI (default: auto; auto skips it in Zellij to preserve scrollback).",
},
{
key: "tui.resume_cwd",
type: "current | session",
description:
"Working directory to use when resuming or forking a session. When unset, Codex asks you to choose if your current directory differs from the session's saved directory.",
},
{
key: "tui.vim_mode_default",
type: "boolean",
description:
"Start the composer in Vim normal mode instead of insert mode (default: false). You can still toggle it per session with /vim.",
},
{
key: "tui.raw_output_mode",
type: "boolean",
description:
"Start the TUI in raw scrollback mode for copy-friendly terminal selection (default: false). You can toggle it with /raw or the default alt-r key binding.",
},
{
key: "tui.show_tooltips",
type: "boolean",
description:
"Show onboarding tooltips in the TUI welcome screen (default: true).",
},
{
key: "tui.status_line",
type: "array | null",
description:
"Ordered list of TUI footer status-line item identifiers. null disables the status line.",
},
{
key: "tui.terminal_title",
type: "array | null",
description:
'Ordered list of terminal window/tab title item identifiers. Defaults to ["spinner", "project"]; null disables title updates.',
},
{
key: "tui.theme",
type: "string",
description:
"Syntax-highlighting theme override (kebab-case theme name).",
},
{
key: "tui.keymap..",
type: "string | array",
description:
"Keyboard shortcut binding for a TUI action. Supported contexts include global, chat, composer, editor, vim_normal, vim_operator, vim_text_object, pager, list, and approval. Selected composer actions fall back to matching tui.keymap.global bindings; context-specific bindings take precedence when supported.",
},
{
key: "tui.keymap.. = []",
type: "empty array",
description:
"Unbind the action in that keymap context. Key names use normalized strings such as ctrl-a, shift-enter, page-down, or minus.",
},
{
key: "marketplaces..source_type",
type: "git | local",
description:
"Source kind for a configured plugin marketplace. Marketplaces can be defined in system, cloud-managed, user, or trusted-project config.toml.",
},
{
key: "marketplaces..source",
type: "string",
description:
"Git repository location or local marketplace root directory. Use an absolute path for a local source; the directory contains .agents/plugins/marketplace.json.",
},
{
key: "marketplaces..ref",
type: "string",
description: "Optional Git branch, tag, or commit for the marketplace.",
},
{
key: "marketplaces..sparse_paths",
type: "array",
description:
"Optional sparse checkout paths for a Git marketplace. Include the marketplace catalog and any local plugin directories it references.",
},
{
key: "plugins..enabled",
type: "boolean",
description:
"Enable or disable a local-marketplace plugin using a plugin-name@marketplace-name key. Read from the effective merged config; trusted-project settings can override user, cloud-managed, and system defaults. Marketplace refresh can install or refresh configured plugins even when disabled. This does not override workspace-managed enabled states.",
},
{
key: "plugins..mcp_servers..enabled",
type: "boolean",
description:
"Enable or disable an MCP server bundled by an installed plugin without changing the plugin manifest.",
},
{
key: "plugins..mcp_servers..default_tools_approval_mode",
type: "auto | prompt | writes | approve",
description:
"Default approval behavior for tools on a plugin-provided MCP server.",
},
{
key: "plugins..mcp_servers..enabled_tools",
type: "array",
description:
"Allow list of tools exposed from a plugin-provided MCP server.",
},
{
key: "plugins..mcp_servers..disabled_tools",
type: "array",
description:
"Deny list applied after enabled_tools for a plugin-provided MCP server.",
},
{
key: "plugins..mcp_servers..tools..approval_mode",
type: "auto | prompt | writes | approve",
description:
"Per-tool approval behavior override for a plugin-provided MCP tool.",
},
{
key: "tui.model_availability_nux.",
type: "integer",
description: "Internal startup-tooltip state keyed by model slug.",
},
{
key: "hide_agent_reasoning",
type: "boolean",
description:
"Suppress reasoning events in both the TUI and codex exec output.",
},
{
key: "show_raw_agent_reasoning",
type: "boolean",
description:
"Surface raw reasoning content when the active model emits it.",
},
{
key: "disable_paste_burst",
type: "boolean",
description: "Disable burst-paste detection in the TUI.",
},
{
key: "windows_wsl_setup_acknowledged",
type: "boolean",
description: "Track Windows onboarding acknowledgement (Windows only).",
},
{
key: "chatgpt_base_url",
type: "string",
description: "Override the base URL used during the ChatGPT login flow.",
},
{
key: "cli_auth_credentials_store",
type: "file | keyring | auto | ephemeral",
description: "Control where the CLI stores cached credentials.",
},
{
key: "mcp_oauth_credentials_store",
type: "auto | file | keyring",
description: "Preferred store for MCP OAuth credentials.",
},
{
key: "mcp_oauth_callback_port",
type: "integer",
description:
"Optional global fixed port for the local HTTP callback server used during MCP OAuth login. A server-specific oauth.callback_port takes precedence. When neither is set, Codex binds to an ephemeral port chosen by the OS.",
},
{
key: "mcp_oauth_callback_url",
type: "string",
description:
"Optional base callback URL for MCP OAuth login, such as a devbox ingress URL. Newly added pre-registered clients use this URL unchanged when the authorization server supports issuer identification; existing clients without a saved callback append a server-specific callback ID. Without issuer support, any pre-registered MCP server whose configured callback lacks the required ID falls back to this URL with the ID appended. Callback URL ports don't select the listener port.",
},
{
key: "experimental_use_unified_exec_tool",
type: "boolean",
description:
"Legacy name for enabling unified exec; prefer [features].unified_exec or codex --enable unified_exec.",
},
{
key: "tools.web_search",
type: 'boolean | { context_size = "low|medium|high", allowed_domains = [string], location = { country, region, city, timezone } }',
description:
"Optional web search tool configuration. The object form can set search context size, allowed search domains, and approximate user location. These search-domain filters are separate from sandboxed-command network domain rules and do not restrict connectors or MCP servers.",
},
{
key: "tools.view_image",
type: "boolean",
description: "Enable the local-image attachment tool view_image.",
},
{
key: "web_search",
type: "disabled | cached | indexed | live",
description:
'Web search mode (default: "cached"; cached uses an OpenAI-maintained index without external web access; indexed permits external access only when gated by the search index; if you use --yolo or another full access sandbox setting, it defaults to "live"). Use "live" for unrestricted live retrieval, or "disabled" to remove the tool.',
},
{
key: "default_permissions",
type: "string",
description:
"Name of the default permissions profile to apply to sandboxed tool calls. Built-ins are :read-only, :workspace, and :danger-full-access; custom profile names require matching [permissions.<name>] tables. Don't combine with sandbox_mode or [sandbox_workspace_write].",
},
{
key: "permissions..description",
type: "string",
description:
"Human-readable description for this named profile. A profile does not inherit its parent's description through extends.",
},
{
key: "permissions..extends",
type: "string",
description:
"Optional parent profile applied before this named profile. Set it to another named profile, :read-only, or :workspace; :danger-full-access, undefined parents, and cycles are rejected.",
},
{
key: "permissions..workspace_roots",
type: "table",
description:
"Profile-defined workspace roots that receive :workspace_roots filesystem rules alongside the session's runtime workspace roots.",
},
{
key: "permissions..workspace_roots.",
type: "boolean",
description:
"Opt a path into the profile's workspace root set when true. Disabled entries remain inactive.",
},
{
key: "permissions..filesystem",
type: "table",
description:
"Named filesystem permission profile. Each key is an absolute path or special token such as :minimal or :workspace_roots.",
},
{
key: "permissions..filesystem.glob_scan_max_depth",
type: "number",
description:
"Maximum depth for expanding deny-read glob patterns on platforms that snapshot matches before sandbox startup. Must be at least 1 when set.",
},
{
key: "permissions..filesystem.",
type: '"read" | "write" | "deny" | table',
description:
'Grant direct access for a path, glob pattern, or special token, or scope nested entries under that root. Use "deny" to deny reads for matching paths.',
},
{
key: 'permissions..filesystem.":workspace_roots".',
type: '"read" | "write" | "deny"',
description:
'Scoped filesystem access relative to each effective workspace root. Use "." for the root itself; glob subpaths such as "**/*.env" can deny reads with "deny".',
},
{
key: "permissions..network.enabled",
type: "boolean",
description:
"Enable network access for commands in this permission profile. This does not start the network proxy. Without features.network_proxy or enabled administrator-managed networking requirements, command network access is direct and profile domain rules are not enforced.",
},
{
key: "permissions..network.proxy_url",
type: "string",
description:
"HTTP listener URL used when this permissions profile enables sandboxed networking.",
},
{
key: "permissions..network.enable_socks5",
type: "boolean",
description:
"Expose SOCKS5 support when this permissions profile enables sandboxed networking.",
},
{
key: "permissions..network.socks_url",
type: "string",
description: "SOCKS5 proxy endpoint used by this permissions profile.",
},
{
key: "permissions..network.enable_socks5_udp",
type: "boolean",
description: "Allow UDP over the SOCKS5 listener when enabled.",
},
{
key: "permissions..network.allow_upstream_proxy",
type: "boolean",
description:
"Allow sandboxed networking to chain through another upstream proxy.",
},
{
key: "permissions..network.dangerously_allow_non_loopback_proxy",
type: "boolean",
description:
"Permit non-loopback bind addresses for sandboxed networking listeners. Enabling it can expose listeners beyond localhost.",
},
{
key: "permissions..network.dangerously_allow_all_unix_sockets",
type: "boolean",
description:
"Allow arbitrary Unix socket destinations instead of the default restricted set. Use only in tightly controlled environments.",
},
{
key: "permissions..network.mode",
type: "limited | full",
description: "Network proxy mode used for subprocess traffic.",
},
{
key: "permissions..network.domains",
type: "table",
description:
"Domain rules for sandboxed commands. Enforced only when features.network_proxy or enabled administrator-managed networking requirements activate the proxy. Supports exact hosts, *.example.com, **.example.com, and global * allow rules; deny wins. Does not restrict web search, apps, or MCP servers.",
},
{
key: "permissions..network.domains.",
type: "allow | deny",
description:
"Allow or deny an exact host or scoped wildcard pattern such as *.example.com or **.example.com.",
},
{
key: "permissions..network.unix_sockets",
type: "table",
description:
"Unix socket allowlist overrides for sandboxed networking. Use socket paths as keys; allow adds a path, and deny rejects it.",
},
{
key: "permissions..network.unix_sockets.",
type: "allow | deny",
description:
"Add an absolute Unix socket path to the effective allowlist with allow, or reject it with deny. Denied entries are omitted from the effective allowlist.",
},
{
key: "permissions..network.allow_local_binding",
type: "boolean",
description:
"Permit broader local/private-network access through sandboxed networking. Exact local IP literal or localhost allow rules can still permit specific local targets when this stays false.",
},
{
key: "projects..trust_level",
type: "string",
description:
'Mark a project or worktree as trusted or untrusted ("trusted" | "untrusted"). Untrusted projects skip project-scoped .codex/ layers, including project-local config, hooks, and rules.',
},
{
key: "notice.hide_full_access_warning",
type: "boolean",
description: "Track acknowledgement of the full access warning prompt.",
},
{
key: "notice.hide_world_writable_warning",
type: "boolean",
description:
"Track acknowledgement of the Windows world-writable directories warning.",
},
{
key: "notice.hide_rate_limit_model_nudge",
type: "boolean",
description: "Track opt-out of the rate limit model switch reminder.",
},
{
key: "notice.hide_gpt5_1_migration_prompt",
type: "boolean",
description: "Track acknowledgement of the GPT-5.1 migration prompt.",
},
{
key: "notice.hide_gpt-5.1-codex-max_migration_prompt",
type: "boolean",
description:
"Track acknowledgement of the gpt-5.1-codex-max migration prompt.",
},
{
key: "notice.model_migrations",
type: "map<string,string>",
description: "Track acknowledged model migrations as old->new mappings.",
},
{
key: "forced_login_method",
type: "chatgpt | api",
description: "Restrict Codex to a specific authentication method.",
},
{
key: "forced_chatgpt_workspace_id",
type: "string (uuid)",
description: "Limit ChatGPT logins to a specific workspace identifier.",
},
]}
client:load
/>
You can find the latest JSON schema for config.toml here .
To get autocompletion and diagnostics when editing config.toml in VS Code or Cursor, you can install the Even Better TOML extension and add this line to the top of your config.toml:
#:schema https://developers.openai.com/codex/config-schema.json
Note: Rename experimental_instructions_file to model_instructions_file. Codex deprecates the old key; update existing configs to the new name.
requirements.tomlrequirements.toml is an admin-enforced configuration file that constrains security-sensitive settings users can't override. For details, locations, and examples, see Admin-enforced requirements .
For ChatGPT Business and Enterprise users, Codex can also apply cloud-fetched
requirements. See the security page for precedence details.
Use [features] in requirements.toml to pin runtime feature flags by the same
canonical keys that config.toml uses. Requirements can also include documented
app-only keys that don't belong in config.toml. Omitted keys remain
unconstrained.
Some managed requirements enforce an exact configuration value instead of an
allowlist. Users can't override an enforced path, update preference, login-shell
policy, feedback setting, or Windows private-desktop setting.
Managed permission-profile allowlists require Codex 0.138.0 or later. Codex
0.137.0 and earlier ignore allowed_permission_profiles and managed
default_permissions.
Use allowed_sandbox_modes with sandbox_mode. For permission-profile
deployments, use allowed_permission_profiles with managed
default_permissions.
An untrusted entry in allowed_approval_policies is still valid for the
stricter approval behavior Codex derives when a project uses
trust_level = "untrusted". It does not permit explicitly setting
approval_policy = "untrusted".
The [models.new_thread] table supplies managed defaults, not enforcement.
If you explicitly override the model or reasoning effort with --model,
--config, or --profile, Codex ignores both model and
model_reasoning_effort in [models.new_thread]. service_tier is independent.
The browser requirements cover three separate surfaces. in_app_browser
controls the browser pane that a person opens and uses directly. browser_use
controls agent-driven work in a browser. computer_use controls agent-driven
work in native desktop apps.
The nested Browser Use and Computer Use policy values do not grant access by
themselves. An origin- or app-specific allow can override the fallback for
the same policy source, but normal feature, approval, and other policy checks
still apply. Where managed requirements and config.toml both apply, a deny
from either one wins.
<ConfigTable
options={[
{
key: "sqlite_home",
type: "string (path)",
description:
"Enforce the directory where Codex stores SQLite-backed runtime state.",
},
{
key: "log_dir",
type: "string (path)",
description: "Enforce the directory where Codex writes local log files.",
},
{
key: "model_catalog_json",
type: "string (path)",
description: "Enforce the JSON model catalog Codex uses at startup.",
},
{
key: "check_for_update_on_startup",
type: "boolean",
description: "Enforce whether Codex checks for updates when it starts.",
},
{
key: "allow_login_shell",
type: "boolean",
description: "Enforce whether shell tools can start a login shell.",
},
{
key: "allowed_login_methods",
type: "array",
description:
"Allow chatgpt, api, or both. If omitted, this setting doesn't restrict login methods. If set, the list must contain at least one method. api permits API authentication, including Amazon Bedrock. Set through the local system requirements file or macOS MDM. Cloud-managed values are ignored.",
},
{
key: "allowed_chatgpt_workspaces",
type: "array",
description:
"Restrict ChatGPT login, including Codex access tokens, to the listed workspace IDs. An empty list disables ChatGPT login; API authentication remains available when permitted. Set through the local system requirements file or macOS MDM; cloud-managed values are ignored.",
},
{
key: "cli_auth_credentials_store",
type: "file | keyring | auto | ephemeral",
description:
"Enforce the CLI credential store before authentication loads. file uses CODEX_HOME/auth.json; keyring requires the OS credential store; auto falls back to a file if the credential store is unavailable; ephemeral keeps credentials in memory for the current process. Set through the local system requirements file or macOS MDM; cloud-managed values are ignored.",
},
{
key: "chatgpt_base_url",
type: "string",
description:
"Enforce the ChatGPT service base URL before authentication and cloud-policy retrieval. This doesn't configure every Codex network destination. Set through the local system requirements file or macOS MDM; cloud-managed values are ignored.",
},
{
key: "feedback",
type: "table",
description: "Managed feedback settings.",
},
{
key: "feedback.enabled",
type: "boolean",
description:
"Enforce whether users can submit feedback across Codex clients.",
},
{
key: "allowed_approval_policies",
type: "array",
description:
"Allowed approval policies, such as on-request, never, and granular. Include untrusted to permit the stricter policy derived from an untrusted project; it cannot be selected directly with approval_policy.",
},
{
key: "allowed_approvals_reviewers",
type: "array",
description:
"Allowed values for approvals_reviewer, such as user and auto_review.",
},
{
key: "guardian_policy_config",
type: "string",
description:
"Managed Markdown policy instructions for automatic review. This takes precedence over local [auto_review].policy. Blank values are ignored.",
},
{
key: "guardian_extra_policy",
type: "string",
description:
"Additional managed Markdown policy for automatic review, included alongside the main policy. This takes precedence over local [auto_review].extra_policy. Blank values are ignored.",
},
{
key: "additional_developer_instructions",
type: "string",
description:
"Managed developer instructions added as a separate developer message. Codex rejects instructions that exceed a limit of 10,000 estimated tokens, including context markers.",
},
{
key: "auto_review",
type: "table",
description: "Managed automatic-review requirements.",
},
{
key: "auto_review.required_on_models",
type: "array",
description:
"Model slugs that must use automatic review. Slugs must be non-empty, omit provider namespaces, and have no surrounding whitespace. Lists from multiple requirements sources are combined.",
},
{
key: "auto_review.ignore_rules",
type: "array",
description:
"Full model slugs for which Codex ignores allow prefix rules in command execution policy. Match the slug exactly, including its provider namespace when present; unlike required_on_models, this does not accept a namespace-free alias. Deny and network rules still apply.",
},
{
key: "allowed_permission_profiles",
type: "table",
description:
"Complete list of allowed permission profiles. Profiles set to true are allowed. Profiles that are omitted or set to false are denied, including profiles added in future versions. When requirements sources are combined, entries are matched by profile name.",
},
{
key: "allowed_permission_profiles.",
type: "boolean",
description:
"Allow or deny a built-in or custom permission profile defined in a loaded config or requirements source. A later, higher-precedence requirements source can use false to turn off a profile allowed by an earlier, lower-precedence source.",
},
{
key: "default_permissions",
type: "string",
description:
"Managed default permission profile. The profile must be allowed by allowed_permission_profiles. Set this explicitly for predictable behavior; if omitted, Codex defaults to :workspace only when both :workspace and :read-only are explicitly allowed.",
},
{
key: "enforce_residency",
type: "string",
description:
"Require Codex service traffic to use a supported data residency. Currently accepts us.",
},
{
key: "model_provider",
type: "string",
description:
"Enforce the model provider ID, overriding local and session configuration.",
},
{
key: "model_providers",
type: "map<string, table>",
description:
"Managed model provider definitions. Each entry replaces the complete configured provider with the same ID; fields aren't merged with the user's definition. Providers with other IDs remain available.",
},
{
key: "model_providers.",
type: "table",
description:
"Complete managed provider definition. Uses the same provider fields as config.toml, including name, base_url, authentication, and transport settings.",
},
{
key: "models",
type: "table",
description: "Contains the [models.new_thread] table.",
},
{
key: "models.new_thread",
type: "table",
description:
"Optional defaults to apply when a new local thread starts. They take priority over user and project defaults, but can be superseded by explicit overrides.",
},
{
key: "models.new_thread.model",
type: "string",
description:
"Default model for new threads. An explicit override of either the model or reasoning effort causes both fields to be ignored.",
},
{
key: "models.new_thread.model_reasoning_effort",
type: "string",
description:
"Default reasoning effort for new threads. An explicit override of either the model or reasoning effort causes both fields to be ignored.",
},
{
key: "models.new_thread.service_tier",
type: "string",
description:
"Default service tier for new threads. An explicit service-tier override causes this field to be ignored.",
},
{
key: "permissions",
type: "table",
description:
"Admin-defined permission profiles keyed by profile name. Uses the same profile fields as config.toml.",
},
{
key: "permissions.",
type: "table",
description:
"Admin-defined permission profile. The name can't start with :, use the reserved name filesystem, or duplicate a profile from a loaded config. Uses the same profile fields as config.toml; see the Permissions guide for the complete profile schema.",
},
{
key: "allowed_sandbox_modes",
type: "array",
description: "Allowed values for sandbox_mode.",
},
{
key: "windows",
type: "table",
description: "Native Windows sandbox requirements.",
},
{
key: "windows.allowed_sandbox_implementations",
type: "array",
description:
"Allowed legacy native Windows sandbox implementations (elevated and unelevated). The list must not be empty. When both are allowed and no mode is selected, Codex prefers elevated. This list does not restrict the mxc sandbox when it is available.",
},
{
key: "remote_sandbox_config",
type: "array",
description:
"Host-specific sandbox requirements. The first entry whose hostname_patterns match the resolved host name overrides top-level allowed_sandbox_modes for that requirements source. Host-specific entries currently override sandbox modes only.",
},
{
key: "remote_sandbox_config[].hostname_patterns",
type: "array",
description:
"Case-insensitive host name patterns. Supports * for any sequence of characters and ? for one character.",
},
{
key: "remote_sandbox_config[].allowed_sandbox_modes",
type: "array",
description:
"Allowed sandbox modes to apply when this host-specific entry matches.",
},
{
key: "allowed_web_search_modes",
type: "array",
description:
"Allowed values for web_search (disabled, cached, indexed, live). disabled is always allowed; an empty list effectively allows only disabled.",
},
{
key: "allow_managed_hooks_only",
type: "boolean",
description:
"When true, Codex skips user, project, session, and plugin hooks while still allowing managed hooks from requirements.toml and other managed config layers.",
},
{
key: "allow_appshots",
type: "boolean",
description:
"Set to false to disable Appshots for managed users. If omitted, Appshots remain unconstrained by requirements and follow normal product availability.",
},
{
key: "allow_remote_control",
type: "boolean",
description:
"Set to false to disable device remote control for managed users. If omitted, device remote control remains unconstrained by requirements and follows normal product availability.",
},
{
key: "allow_browser_and_computer_use",
type: "boolean",
description:
"Set to false to block both agent-driven Browser Use and native-app Computer Use. Setting it to true or omitting it does not enable either feature; the remaining feature, policy, and approval checks still apply.",
},
{
key: "features.plugin_sharing",
type: "boolean",
description:
"Set to false in cloud-managed requirements.toml to disable workspace sharing for locally built plugins.",
},
{
key: "features",
type: "table",
description:
"Pinned feature values. Use canonical names from config.toml for runtime features; documented app-only requirement keys are also supported here.",
},
{
key: "features.",
type: "boolean",
description:
"Require a documented runtime or app feature to stay enabled or disabled.",
},
{
key: "features.apps",
type: "boolean",
description:
"Pin Apps integration availability on or off for managed users.",
},
{
key: "features.in_app_updates",
type: "boolean",
description:
"Set to false in requirements.toml to disable in-app updates. Updates remain enabled by default when this requirement is omitted.",
},
{
key: "features.in_app_browser",
type: "boolean",
description:
"Set to false in requirements.toml to disable the built-in browser pane that users open and control directly.",
},
{
key: "features.in_app_chat",
type: "boolean",
description:
"Set to false to hide ChatGPT and ChatGPT Work conversation screens and related cloud automation UI in the ChatGPT desktop app. This setting does not block ChatGPT Voice or stop existing cloud tasks. Setting it to true does not bypass account, workspace-permission, or rollout checks.",
},
{
key: "features.in_app_dictation",
type: "boolean",
description:
"Set to false to disable in-app dictation in the desktop app. Setting it to true does not bypass other availability checks.",
},
{
key: "features.in_app_local_automation",
type: "boolean",
description:
"Set to false to disable local scheduled tasks in the desktop app. Setting it to true does not bypass other availability checks.",
},
{
key: "features.browser_use",
type: "boolean",
description:
"Set to false in requirements.toml to disable agent-driven Browser Use.",
},
{
key: "features.browser_use_external",
type: "boolean",
description:
"Set to false in requirements.toml to prevent Codex from operating supported browsers through the ChatGPT browser extension, including existing tabs and signed-in sessions.",
},
{
key: "features.browser_use_full_cdp_access",
type: "boolean",
description:
"Set to false in requirements.toml to disable full Chrome DevTools Protocol access in the local runtime, including Browser Developer mode, and prevent the ChatGPT desktop app from enabling the corresponding setting. If omitted, normal product availability applies.",
},
{
key: "features.fast_mode",
type: "boolean",
description:
"Pin the canonical fast_mode feature on or off for managed users.",
},
{
key: "features.guardian_approval",
type: "boolean",
description:
"Pin Guardian approval availability on or off for managed users.",
},
{
key: "features.memories",
type: "boolean",
description: "Pin Memories availability on or off for managed users.",
},
{
key: "features.multi_agent",
type: "boolean",
description: "Pin multi-agent availability on or off for managed users.",
},
{
key: "features.plugins",
type: "boolean",
description: "Pin plugin availability on or off for managed users.",
},
{
key: "features.remote_plugin",
type: "boolean",
description:
"Pin remote plugin catalog availability on or off for managed users.",
},
{
key: "features.realtime_conversation",
type: "boolean",
description:
"Set to false to disable the experimental /voice command in the Codex CLI. Do not rely on this setting to block ChatGPT Voice in the desktop app or app-server voice sessions. Setting it to true does not bypass client or rollout checks.",
},
{
key: "features.computer_use",
type: "boolean",
description:
"Set to false in requirements.toml to disable Computer Use, Record & Replay, and related install or enablement flows.",
},
{
key: "features.workspace_dependencies",
type: "boolean",
description:
"Pin bundled workspace-dependency runtime availability on or off for managed users.",
},
{
key: "in_app_browser",
type: "table",
description:
"Requirements for the built-in browser pane. These settings do not control agent-driven Browser Use.",
},
{
key: "in_app_browser.allow_external_browser_settings_import",
type: "boolean",
description:
"Set to false to prevent users from importing settings or browsing data from an external browser into the built-in browser. Setting it to true or omitting it leaves the import available when other product checks allow it. This is a managed-only setting with no config.toml override.",
},
{
key: "browser_use",
type: "table",
description: "Managed requirements for agent-driven Browser Use.",
},
{
key: "browser_use.allow_history_access",
type: "boolean",
description:
"Set to false to prevent Browser Use from reading browser history. Setting it to true or omitting it leaves normal history settings and availability checks in place.",
},
{
key: "browser_use.disable_auto_review",
type: "boolean",
description:
"Set to true to skip automatic review for Browser Use and ask the user for approval instead. Setting it to false or omitting it leaves automatic review available when other settings allow it.",
},
{
key: "browser_use.allow_global_persistent_approval",
type: "boolean",
description:
"Set to false to prevent Browser Use from creating or honoring Always allow approvals that cover every site, such as allowing downloads from any site. Existing saved approvals are ignored, not deleted. Setting it to true or omitting it does not create an approval.",
},
{
key: "browser_use.default_origin_policy",
type: "table",
description:
"Fallback for each Browser Use setting when no matching entry under browser_use.origins defines it. A matching origin rule replaces the fallback for that source. Codex then applies the stricter result from managed requirements and user configuration.",
},
{
key: "browser_use.default_origin_policy.access",
type: "allow | deny",
description:
"Use deny to block Browser Use on origins that use the fallback. A denied origin also blocks uploads, downloads, full browser debugging access, and automatic review there. allow only lets normal approval and policy checks continue.",
},
{
key: "browser_use.default_origin_policy.downloads",
type: "allow | deny",
description:
"Use deny to block Browser Use downloads on origins that use the fallback. allow only lets normal approval and policy checks continue.",
},
{
key: "browser_use.default_origin_policy.uploads",
type: "allow | deny",
description:
"Use deny to block Browser Use uploads on origins that use the fallback. allow only lets normal approval and policy checks continue.",
},
{
key: "browser_use.default_origin_policy.full_cdp_access",
type: "allow | deny",
description:
"Use deny to block full Chrome DevTools Protocol (CDP) access on origins that use the fallback. allow only lets normal opt-in and approval checks continue.",
},
{
key: "browser_use.default_origin_policy.auto_review",
type: "allow | deny",
description:
"Use deny to skip automatic review on origins that use the fallback and ask the user for approval instead. allow leaves automatic review available when other settings allow it.",
},
{
key: "browser_use.default_origin_policy.persistent_approval",
type: "boolean",
description:
"Set to false to prevent Browser Use from saving or honoring an Always allow approval on origins that use the fallback. Approvals for the current turn or thread can still apply. true makes Always allow available when otherwise permitted but does not create an approval.",
},
{
key: "browser_use.default_origin_policy.access_approval_lifetime",
type: "turn | thread",
description:
"Set how long a non-persistent site-access approval lasts: turn limits it to the current turn, and thread keeps it for the rest of the current thread. persistent_approval separately controls whether Always allow is available. The product default is thread.",
},
{
key: "browser_use.origins",
type: "map<string, table>",
description:
'Origin-specific Browser Use policies. Keys use <scheme>://<host-pattern>[:<port>] with http or https. Use an exact host, *.example.com for subdomains only, or **.example.com for the base domain and its subdomains. Other * wildcards can span dots, so region*.example.com also matches region.api.example.com; a host of * matches every host for that scheme. Schemes and nondefault ports are significant; explicit default ports are normalized away. Paths, queries, embedded usernames or passwords, and wildcard schemes or ports are invalid. Quote the pattern in TOML, for example [browser_use.origins."https://**.example.com"].',
},
{
key: "browser_use.origins.",
type: "table",
description:
"Policy for origins matching this pattern. If several patterns match, Codex uses the most restrictive value for each capability: deny over allow, false over true, and turn over thread.",
},
{
key: "browser_use.origins..access",
type: "allow | deny",
description:
"Use deny to block Browser Use on matching origins. Denial also blocks uploads, downloads, full browser debugging access, and automatic review there. allow only lets normal approval and policy checks continue.",
},
{
key: "browser_use.origins..downloads",
type: "allow | deny",
description:
"Use deny to block Browser Use downloads on matching origins. allow only lets normal approval and policy checks continue.",
},
{
key: "browser_use.origins..uploads",
type: "allow | deny",
description:
"Use deny to block Browser Use uploads on matching origins. allow only lets normal approval and policy checks continue.",
},
{
key: "browser_use.origins..full_cdp_access",
type: "allow | deny",
description:
"Use deny to block full Chrome DevTools Protocol (CDP) access on matching origins. allow only lets normal opt-in and approval checks continue.",
},
{
key: "browser_use.origins..auto_review",
type: "allow | deny",
description:
"Use deny to skip automatic review on matching origins and ask the user for approval instead. allow leaves automatic review available when other settings allow it.",
},
{
key: "browser_use.origins..persistent_approval",
type: "boolean",
description:
"Set to false to prevent Browser Use from saving or honoring an Always allow approval on matching origins. Approvals for the current turn or thread can still apply. true makes Always allow available when otherwise permitted but does not create an approval.",
},
{
key: "browser_use.origins..access_approval_lifetime",
type: "turn | thread",
description:
"Set how long a non-persistent site-access approval for matching origins lasts: turn limits it to the current turn, and thread keeps it for the rest of the current thread. persistent_approval separately controls whether Always allow is available.",
},
{
key: "computer_use",
type: "table",
description:
"Managed requirements for agent-driven work in native desktop apps. Managed app rules and config.toml app rules are both enforced; an app must be allowed by each policy source.",
},
{
key: "computer_use.allow_locked_computer_use",
type: "boolean",
description:
"Set to false to prevent users from enabling Locked Use on a managed macOS device. This requirement removes the enablement controls; it does not turn off Locked Use if it is already enabled. If omitted, normal product availability applies.",
},
{
key: "computer_use.allow_persistent_approval",
type: "boolean",
description:
"Set to false to remove the option to save app approvals across sessions. Approvals for the current session remain available. Setting it to true or omitting it does not approve an app.",
},
{
key: "computer_use.default_app_access",
type: "allow | deny",
description:
"Fallback access for native apps that do not match a platform-specific rule. deny blocks access. allow only lets normal approval and policy checks continue. The product default is allow.",
},
{
key: "computer_use.macos",
type: "table",
description: "Computer Use app rules for macOS.",
},
{
key: "computer_use.macos.bundle_ids",
type: "map<string, allow | deny>",
description:
"Map exact macOS bundle identifiers to allow or deny. A matching rule replaces computer_use.default_app_access within the same policy source. A deny from either managed requirements or user configuration still blocks access.",
},
{
key: "computer_use.macos.bundle_ids.",
type: "allow | deny",
description:
"Use deny to block the exact bundle identifier. allow overrides only this policy source's default and still requires any other policy source and the normal approval flow to allow the app.",
},
{
key: "computer_use.windows",
type: "table",
description:
"Computer Use app rules for packaged and unpackaged Windows apps.",
},
{
key: "computer_use.windows.aumids",
type: "map<string, allow | deny>",
description:
"Map exact, registered Application User Model IDs (AUMIDs) for signed packaged apps to allow or deny. A matching rule replaces computer_use.default_app_access within the same policy source.",
},
{
key: "computer_use.windows.aumids.",
type: "allow | deny",
description:
"Use deny to block the exact packaged-app identity. allow overrides only this policy source's default and still requires any other policy source and the normal approval flow to allow the app.",
},
{
key: "computer_use.windows.exes",
type: "array",
description:
"Rules for signed, unpackaged Windows executables. Rules match the executable's verified publisher and signed version information, not its path or current file name. A matching deny takes precedence over matching allows. Unsigned executables use computer_use.default_app_access; executables whose signed identity cannot be verified unambiguously are blocked.",
},
{
key: "computer_use.windows.exes[].publisher_name",
type: "string",
description:
"Required exact publisher name from the executable's trusted signing certificate, formatted as a Windows X.500 distinguished name.",
},
{
key: "computer_use.windows.exes[].product_name",
type: "string",
description:
"Required exact ProductName from the executable's signed version information.",
},
{
key: "computer_use.windows.exes[].binary_name",
type: "string",
description:
"Optional OriginalFilename from the executable's signed version information. Matching is case-insensitive. If a matching publisher and product rule requires this value but the executable does not provide it, Computer Use blocks the executable.",
},
{
key: "computer_use.windows.exes[].access",
type: "allow | deny",
description:
"Required access decision for matching executables. deny blocks access. allow overrides only this policy source's default and still requires any other policy source and the normal approval flow to allow the app.",
},
{
key: "experimental_network",
type: "table",
description:
"Administrator-managed network requirements for sandboxed local commands, enforced from requirements.toml. When enabled, these requirements can start the command network proxy without features.network_proxy. Browser tools separately check managed network denies and exclusive allowlists. These requirements do not route browser traffic through the proxy or control web search, apps, MCP servers, native-app traffic, or Codex cloud networking.",
},
{
key: "experimental_network.enabled",
type: "boolean",
description:
"Enable sandboxed networking requirements. This does not grant network access when the active sandbox keeps command networking off.",
},
{
key: "experimental_network.http_port",
type: "integer",
description:
"Loopback HTTP listener port to use for [experimental_network] requirements.",
},
{
key: "experimental_network.socks_port",
type: "integer",
description:
"Loopback SOCKS5 listener port to use for [experimental_network] requirements.",
},
{
key: "experimental_network.allow_upstream_proxy",
type: "boolean",
description:
"Allow sandboxed networking to chain through an upstream proxy from the environment.",
},
{
key: "experimental_network.dangerously_allow_non_loopback_proxy",
type: "boolean",
description:
"Permit non-loopback listener addresses for [experimental_network] requirements. Enabling it can expose listeners beyond localhost.",
},
{
key: "experimental_network.dangerously_allow_all_unix_sockets",
type: "boolean",
description:
"Permit arbitrary Unix socket destinations instead of allowlist-only access. Use only in tightly controlled environments.",
},
{
key: "experimental_network.domains",
type: "map<string, allow | deny>",
description:
"Map-shaped administrator domain policy for sandboxed networking. Supports exact hosts, *.example.com for subdomains only, **.example.com for apex plus subdomains, and global * allow rules; prefer scoped rules because * broadly opens public outbound access. deny wins on conflicts. Do not combine this with experimental_network.allowed_domains or experimental_network.denied_domains.",
},
{
key: "experimental_network.domains.",
type: "allow | deny",
description:
"Allow or deny sandboxed network access for the matching domain pattern. A deny rule wins when several patterns match.",
},
{
key: "experimental_network.allowed_domains",
type: "array",
description:
"Administrator allow rules for sandboxed-command networking while the managed network proxy is enabled. These rules do not apply to web search, apps, or MCP servers. Do not combine this with experimental_network.domains.",
},
{
key: "experimental_network.denied_domains",
type: "array",
description:
"List-shaped administrator deny rules for sandboxed networking. Do not combine this with experimental_network.domains.",
},
{
key: "experimental_network.managed_allowed_domains_only",
type: "boolean",
description:
"When true, only administrator-managed allow rules remain effective while sandboxed networking requirements are active; user allowlist additions are ignored. Without managed allow rules, user-added domain allow rules do not remain effective.",
},
{
key: "experimental_network.unix_sockets",
type: "map<string, allow | deny>",
description:
"Administrator-managed Unix socket allowlist for sandboxed networking on macOS. Paths must be absolute.",
},
{
key: "experimental_network.unix_sockets.",
type: "allow | deny",
description:
"On macOS, allow adds an absolute Unix socket path to the allowlist; deny leaves it out. A deny entry cannot block a socket when allow-all Unix sockets is enabled.",
},
{
key: "experimental_network.allow_local_binding",
type: "boolean",
description:
"Permit broader local/private-network access for sandboxed networking. Exact local IP literal or localhost allow rules can still permit specific local targets when this stays false.",
},
{
key: "hooks",
type: "table",
description:
"Admin-enforced managed lifecycle hooks. Requires a managed hook directory and uses the same event schema as inline [hooks] in config.toml.",
},
{
key: "hooks.managed_dir",
type: "string (absolute path)",
description:
"Directory containing managed hook scripts on macOS and Linux. Codex validates that it is absolute and exists before loading managed hooks.",
},
{
key: "hooks.windows_managed_dir",
type: "string (absolute path)",
description:
"Directory containing managed hook scripts on Windows. Codex validates that it is absolute and exists before loading managed hooks.",
},
{
key: "hooks.",
type: "array",
description:
"Matcher groups for a hook event such as PreToolUse, PermissionRequest, PostToolUse, PreCompact, PostCompact, SessionStart, SessionEnd, SubagentStart, SubagentStop, UserPromptSubmit, or Stop.",
},
{
key: "hooks.[].hooks",
type: "array",
description:
"Hook handlers for a matcher group. Command and MCP tool hooks are supported while prompt and agent hook handlers are parsed but skipped.",
},
{
key: "hooks.[].hooks[].async",
type: "boolean",
description:
"Run a command hook in the background without delaying the triggering operation. Defaults to false; SessionEnd always runs synchronously. See Run hooks in the background .",
},
{
key: "hooks.[].hooks[].additionalContextLimit",
type: "integer",
description:
"Approximate per-handler token threshold for saving oversized additionalContext to disk and showing the model a shorter preview. Defaults to 2500; 0 passes the full context directly to the model. See Large hook output .",
},
{
key: "hooks.[].hooks[].commandWindows",
type: "string",
description:
"Windows-only command override for command hooks. The TOML alias command_windows is also accepted.",
},
{
key: "permissions.filesystem.deny_read",
type: "array",
description:
"Admin-enforced filesystem read denials. Entries can be paths or glob patterns, and users cannot weaken them with local config.",
},
{
key: "mcp_servers",
type: "table",
description:
"Allowlist of MCP servers that may be enabled. Both the server name (<id>) and its identity must match for the MCP server to be enabled. Any configured MCP server not in the allowlist (or with a mismatched identity) is disabled.",
},
{
key: "mcp_servers..identity",
type: "table",
description:
"Identity rule for a single MCP server. Set either command (stdio) or url (streamable HTTP).",
},
{
key: "mcp_servers..identity.command",
type: "string | table",
description:
"Allow an MCP stdio server by exact command string, or use a matcher table to require an exact executable and ordered argument matchers. The string form doesn't inspect arguments, cwd, env, or env_vars.",
},
{
key: "mcp_servers..identity.command.executable",
type: "string",
description:
"Executable that the stdio server's configured command must match exactly.",
},
{
key: "mcp_servers..identity.command.args",
type: "array",
description:
"Ordered argument matchers for a stdio server. The configured argument list must have the same length, and every position must match. Command matchers don't inspect cwd, env, or env_vars.",
},
{
key: "mcp_servers..identity.command.args[].match",
type: "exact | prefix | regex",
description: "Match operation for this argument position.",
},
{
key: "mcp_servers..identity.command.args[].value",
type: "string",
description: "Value used by an exact or prefix argument matcher.",
},
{
key: "mcp_servers..identity.command.args[].expression",
type: "string",
description:
"Regular expression used by a regex argument matcher. The expression must be valid and match the complete argument value.",
},
{
key: "mcp_servers..identity.url",
type: "string | table",
description:
"Allow an MCP streamable HTTP server by exact URL string, or use an exact, prefix, or regex value matcher table.",
},
{
key: "mcp_servers..identity.url.match",
type: "exact | prefix | regex",
description: "Match operation for the configured MCP server URL.",
},
{
key: "mcp_servers..identity.url.value",
type: "string",
description: "Value used by an exact or prefix URL matcher.",
},
{
key: "mcp_servers..identity.url.expression",
type: "string",
description:
"Regular expression used by a regex URL matcher. The expression must be valid and match the complete URL value.",
},
{
key: "plugins",
type: "table",
description:
"Plugin-specific MCP server allowlists keyed by plugin identifier. When this table is present, plugin-bundled servers without a matching plugin and server entry are disabled.",
},
{
key: "plugins..mcp_servers",
type: "table",
description:
"Allowlist for MCP servers bundled with one plugin. Plugin server requirements use the same exact identity and matcher forms as top-level mcp_servers requirements.",
},
{
key: "plugins..mcp_servers..identity",
type: "table",
description:
"Identity rule for one plugin-bundled MCP server. Set either command (stdio) or url (streamable HTTP).",
},
{
key: "plugins..mcp_servers..identity.command",
type: "string | table",
description:
"Allow a plugin's stdio MCP server by exact command string, or use a matcher table to require an exact executable and ordered argument matchers.",
},
{
key: "plugins..mcp_servers..identity.command.executable",
type: "string",
description:
"Executable that the plugin-bundled stdio server's configured command must match exactly.",
},
{
key: "plugins..mcp_servers..identity.command.args",
type: "array",
description:
"Ordered argument matchers for a plugin-bundled stdio server. The configured argument list must have the same length, and every position must match.",
},
{
key: "plugins..mcp_servers..identity.command.args[].match",
type: "exact | prefix | regex",
description: "Match operation for this argument position.",
},
{
key: "plugins..mcp_servers..identity.command.args[].value",
type: "string",
description: "Value used by an exact or prefix argument matcher.",
},
{
key: "plugins..mcp_servers..identity.command.args[].expression",
type: "string",
description:
"Regular expression used by a regex argument matcher. The expression must match the complete argument value.",
},
{
key: "plugins..mcp_servers..identity.url",
type: "string | table",
description:
"Allow a plugin's streamable HTTP MCP server by exact URL string, or use an exact, prefix, or regex value matcher table.",
},
{
key: "plugins..mcp_servers..identity.url.match",
type: "exact | prefix | regex",
description: "Match operation for the plugin-bundled MCP server URL.",
},
{
key: "plugins..mcp_servers..identity.url.value",
type: "string",
description: "Value used by an exact or prefix URL matcher.",
},
{
key: "plugins..mcp_servers..identity.url.expression",
type: "string",
description:
"Regular expression used by a regex URL matcher. The expression must match the complete URL value.",
},
{
key: "marketplaces",
type: "table",
description:
"Admin requirements for plugin marketplace sources. Rules take effect when restrict_to_allowed_sources is true.",
},
{
key: "marketplaces.restrict_to_allowed_sources",
type: "boolean",
description:
"When true, require configured marketplace sources to match allowed_sources for marketplace add, plugin install, refresh, and runtime loading. OpenAI-curated Git catalogs, including the API-key catalog, must also match the allowlist. Bundled and remotely installed workspace plugins are separate from this curated Git source policy.",
},
{
key: "marketplaces.allowed_sources",
type: "table",
description:
"Allowed marketplace sources keyed by administrator-chosen rule name. Distinct names accumulate across requirements layers; fields under the same name use normal layer precedence.",
},
{
key: "marketplaces.allowed_sources.",
type: "table",
description:
"One allowed source rule. The final source value after requirements merge determines which sibling fields Codex interprets.",
},
{
key: "marketplaces.allowed_sources..source",
type: "git | host_pattern | local",
description:
"Marketplace source matcher type. Use git for one repository, host_pattern for Git hosts matched by regular expression, or local for one directory.",
},
{
key: "marketplaces.allowed_sources..url",
type: "string",
description:
'Git repository URL required when
