config-sample.md +42 −6
27# Core Model Selection27# Core Model Selection
28################################################################################28################################################################################
29 29
3030# Primary model used by Codex. Recommended example for most users: "gpt-5.4".# Primary model used by Codex. Recommended example for most users: "gpt-5.5".
3131model = "gpt-5.4"model = "gpt-5.5"
32 32
33# Communication style for supported models. Allowed values: none | friendly | pragmatic33# Communication style for supported models. Allowed values: none | friendly | pragmatic
34# personality = "pragmatic"34# personality = "pragmatic"
35 35
36# Optional model override for /review. Default: unset (uses current session model).36# Optional model override for /review. Default: unset (uses current session model).
3737# review_model = "gpt-5.4"# review_model = "gpt-5.5"
38 38
39# Provider id selected from [model_providers]. Default: "openai".39# Provider id selected from [model_providers]. Default: "openai".
40model_provider = "openai"40model_provider = "openai"
109# - never: never prompt (risky)109# - never: never prompt (risky)
110# - { granular = { ... } }: allow or auto-reject selected prompt categories110# - { granular = { ... } }: allow or auto-reject selected prompt categories
111approval_policy = "on-request"111approval_policy = "on-request"
112112# Who reviews eligible approval prompts: user (default) | guardian_subagent# Who reviews eligible approval prompts: user (default) | auto_review
113# approvals_reviewer = "user"113# approvals_reviewer = "user"
114 114
115# Example granular policy:115# Example granular policy:
133# Named permissions profile to apply by default. Required before using [permissions.<name>].133# Named permissions profile to apply by default. Required before using [permissions.<name>].
134# default_permissions = "workspace"134# default_permissions = "workspace"
135 135
136# Example filesystem profile. Use `"none"` to deny reads for exact paths or
137# glob patterns. On platforms that need pre-expanded glob matches, set
138# glob_scan_max_depth when using unbounded patterns such as `**`.
139# [permissions.workspace.filesystem]
140# glob_scan_max_depth = 3
141# ":project_roots" = { "." = "write", "**/*.env" = "none" }
142# "/absolute/path/to/secrets" = "none"
143
136################################################################################144################################################################################
137# Authentication & Login145# Authentication & Login
138################################################################################146################################################################################
323# Notification mechanism for terminal alerts: auto | osc9 | bel. Default: "auto"331# Notification mechanism for terminal alerts: auto | osc9 | bel. Default: "auto"
324# notification_method = "auto"332# notification_method = "auto"
325 333
334# When notifications fire: unfocused (default) | always
335# notification_condition = "unfocused"
336
326# Enables welcome/status/spinner animations. Default: true337# Enables welcome/status/spinner animations. Default: true
327animations = true338animations = true
328 339
382# multi_agent = true393# multi_agent = true
383# personality = true394# personality = true
384# fast_mode = true395# fast_mode = true
385# smart_approvals = false
386# enable_request_compression = true396# enable_request_compression = true
387# skill_mcp_dependency_install = true397# skill_mcp_dependency_install = true
388# prevent_idle_sleep = false398# prevent_idle_sleep = false
389 399
400################################################################################
401# Memories (table)
402################################################################################
403
404# Enable memories with [features].memories, then tune memory behavior here.
405# [memories]
406# generate_memories = true
407# use_memories = true
408# disable_on_external_context = false # legacy alias: no_memories_if_mcp_or_web_search
409
410################################################################################
411# Lifecycle hooks can be configured here inline or in a sibling hooks.json.
412################################################################################
413
414# [hooks]
415# [[hooks.PreToolUse]]
416# matcher = "^Bash$"
417#
418# [[hooks.PreToolUse.hooks]]
419# type = "command"
420# command = 'python3 "/absolute/path/to/pre_tool_use_policy.py"'
421# timeout = 30
422# statusMessage = "Checking Bash command"
423
390################################################################################424################################################################################
391# Define MCP servers under this table. Leave empty to disable.425# Define MCP servers under this table. Leave empty to disable.
392################################################################################426################################################################################
400# command = "docs-server" # required434# command = "docs-server" # required
401# args = ["--port", "4000"] # optional435# args = ["--port", "4000"] # optional
402# env = { "API_KEY" = "value" } # optional key/value pairs copied as-is436# env = { "API_KEY" = "value" } # optional key/value pairs copied as-is
403437# env_vars = ["ANOTHER_SECRET"] # optional: forward these from the parent env# env_vars = ["ANOTHER_SECRET"] # optional: forward local parent env vars
438# env_vars = ["LOCAL_TOKEN", { name = "REMOTE_TOKEN", source = "remote" }]
404# cwd = "/path/to/server" # optional working directory override439# cwd = "/path/to/server" # optional working directory override
440# experimental_environment = "remote" # experimental: run stdio via a remote executor
405# startup_timeout_sec = 10.0 # optional; default 10.0 seconds441# startup_timeout_sec = 10.0 # optional; default 10.0 seconds
406# # startup_timeout_ms = 10000 # optional alias for startup timeout (milliseconds)442# # startup_timeout_ms = 10000 # optional alias for startup timeout (milliseconds)
407# tool_timeout_sec = 60.0 # optional; default 60.0 seconds443# tool_timeout_sec = 60.0 # optional; default 60.0 seconds