frontmatter

Config

Settings ~/.codex/config.toml Vendor docs

config

name type required meaning concept
agents object docs ↗
allow_login_shell boolean docs ↗
analytics object docs ↗
approval_policy object docs ↗
approvals_reviewer object docs ↗
apps object docs ↗
apps_mcp_product_sku string docs ↗
audio object docs ↗
auto_review object docs ↗
background_terminal_max_timeout number docs ↗
chatgpt_base_url string docs ↗
check_for_update_on_startup boolean docs ↗
cli_auth_credentials_store object docs ↗
compact_prompt string docs ↗
debug object docs ↗
default_permissions string docs ↗
desktop object docs ↗
developer_instructions string docs ↗
disable_paste_burst boolean docs ↗
experimental_compact_prompt_file object docs ↗
experimental_realtime_start_instructions string docs ↗
experimental_realtime_webrtc_call_base_url string docs ↗
experimental_realtime_ws_backend_prompt string docs ↗
experimental_realtime_ws_base_url string docs ↗
experimental_realtime_ws_model string docs ↗
experimental_realtime_ws_startup_context string docs ↗
experimental_thread_config_endpoint string docs ↗
experimental_thread_store object docs ↗
experimental_use_unified_exec_tool boolean docs ↗
features object docs ↗
feedback object docs ↗
file_opener object docs ↗
forced_chatgpt_workspace_id object docs ↗
forced_login_method object docs ↗
ghost_snapshot object docs ↗
hide_agent_reasoning boolean docs ↗
history object docs ↗
hooks object docs ↗
include_apps_instructions boolean docs ↗
include_collaboration_mode_instructions boolean docs ↗
include_environment_context boolean docs ↗
include_permissions_instructions boolean docs ↗
instructions string docs ↗
log_dir object docs ↗
marketplaces object docs ↗
mcp_oauth_callback_port number docs ↗
mcp_oauth_callback_url string docs ↗
mcp_oauth_credentials_store object docs ↗
mcp_servers object docs ↗
memories object docs ↗
model string docs ↗
model_auto_compact_token_limit number docs ↗
model_auto_compact_token_limit_scope object docs ↗
model_catalog_json object docs ↗
model_context_window number docs ↗
model_instructions_file object docs ↗
model_provider string docs ↗
model_providers object docs ↗
model_reasoning_effort object docs ↗
model_reasoning_summary object docs ↗
model_supports_reasoning_summaries boolean docs ↗
model_verbosity object docs ↗
notice object docs ↗
notify array docs ↗
openai_base_url string docs ↗
orchestrator object docs ↗
oss_provider string docs ↗
otel object docs ↗
permissions object docs ↗
personality object docs ↗
plan_mode_reasoning_effort object docs ↗
plugins object docs ↗
profile string docs ↗
profiles object docs ↗
project_doc_fallback_filenames array docs ↗
project_doc_max_bytes number docs ↗
project_root_markers array docs ↗
projects object docs ↗
realtime object docs ↗
review_model string docs ↗
sandbox_mode object docs ↗
sandbox_workspace_write object docs ↗
service_tier string docs ↗
shell_environment_policy object docs ↗
show_raw_agent_reasoning boolean docs ↗
skills object docs ↗
sqlite_home object docs ↗
suppress_unstable_features_warning boolean docs ↗
tool_output_token_limit number docs ↗
tool_suggest object docs ↗
tools object docs ↗
tui object docs ↗
web_search object docs ↗
windows object docs ↗