設定參考
設定參考
Codex config.toml 和 requirements.toml 的完整參考
將此頁面用作 Codex 設定檔的可搜尋參考。如需概念指導和範例,請先參閱設定基礎和高階設定。
config.toml
使用者級設定位於 ~/.codex/config.toml。你還可以在 .codex/config.toml 檔案中新增專案範圍的覆蓋設定。只有當你信任專案時,Codex 才會載入專案範圍的設定檔。
專案範圍的設定不能覆蓋計算機本機的供應商、身份驗證、
宿主應用擁有的請求後設資料、通知、設定檔選擇或
遙測路由鍵。當 openai_base_url、
chatgpt_base_url、apps_mcp_product_sku、model_provider、
model_providers、notify、profile、profiles、
experimental_realtime_ws_base_url 和 otel 出現在專案本機的
.codex/config.toml 中時,Codex 會忽略它們;請改為將供應商、通知和遙測
鍵放在使用者級設定中。設定檔案檔案以
$CODEX_HOME/profile-name.config.toml 的形式與 config.toml 位於同一位置;使用
--profile profile-name 選擇一個檔案。
對於沙盒和審批鍵(approval_policy、sandbox_mode 和 sandbox_workspace_write.*),請將本參考與沙盒和審批、可寫根目錄中的受保護路徑及網路存取配合使用。有關測試版權限檔案,請參閱權限。
Codex 和 ChatGPT Work 不再支援 approval_policy = "untrusted"。
請移除該設定,或選擇受支援的策略。專案條目中設定的
trust_level = "untrusted" 在使用者級 ~/.codex/config.toml 中仍受支援。請參閱
從已停用的 untrusted 審批策略遷移,
瞭解範例及審批方式的權衡。
| 鍵 | 類型 / 值 | 詳細資訊 |
|---|---|---|
agents |
table |
多智能體設定和自定義角色宣告。標量設定名稱為保留名稱,不能用作自定義角色名。 |
agents.<name>.config_file |
string (path) |
該角色的 TOML 設定層路徑;相對路徑以宣告該角色的設定檔所在目錄為基準解析。 |
agents.<name>.description |
string |
Codex 選擇並建立該類型智能體時顯示的角色指引。 |
agents.default_subagent_model |
string |
新建立智能體的預設模型。建立時顯式指定的模型優先。 |
agents.default_subagent_reasoning_effort |
string |
新建立智能體的預設推理強度。建立時顯式指定的推理強度優先。 |
agents.enabled |
boolean |
啟用或停用多智能體工具(預設值:true)。 |
agents.interrupt_message |
boolean |
智能體輪次被中斷時,記錄一條模型可見的訊息(預設值:true)。 |
agents.max_concurrent_threads_per_session |
number |
可同時保持開啟的已建立智能體執行緒數上限,不包括主執行緒。未設定時,由 Codex 選擇預設值。 |
agents.max_threads |
number |
agents.max_concurrent_threads_per_session 的舊版別名。 |
allow_login_shell |
boolean |
允許基於 shell 的工具使用登入 shell 語義。預設值為 true;為 false 時,login = true 請求會被拒絕,省略 login 時預設使用非登入 shell。 |
analytics.enabled |
boolean |
為此計算機或設定檔啟用或停用分析。未設定時使用客戶端預設值。 |
approval_policy |
on-request | never | { granular = { sandbox_approval = bool, rules = bool, mcp_elicitations = bool, request_permissions = bool, skill_approval = bool } } |
控制 Codex 何時在執行命令前暫停以請求審批。也可以使用 approval_policy = { granular = { ... } } 允許特定類別的提示或自動拒絕這些提示,同時保留其他提示的互動。untrusted 不受支援,on-failure 已棄用;互動式執行請使用 on-request,非互動式執行請使用 never。 |
approval_policy.granular.mcp_elicitations |
boolean |
為 true 時,允許顯示 MCP 資訊徵詢提示,而非自動拒絕。 |
approval_policy.granular.request_permissions |
boolean |
為 true 時,允許顯示來自 request_permissions 工具的提示。 |
approval_policy.granular.rules |
boolean |
為 true 時,允許顯示由 execpolicy prompt 規則觸發的審批提示。 |
approval_policy.granular.sandbox_approval |
boolean |
為 true 時,允許顯示沙箱權限提升審批提示。 |
approval_policy.granular.skill_approval |
boolean |
為 true 時,允許顯示技能指令碼審批提示。 |
approvals_reviewer |
user | auto_review |
指定在 on-request 或細粒度審批策略下,由誰稽核符合條件的審批提示。預設值為 user;auto_review 使用稽核子智能體。此設定不會改變沙箱機制,也不會稽核沙箱內已獲准的操作。 |
apps._default.approvals_reviewer |
user | auto_review |
應用工具審批提示的預設稽核者,可由各應用單獨覆蓋。省略時,應用繼承頂層 approvals_reviewer 值。 |
apps._default.default_tools_approval_mode |
auto | prompt | writes | approve |
未按應用或工具單獨覆蓋時,應用工具的預設審批行為。 |
apps._default.destructive_enabled |
boolean |
具有 destructive_hint = true 的應用工具的預設允許或拒絕設定。 |
apps._default.enabled |
boolean |
所有應用的預設啟用狀態,可由各應用單獨覆蓋。 |
apps._default.open_world_enabled |
boolean |
具有 open_world_hint = true 的應用工具的預設允許或拒絕設定。 |
apps.<id>.approvals_reviewer |
user | auto_review |
此應用工具審批提示的稽核者。覆蓋 apps._default.approvals_reviewer。 |
apps.<id>.default_tools_approval_mode |
auto | prompt | writes | approve |
此應用中工具的預設審批行為,可由各工具單獨覆蓋。 |
apps.<id>.default_tools_enabled |
boolean |
此應用中工具的預設啟用狀態,可由各工具單獨覆蓋。 |
apps.<id>.destructive_enabled |
boolean |
允許或阻止此應用中宣告具有 destructive_hint = true 的工具。 |
apps.<id>.enabled |
boolean |
按 ID 啟用或停用特定應用或連接器(預設值:true)。 |
apps.<id>.open_world_enabled |
boolean |
允許或阻止此應用中宣告具有 open_world_hint = true 的工具。 |
apps.<id>.tools.<tool>.approval_mode |
auto | prompt | writes | approve |
單個應用工具的審批行為覆蓋設定。 |
apps.<id>.tools.<tool>.enabled |
boolean |
單個應用工具的啟用狀態覆蓋設定(例如 repos/list)。 |
auto_review.policy |
string |
用於自動稽核的本機 Markdown 策略指令。受管的 guardian_policy_config 優先。空白值會被忽略。 |
background_terminal_max_timeout |
number |
空 write_stdin 輪詢(後臺終端輪詢)的最長輪詢視窗,以毫秒為單位。預設值:300000(5 分鐘)。替代舊版 background_terminal_timeout 鍵。 |
browser_use.allow_history_access |
boolean |
設為 false 可限制瀏覽器歷史記錄存取。受管要求可以強制實施此限制。 |
browser_use.default_origin_policy |
table |
瀏覽器來源的回退限制。支援 access、uploads、downloads 和 full_cdp_access,每項均可設為 allow 或 deny。 |
browser_use.origins.<origin> |
table |
按來源設定的瀏覽器限制,欄位與 browser_use.default_origin_policy 相同。需包含 HTTP 或 HTTPS 協議方案以及可選埠;省略路徑、查詢參數和片段。本機值不能放寬受管的拒絕規則。 |
chatgpt_base_url |
string |
覆蓋 ChatGPT 登入流程中使用的基礎 URL。 |
check_for_update_on_startup |
boolean |
啟動時檢查 Codex 更新(僅在統一管理更新時設為 false)。 |
cli_auth_credentials_store |
file | keyring | auto | ephemeral |
控制 CLI 儲存快取憑據的位置。 |
compact_prompt |
string |
歷史記錄壓縮提示詞的內聯覆蓋設定。 |
computer_use.default_app_access |
allow | deny |
Computer Use 的原生應用存取回退策略。應用專屬條目可以提供策略;本機設定不能放寬受管限制。 |
computer_use.macos.bundle_ids |
map<string, allow | deny> |
以 bundle 識別符為鍵的原生 macOS 應用存取權限。 |
computer_use.windows.always_allowed_app_ids |
array<string> |
Computer Use 無需提示即可開啟的 Windows 應用識別符。不在列表中的應用需要審批;可在 ChatGPT 桌面應用的 Computer Use 設定中移除已儲存的條目。 |
computer_use.windows.aumids |
map<string, allow | deny> |
以應用程式使用者模型 ID(AUMID)為鍵的打包 Windows 應用存取權限。 |
computer_use.windows.exes |
array<table> |
Windows 執行檔存取規則。每條規則都需要 publisher_name、product_name 和 access(allow 或 deny);binary_name 為可選項。 |
default_permissions |
string |
應用於沙箱工具呼叫的預設權限設定檔名稱。內建檔案為 :read-only、:workspace 和 :danger-full-access;自定義檔案名稱需要匹配的 [permissions.<name>] 表。不要與 sandbox_mode 或 [sandbox_workspace_write] 組合使用。 |
desktop.custom_file_handlers.<id> |
table |
僅限使用者級設定。為 ChatGPT 桌面應用定義額外的開啟方式 目標。範例和處理程序 ID 限制請參閱新增自定義檔案處理程序。 |
desktop.custom_file_handlers.<id>.args |
array<string> |
插入命令與檔案輸入之間的參數(預設值:[])。 |
desktop.custom_file_handlers.<id>.command |
string |
要檢測並啟動的執行檔路徑或命令名稱。必填。 |
desktop.custom_file_handlers.<id>.icon |
string |
處理程序圖示的捆綁資源路徑、Base64 編碼的 data:image/... URL、檔案 URI 或本機絕對路徑。必填;不支援的來源將使用預設 VS Code 圖示。 |
desktop.custom_file_handlers.<id>.input |
path | json_argument | json_stdin |
應用向處理程序傳送檔案輸入的方式(預設值:path)。 |
desktop.custom_file_handlers.<id>.label |
string |
開啟方式 選單中顯示的名稱。必填。 |
desktop.custom_file_handlers.<id>.supports_ssh |
boolean |
為 SSH 工作區中的檔案提供此處理程序(預設值:false)。 |
developer_instructions |
string |
注入會話的額外開發者指令(可選)。 |
disable_paste_burst |
boolean |
停用 TUI 中的突發貼上檢測。 |
experimental_compact_prompt_file |
string (path) |
從檔案載入壓縮提示詞覆蓋設定(實驗性)。 |
experimental_use_unified_exec_tool |
boolean |
啟用統一 exec 的舊版名稱;請優先使用 [features].unified_exec 或 codex --enable unified_exec。 |
features.apps |
boolean |
啟用應用(連接器)整合(穩定功能;預設開啟)。應用和連接器流量不受沙箱命令網路代理及其域名允許列表控制。 |
features.code_mode.direct_only_tool_namespaces |
array<string> |
程式碼模式只能通過直接工具呼叫使用的工具名稱空間。 |
features.code_mode.enabled |
boolean |
啟用程式碼模式功能設定。此功能仍在開發中,預設關閉。 |
features.code_mode.excluded_tool_namespaces |
array<string> |
程式碼模式從巢狀程式碼模式工具指引和執行器暴露範圍中排除的工具名稱空間。 |
features.context_management.experimental_mode |
boolean |
啟用實驗性上下文管理(預設關閉)。它使用筆記和可搜尋的歷史記錄保留累積的細節,而不是反覆將上下文壓縮為單份摘要。需要使用 Plus、Pro 或 Pro Lite 帳戶登入 ChatGPT。 |
features.enable_request_compression |
boolean |
在支援時使用 zstd 壓縮流式請求體(穩定功能;預設開啟)。 |
features.fast_mode |
boolean |
在 TUI 中啟用模型目錄的服務層級選擇,包括當前模型宣告支援時的 Fast 層級命令(穩定功能;預設開啟)。 |
features.goals |
boolean |
啟用持久化目標和自動繼續(穩定功能;預設開啟)。 |
features.hooks |
boolean |
啟用從 hooks.json 或內聯 [hooks] 設定載入的生命週期鉤子。features.codex_hooks 是已棄用的別名。 |
features.memories |
boolean |
啟用記憶(預設關閉)。 |
features.multi_agent |
boolean |
啟用多智能體協作工具(spawn_agent、send_input、resume_agent、wait_agent 和 close_agent)(穩定功能;預設開啟)。 |
features.network_proxy |
boolean | table |
啟動沙箱命令的網路代理(實驗性;預設關閉)。要強制實施權限設定檔中的域名規則,必須啟用此項,除非已啟用的管理員受管 experimental_network 要求會啟動代理。設定 domains 等功能級策略選項時,請使用表。不篩選網頁搜尋、應用、MCP 或其他託管工具的流量。 |
features.network_proxy.allow_local_binding |
boolean |
允許更廣泛的本機或私有網路存取。預設值為 false;精確的本機 IP 字面量或 localhost 允許規則仍可放行特定本機目標。 |
features.network_proxy.allow_upstream_proxy |
boolean |
允許通過環境中設定的上游代理進行鏈式連線。預設值為 true。 |
features.network_proxy.dangerously_allow_all_unix_sockets |
boolean |
允許存取任意 Unix 套接字目標,而非僅限允許列表。預設值為 false;僅在嚴格受控的環境中使用。 |
features.network_proxy.dangerously_allow_non_loopback_proxy |
boolean |
允許非迴環監聽地址。預設值為 false;啟用後可能使 localhost 之外的主機也能存取代理監聽器。 |
features.network_proxy.domains |
map<string, allow | deny> |
沙箱網路的域名策略。預設未設定,即在新增 allow 規則之前,不允許存取任何外部目標。支援精確主機名、僅匹配子域名的 *.example.com、匹配頂級域及子域名的 **.example.com,以及全域 * 允許規則;請優先使用限定範圍的規則,因為 * 會廣泛開放公共網路出站存取。為需要阻止的目標新增 deny 規則;衝突時 deny 優先。 |
features.network_proxy.enable_socks5 |
boolean |
提供 SOCKS5 支援。預設值為 true。 |
features.network_proxy.enable_socks5_udp |
boolean |
允許通過 SOCKS5 傳輸 UDP。預設值為 true。 |
features.network_proxy.enabled |
boolean |
啟用命令網路存取時,啟動沙箱命令網路代理。預設值為 false;代理關閉時,不會強制實施權限設定檔中的域名規則。 |
features.network_proxy.proxy_url |
string |
沙箱網路的 HTTP 監聽 URL。預設值為 "http://127.0.0.1:3128"。 |
features.network_proxy.socks_url |
string |
SOCKS5 監聽 URL。預設值為 "http://127.0.0.1:8081"。 |
features.network_proxy.unix_sockets |
map<string, allow | deny> |
沙箱網路的 Unix 套接字策略。預設未設定;為允許使用的套接字新增 allow 條目。 |
features.personality |
boolean |
啟用個性選擇控制項(穩定功能;預設開啟)。 |
features.prevent_idle_sleep |
boolean |
在輪次正在執行時阻止計算機進入睡眠(實驗性;預設關閉)。 |
features.remote_plugin |
boolean |
啟用遠端外掛目錄(穩定功能;預設開啟)。 |
features.rollout_budget.enabled |
boolean |
啟用執行預算跟蹤。此功能仍在開發中,預設關閉。啟用時必須設定 features.rollout_budget.limit_tokens。 |
features.rollout_budget.limit_tokens |
integer |
執行預算跟蹤的 token 上限,必須為正數。啟用執行預算時必填。 |
features.rollout_budget.prefill_token_weight |
number |
執行預算核算中預填充 token 的乘數,必須為有限非負數。預設值為 1.0。 |
features.rollout_budget.reminder_interval_tokens |
integer |
執行預算提醒之間的 token 間隔,必須為正數。預設為 limit_tokens 的 10%,最少為 1 個 token。 |
features.rollout_budget.sampling_token_weight |
number |
執行預算核算中取樣 token 的乘數,必須為有限非負數。預設值為 1.0。 |
features.shell_snapshot |
boolean |
為 shell 環境建立快照,以加快重複命令的執行(穩定功能;預設開啟)。 |
features.shell_tool |
boolean |
啟用用於執行命令的預設 shell 工具(穩定功能;預設開啟)。 |
features.skill_mcp_dependency_install |
boolean |
允許提示並安裝技能缺失的 MCP 依賴項(穩定功能;預設開啟)。 |
features.unified_exec |
boolean |
使用基於 PTY 的統一 exec 工具(穩定功能;除 Windows 外預設啟用)。 |
features.web_search |
boolean |
已棄用的舊版開關;請優先使用頂層 web_search 設定。 |
features.web_search_cached |
boolean |
已棄用的舊版開關。未設定 web_search 時,true 對映為 web_search = "cached"。 |
features.web_search_request |
boolean |
已棄用的舊版開關。未設定 web_search 時,true 對映為 web_search = "live"。 |
feedback.enabled |
boolean |
允許各本機客戶端通過 /feedback 提交回饋(預設值:true)。 |
file_opener |
vscode | vscode-insiders | windsurf | cursor | none |
用於開啟 Codex 輸出中引用的 URI 方案(預設值:vscode)。 |
forced_chatgpt_workspace_id |
string (uuid) |
將 ChatGPT 登入限制為特定工作區識別符。 |
forced_login_method |
chatgpt | api |
限制 Codex 只能使用特定身份驗證方式。 |
hide_agent_reasoning |
boolean |
在 TUI 和 codex exec 輸出中隱藏推理事件。 |
history.max_bytes |
number |
設定後,通過丟棄最舊條目來限制歷史記錄檔案的位元組大小。 |
history.persistence |
save-all | none |
控制 Codex 是否將會話記錄儲存到 history.jsonl。 |
hooks |
table |
在 config.toml 中內聯設定的生命週期鉤子。使用與 hooks.json 相同的事件結構;範例和支援的事件請參閱鉤子指南。 |
hooks.<Event> |
array<table> |
鉤子事件的匹配器組,事件包括 PreToolUse、PermissionRequest、PostToolUse、PreCompact、PostCompact、SessionStart、SessionEnd、SubagentStart、SubagentStop、UserPromptSubmit、Stop 或 Interrupt。 |
hooks.<Event>[].hooks |
array<table> |
匹配器組的鉤子處理程序。支援命令鉤子和 MCP 工具鉤子;提示詞和智能體鉤子處理程序會被解析,但會跳過執行。 |
hooks.<Event>[].hooks[].additionalContextLimit |
integer |
每個處理程序的近似 token 閾值,超過此閾值的 additionalContext 會儲存到磁碟,並向模型展示較短的預覽。預設值為 2500;0 會將完整上下文直接傳遞給模型。請參閱大型鉤子輸出。 |
hooks.<Event>[].hooks[].async |
boolean |
在後臺執行命令鉤子,不延遲觸發它的操作。預設值為 false;SessionEnd 始終同步執行。請參閱在後臺執行鉤子。 |
hooks.<Event>[].hooks[].commandWindows |
string |
僅適用於 Windows 的命令鉤子命令覆蓋設定。也接受 TOML 別名 command_windows。 |
instructions |
string |
保留供將來使用;請優先使用 model_instructions_file 或 AGENTS.md。 |
log_dir |
string (path) |
Codex 寫入日誌檔案的目錄;預設值為 $CODEX_HOME/log。顯式設定此項還會在該目錄中啟用需主動開啟的純文本 TUI 日誌 codex-tui.log。 |
marketplaces.<name>.ref |
string |
市場的可選 Git 分支、標籤或提交。 |
marketplaces.<name>.source |
string |
Git 儲存庫位置或本機市場根目錄。本機來源請使用絕對路徑;該目錄包含 .agents/plugins/marketplace.json。 |
marketplaces.<name>.source_type |
git | local |
已設定外掛市場的來源類型。可在系統、雲端受管、使用者或受信任專案的 config.toml 中定義市場。 |
marketplaces.<name>.sparse_paths |
array<string> |
Git 市場的可選稀疏檢出路徑。應包含市場目錄檔案及其引用的所有本機外掛目錄。 |
mcp_oauth_callback_port |
integer |
MCP OAuth 登入期間本機 HTTP 回撥伺服器使用的可選全域固定埠。伺服器專屬的 oauth.callback_port 優先。兩者均未設定時,Codex 會繫結到作業系統選擇的臨時埠。 |
mcp_oauth_callback_url |
string |
MCP OAuth 登入的可選基礎回撥 URL,例如開發機入口 URL。授權伺服器支援頒發者識別時,新新增的預註冊客戶端會原樣使用此 URL;未儲存回撥的現有客戶端會附加伺服器專屬回撥 ID。不支援頒發者識別時,如果預註冊 MCP 伺服器設定的回撥缺少必需的 ID,則會回退到此 URL 並附加該 ID。回撥 URL 中的埠不會決定監聽埠。 |
mcp_oauth_credentials_store |
auto | file | keyring |
MCP OAuth 憑據的首選儲存位置。 |
mcp_optional_startup_grace_ms |
integer (milliseconds) |
建置初始工具目錄時,可選 MCP 伺服器共用的等待時間。預設值為 1000。設為 0 則改為按各伺服器的 startup_timeout_sec 等待。 |
mcp_servers.<id>.args |
array<string> |
傳遞給 MCP stdio 伺服器命令的參數。 |
mcp_servers.<id>.auth |
oauth | chatgpt |
在已設定的 bearer 令牌和授權請求頭之後,MCP HTTP 伺服器使用的身份驗證回退方式。oauth(預設值)在有可用憑據時使用已儲存的 MCP OAuth 憑據。chatgpt 對受信任的第一方 ChatGPT 來源使用當前 ChatGPT 會話,然後回退到已儲存的 OAuth 憑據。如果所有憑據來源均未能提供憑據,兩種模式都可以在不進行身份驗證的情況下連線。 |
mcp_servers.<id>.bearer_token_env_var |
string |
為 MCP HTTP 伺服器提供 bearer 令牌的環境變數。 |
mcp_servers.<id>.command |
string |
MCP stdio 伺服器的啟動命令。 |
mcp_servers.<id>.cwd |
string |
MCP stdio 伺服器程序的工作目錄。 |
mcp_servers.<id>.default_tools_approval_mode |
auto | prompt | writes | approve |
此伺服器上 MCP 工具的預設審批行為,可由各工具單獨覆蓋。 |
mcp_servers.<id>.disabled_tools |
array<string> |
在 enabled_tools 之後應用於 MCP 伺服器的拒絕列表。 |
mcp_servers.<id>.enabled |
boolean |
停用 MCP 伺服器而不移除其設定。 |
mcp_servers.<id>.enabled_tools |
array<string> |
MCP 伺服器公開的工具名稱允許列表。 |
mcp_servers.<id>.env |
map<string,string> |
轉發給 MCP stdio 伺服器的環境變數。 |
mcp_servers.<id>.env_http_headers |
map<string,string> |
為 MCP HTTP 伺服器從環境變數填充的 HTTP 請求頭。 |
mcp_servers.<id>.env_vars |
array<string | { name = string, source = "local" | "remote" }> |
為 MCP stdio 伺服器加入允許列表的額外環境變數。字串條目預設為 source = "local";僅在由執行器支援的遠端 stdio 中使用 source = "remote"。 |
mcp_servers.<id>.experimental_environment |
local | remote |
MCP 伺服器的實驗性執行位置設定。remote 通過遠端執行器環境啟動 stdio 伺服器;尚未實現流式 HTTP 的遠端執行位置支援。 |
mcp_servers.<id>.http_headers |
map<string,string> |
每個 MCP HTTP 請求中包含的靜態 HTTP 請求頭。 |
mcp_servers.<id>.http_headers_helper |
string (command) |
輸出 HTTP 請求頭名稱和值組成的 JSON 物件的本機命令。僅支援本機連線的 HTTP MCP 伺服器。顯式 bearer 令牌和 OAuth 憑據優先於輔助程式提供的 Authorization 請求頭。 |
mcp_servers.<id>.oauth_resource |
string |
MCP 登入期間包含的可選 RFC 8707 OAuth 資源參數。 |
mcp_servers.<id>.oauth.callback_port |
integer |
此 MCP 伺服器固定的 OAuth 回撥監聽埠。覆蓋 mcp_oauth_callback_port。對於 URL 中顯式指定埠的直接回環回撥,請設定相同的監聽埠。 |
mcp_servers.<id>.oauth.callback_url |
string |
伺服器專屬的 OAuth 回撥。支援頒發者識別或 URL 已以伺服器專屬回撥 ID 結尾時,預註冊客戶端會複用此回撥。否則,Codex 會使用全域或預設回撥並附加該 ID。沒有預註冊 ID 的客戶端會在客戶端註冊期間使用此回撥。 |
mcp_servers.<id>.oauth.client_id |
string |
預註冊的 OAuth 客戶端 ID,用於與此 MCP 伺服器進行授權和令牌交換。 |
mcp_servers.<id>.required |
boolean |
為 true 時,如果此已啟用的 MCP 伺服器無法初始化,則啟動或恢復失敗。 |
mcp_servers.<id>.scopes |
array<string> |
向該 MCP 伺服器進行身份驗證時請求的 OAuth 作用域。 |
mcp_servers.<id>.startup_timeout_ms |
number |
startup_timeout_sec 的別名,以毫秒為單位。 |
mcp_servers.<id>.startup_timeout_sec |
number |
覆蓋 MCP 伺服器預設的 10 秒啟動超時時間。 |
mcp_servers.<id>.tool_timeout_sec |
number |
覆蓋 MCP 伺服器預設的 60 秒單次工具呼叫超時時間。 |
mcp_servers.<id>.tools.<tool>.approval_mode |
auto | prompt | writes | approve |
此伺服器上單個 MCP 工具的審批行為覆蓋設定。 |
mcp_servers.<id>.tools.<tool>.output_token_limit |
integer (positive) |
單個 MCP 工具輸出的 token 預算,不含標準的 20% 序列化餘量。覆蓋模型對此工具的預設輸出截斷預算。 |
mcp_servers.<id>.url |
string |
MCP 流式 HTTP 伺服器的端點。 |
memories.consolidation_model |
string |
用於全域記憶整合的可選模型覆蓋設定。 |
memories.disable_on_external_context |
boolean |
為 true 時,使用 MCP 工具呼叫、網頁搜尋或工具搜尋等外部上下文的執行緒不會參與記憶生成。預設值為 false。舊版別名:memories.no_memories_if_mcp_or_web_search。 |
memories.extract_model |
string |
用於各執行緒記憶提取的可選模型覆蓋設定。 |
memories.generate_memories |
boolean |
為 false 時,新建立的執行緒不會被儲存為記憶生成輸入。預設值為 true。 |
memories.max_raw_memories_for_consolidation |
number |
為全域整合保留的近期原始記憶數上限。預設值為 256,上限為 4096。 |
memories.max_rollout_age_days |
number |
納入記憶生成的執行緒的最大存續天數。預設值為 30,限制在 0-90 範圍內。 |
memories.max_rollouts_per_startup |
number |
每輪啟動處理的候選執行記錄數上限。預設值為 16,上限為 128。 |
memories.max_unused_days |
number |
記憶自上次使用後仍可參與整合的最長天數。預設值為 30,限制在 0-365 範圍內。 |
memories.min_rate_limit_remaining_percent |
number |
開始生成記憶前,Codex 速率限制視窗中所需的最低剩餘額度百分比。預設值為 25,限制在 0-100 範圍內。 |
memories.min_rollout_idle_hours |
number |
執行緒被納入記憶生成前所需的最短空閒時間。預設值為 6,限制在 1-48 範圍內。 |
memories.use_memories |
boolean |
為 false 時,Codex 不再向後續會話注入現有記憶。預設值為 true。 |
model |
string |
要使用的模型(例如 gpt-5.6-sol)。 |
model_auto_compact_token_limit |
number |
觸發歷史記錄自動壓縮的 token 閾值(未設定時使用模型預設值)。 |
model_auto_compact_token_limit_scope |
total | body_after_prefix |
控制自動壓縮閾值是計算整個活動上下文(total,預設值),還是僅計算沿用的壓縮視窗字首之後的增量(body_after_prefix)。 |
model_catalog_json |
string (path) |
啟動時載入的 JSON 模型目錄的可選路徑。選定的 $CODEX_HOME/profile-name.config.toml 設定檔檔案可以為各個設定檔覆蓋此設定。 |
model_context_window |
number |
當前模型可用的上下文視窗 token 數。 |
model_instructions_file |
string (path) |
用於替換內建指令,代替 AGENTS.md。 |
model_provider |
string |
來自 model_providers 的供應商 ID(預設值:openai)。 |
model_providers.<id> |
table |
自定義供應商定義。內建供應商 ID(openai、ollama 和 lmstudio)為保留 ID,不能覆蓋。 |
model_providers.<id>.auth |
table |
自定義供應商通過命令取得 bearer 令牌的設定。不要與 env_key、experimental_bearer_token 或 requires_openai_auth 組合使用。 |
model_providers.<id>.auth.args |
array<string> |
傳遞給令牌命令的參數。 |
model_providers.<id>.auth.command |
string |
Codex 需要 bearer 令牌時執行的命令。該命令必須將令牌輸出到 stdout。 |
model_providers.<id>.auth.cwd |
string (path) |
令牌命令的工作目錄。 |
model_providers.<id>.auth.refresh_interval_ms |
number |
Codex 主動重新整理令牌的間隔,以毫秒為單位(預設值:300000)。設為 0 則僅在身份驗證重試後重新整理。 |
model_providers.<id>.auth.timeout_ms |
number |
令牌命令的最長執行時間,以毫秒為單位(預設值:5000)。 |
model_providers.<id>.base_url |
string |
模型供應商的 API 基礎 URL。 |
model_providers.<id>.env_http_headers |
map<string,string> |
從存在的環境變數中填充的 HTTP 請求頭。 |
model_providers.<id>.env_key |
string |
提供模型供應商 API key 的環境變數。 |
model_providers.<id>.env_key_instructions |
string |
模型供應商 API key 的可選設定指引。 |
model_providers.<id>.experimental_bearer_token |
string |
直接提供給供應商的 bearer 令牌(不推薦;請使用 env_key)。 |
model_providers.<id>.http_headers |
map<string,string> |
新增到供應商請求的靜態 HTTP 請求頭。 |
model_providers.<id>.name |
string |
自定義模型供應商的顯示名稱。 |
model_providers.<id>.query_params |
map<string,string> |
附加到供應商請求的額外查詢參數。 |
model_providers.<id>.request_max_retries |
number |
向供應商傳送 HTTP 請求的重試次數(預設值:4)。 |
model_providers.<id>.requires_openai_auth |
boolean |
供應商使用 OpenAI 身份驗證(預設值為 false)。 |
model_providers.<id>.stream_idle_timeout_ms |
number |
SSE 流的空閒超時時間,以毫秒為單位(預設值:300000)。 |
model_providers.<id>.stream_max_retries |
number |
SSE 流中斷時的重試次數(預設值:5)。 |
model_providers.<id>.supports_standalone_web_search |
boolean |
宣告支援相容的獨立網頁搜尋端點(預設值:false)。獨立搜尋仍在開發中,預設關閉;僅供應商相容並不會啟用此功能。 |
model_providers.<id>.supports_websockets |
boolean |
該供應商是否支援 Responses API 的 WebSocket 傳輸。 |
model_providers.<id>.wire_api |
responses |
供應商使用的協議。responses 是唯一支援的值,也是省略時的預設值。 |
model_providers.amazon-bedrock.aws.profile |
string |
內建 amazon-bedrock 供應商使用的 AWS 設定檔名稱。 |
model_providers.amazon-bedrock.aws.region |
string |
內建 amazon-bedrock 供應商使用的 AWS 區域。 |
model_reasoning_effort |
minimal | low | medium | high | xhigh |
調整受支援模型的推理強度(僅限 Responses API;xhigh 的支援情況取決於模型)。 |
model_reasoning_summary |
auto | concise | detailed | none |
選擇推理摘要的詳細程度,或完全停用摘要。 |
model_supports_reasoning_summaries |
boolean |
強制 Codex 傳送或不傳送推理後設資料。 |
model_verbosity |
low | medium | high |
可選的 GPT-5 Responses API 詳細程度覆蓋設定;未設定時,使用所選模型或預設的預設值。 |
notice.hide_full_access_warning |
boolean |
記錄完全存取警告提示的確認狀態。 |
notice.hide_gpt-5.1-codex-max_migration_prompt |
boolean |
記錄 gpt-5.1-codex-max 遷移提示的確認狀態。 |
notice.hide_gpt5_1_migration_prompt |
boolean |
記錄 GPT-5.1 遷移提示的確認狀態。 |
notice.hide_rate_limit_model_nudge |
boolean |
記錄是否已選擇關閉速率限制模型切換提醒。 |
notice.hide_world_writable_warning |
boolean |
記錄 Windows 全域可寫目錄警告的確認狀態。 |
notice.model_migrations |
map<string,string> |
以 old->new 對映記錄已確認的模型遷移。 |
notify |
array<string> |
傳送通知時呼叫的命令;接收來自 Codex 的 JSON 載荷。 |
openai_base_url |
string |
內建 openai 模型供應商的基礎 URL 覆蓋設定。 |
oss_provider |
lmstudio | ollama |
使用 --oss 執行時的預設本機供應商(未設定時預設提示選擇)。 |
otel.environment |
string |
應用於發出的 OpenTelemetry 事件的環境標籤(預設值:dev)。 |
otel.exporter |
none | otlp-http | otlp-grpc |
選擇 OpenTelemetry 匯出器並提供端點後設資料。 |
otel.exporter.<id>.endpoint |
string |
OTEL 日誌的匯出器端點。 |
otel.exporter.<id>.headers |
map<string,string> |
OTEL 匯出器請求中包含的靜態請求頭。 |
otel.exporter.<id>.protocol |
binary | json |
OTLP/HTTP 匯出器使用的協議。 |
otel.exporter.<id>.tls.ca-certificate |
string |
OTEL 匯出器 TLS 的 CA 證書路徑。 |
otel.exporter.<id>.tls.client-certificate |
string |
OTEL 匯出器 TLS 的客戶端證書路徑。 |
otel.exporter.<id>.tls.client-private-key |
string |
OTEL 匯出器 TLS 的客戶端私鑰路徑。 |
otel.log_user_prompt |
boolean |
選擇在 OpenTelemetry 日誌中匯出原始使用者提示詞。 |
otel.metrics_exporter |
none | statsig | otlp-http | otlp-grpc |
選擇 OpenTelemetry 指標匯出器(預設值為 statsig)。 |
otel.trace_exporter |
none | otlp-http | otlp-grpc |
選擇 OpenTelemetry 追蹤匯出器並提供端點後設資料。 |
otel.trace_exporter.<id>.endpoint |
string |
OTEL 日誌的追蹤匯出器端點。 |
otel.trace_exporter.<id>.headers |
map<string,string> |
OTEL 追蹤匯出器請求中包含的靜態請求頭。 |
otel.trace_exporter.<id>.protocol |
binary | json |
OTLP/HTTP 追蹤匯出器使用的協議。 |
otel.trace_exporter.<id>.tls.ca-certificate |
string |
OTEL 追蹤匯出器 TLS 的 CA 證書路徑。 |
otel.trace_exporter.<id>.tls.client-certificate |
string |
OTEL 追蹤匯出器 TLS 的客戶端證書路徑。 |
otel.trace_exporter.<id>.tls.client-private-key |
string |
OTEL 追蹤匯出器 TLS 的客戶端私鑰路徑。 |
permissions.<name>.description |
string |
此命名設定檔的易讀描述。設定檔不會通過 extends 繼承父檔案的描述。 |
permissions.<name>.extends |
string |
在此命名設定檔之前應用的可選父檔案。可設為另一個命名設定檔、:read-only 或 :workspace;:danger-full-access、未定義的父檔案和迴圈繼承會被拒絕。 |
permissions.<name>.filesystem |
table |
命名的檔案系統權限設定檔。每個鍵都是絕對路徑或特殊標記,例如 :minimal 或 :workspace_roots。 |
permissions.<name>.filesystem.":workspace_roots".<subpath-or-glob> |
"read" | "write" | "deny" |
相對於各個有效工作區根目錄的限定範圍檔案系統存取權限。使用 "." 表示根目錄本身;"**/*.env" 等 glob 子路徑可以通過 "deny" 拒絕讀取。 |
permissions.<name>.filesystem.<path-or-glob> |
"read" | "write" | "deny" | table |
授予路徑、glob 模式或特殊標記直接存取權限,或將巢狀條目的作用範圍限定在該根目錄下。使用 "deny" 拒絕讀取匹配路徑。 |
permissions.<name>.filesystem.glob_scan_max_depth |
number |
在沙箱啟動前為匹配結果建立快照的平台上,展開拒絕讀取 glob 模式的最大深度。設定時必須至少為 1。 |
permissions.<name>.network.allow_local_binding |
boolean |
允許通過沙箱網路進行更廣泛的本機或私有網路存取。此項保持為 false 時,精確的本機 IP 字面量或 localhost 允許規則仍可放行特定本機目標。 |
permissions.<name>.network.allow_upstream_proxy |
boolean |
允許沙箱網路通過另一個上游代理進行鏈式連線。 |
permissions.<name>.network.dangerously_allow_all_unix_sockets |
boolean |
允許存取任意 Unix 套接字目標,而非預設的受限集合。僅在嚴格受控的環境中使用。 |
permissions.<name>.network.dangerously_allow_non_loopback_proxy |
boolean |
允許沙箱網路監聽器使用非迴環繫結地址。啟用後可能使 localhost 之外的主機也能存取監聽器。 |
permissions.<name>.network.domains |
table |
沙箱命令的域名規則。僅在 features.network_proxy 或已啟用的管理員受管網路要求啟用代理時強制實施。支援精確主機名、*.example.com、**.example.com 和全域 * 允許規則;deny 優先。不限制網頁搜尋、應用或 MCP 伺服器。 |
permissions.<name>.network.domains.<pattern> |
allow | deny |
允許或拒絕精確主機名或限定範圍的萬用字元模式,例如 *.example.com 或 **.example.com。 |
permissions.<name>.network.enable_socks5 |
boolean |
此權限設定檔啟用沙箱網路時提供 SOCKS5 支援。 |
permissions.<name>.network.enable_socks5_udp |
boolean |
啟用時允許通過 SOCKS5 監聽器傳輸 UDP。 |
permissions.<name>.network.enabled |
boolean |
為此權限設定檔中的命令啟用網路存取。此設定不會啟動網路代理。如果沒有 features.network_proxy 或已啟用的管理員受管網路要求,命令將直接存取網路,且不會強制實施設定檔中的域名規則。 |
permissions.<name>.network.mode |
limited | full |
子程序流量使用的網路代理模式。 |
permissions.<name>.network.proxy_url |
string |
此權限設定檔啟用沙箱網路時使用的 HTTP 監聽 URL。 |
permissions.<name>.network.socks_url |
string |
此權限設定檔使用的 SOCKS5 代理端點。 |
permissions.<name>.network.unix_sockets |
table |
沙箱網路的 Unix 套接字允許列表覆蓋設定。以套接字路徑為鍵;allow 新增路徑,deny 拒絕路徑。 |
permissions.<name>.network.unix_sockets.<path> |
allow | deny |
使用 allow 將 Unix 套接字絕對路徑新增到有效允許列表,或使用 deny 拒絕該路徑。被拒絕的條目不會包含在有效允許列表中。 |
permissions.<name>.workspace_roots |
table |
設定檔定義的工作區根目錄,與會話執行時的工作區根目錄一同應用 :workspace_roots 檔案系統規則。 |
permissions.<name>.workspace_roots.<path> |
boolean |
為 true 時,將路徑納入設定檔的工作區根目錄集合。停用的條目保持不生效。 |
personality |
none | friendly | pragmatic |
為宣告支援 supportsPersonality 的模型設定預設溝通風格;可按執行緒或輪次覆蓋,也可通過 /personality 覆蓋。 |
plan_mode_reasoning_effort |
none | minimal | low | medium | high | xhigh |
計劃模式專用的推理強度覆蓋設定。未設定時,計劃模式使用其內建預設預設值。 |
plugins.<plugin>.enabled |
boolean |
使用 plugin-name@marketplace-name 鍵啟用或停用本機市場外掛。從合並後生效的設定中讀取;受信任專案的設定可以覆蓋使用者、雲端受管和系統預設值。即使外掛已停用,市場重新整理也可能安裝或重新整理已設定的外掛。此設定不會覆蓋工作區管理的啟用狀態。 |
plugins.<plugin>.mcp_servers.<server>.default_tools_approval_mode |
auto | prompt | writes | approve |
外掛提供的 MCP 伺服器上工具的預設審批行為。 |
plugins.<plugin>.mcp_servers.<server>.disabled_tools |
array<string> |
在 enabled_tools 之後應用於外掛所提供 MCP 伺服器的拒絕列表。 |
plugins.<plugin>.mcp_servers.<server>.enabled |
boolean |
啟用或停用已安裝外掛捆綁的 MCP 伺服器,而不修改外掛清單。 |
plugins.<plugin>.mcp_servers.<server>.enabled_tools |
array<string> |
外掛提供的 MCP 伺服器公開的工具允許列表。 |
plugins.<plugin>.mcp_servers.<server>.tools.<tool>.approval_mode |
auto | prompt | writes | approve |
外掛提供的單個 MCP 工具的審批行為覆蓋設定。 |
project_doc_fallback_filenames |
array<string> |
缺少 AGENTS.md 時嘗試讀取的額外檔名。 |
project_doc_max_bytes |
number |
建置專案指令時,從 AGENTS.md 讀取的最大位元組數。 |
project_root_markers |
array<string> |
專案根目錄標記檔名列表;用於在父目錄中查詢專案根目錄。 |
projects.<path>.trust_level |
string |
將專案或工作樹標記為受信任或不受信任("trusted" | "untrusted")。不受信任的專案會跳過專案範圍的 .codex/ 層,包括專案本機設定、鉤子和規則。 |
review_model |
string |
供 /review 使用的可選模型覆蓋設定(預設為當前會話模型)。 |
sandbox_mode |
read-only | workspace-write | danger-full-access |
命令執行期間檔案系統和網路存取的沙箱策略。 |
sandbox_workspace_write.exclude_slash_tmp |
boolean |
在 workspace-write 模式下,將 /tmp 排除在可寫根目錄之外。 |
sandbox_workspace_write.exclude_tmpdir_env_var |
boolean |
在 workspace-write 模式下,將 $TMPDIR 排除在可寫根目錄之外。 |
sandbox_workspace_write.network_access |
boolean |
允許 workspace-write 沙箱內的出站網路存取。 |
sandbox_workspace_write.writable_roots |
array<string> |
sandbox_mode = "workspace-write" 時的額外可寫根目錄。 |
service_tier |
string |
新輪次首選的服務層級。使用 fast 或當前模型宣告支援的其他層級;fast 對映到請求值 priority。 |
shell_environment_policy.exclude |
array<string> |
舊版環境變數排除模式。新設定請使用 shell_environment_policy.filters;不要在同一層中混用兩種形式。 |
shell_environment_policy.experimental_use_profile |
boolean |
建立子程序時使用使用者的 shell 設定檔。 |
shell_environment_policy.filters |
map<string, include | exclude> |
規範的環境變數模式篩選器,不區分大小寫。包含條目會建立允許列表,且無法恢復已排除的值。顯式 set 值在排除操作之後應用。不要在同一層中將篩選器與舊版 exclude 或 include_only 陣列組合使用。 |
shell_environment_policy.ignore_default_excludes |
boolean |
在其他篩選器執行前保留名稱中包含 KEY、SECRET 或 TOKEN 的變數(預設值:true)。設為 false 可按機密名稱自動排除變數。 |
shell_environment_policy.include_only |
array<string> |
舊版環境變數模式允許列表。新設定請使用 shell_environment_policy.filters;不要在同一層中混用兩種形式。 |
shell_environment_policy.inherit |
all | core | none |
建立子程序時的基礎環境繼承策略。 |
shell_environment_policy.set |
map<string,string> |
排除操作後注入的顯式環境變數值;包含篩選器仍可移除這些值。 |
show_raw_agent_reasoning |
boolean |
當前模型輸出原始推理內容時將其顯示出來。 |
skills.config |
array<object> |
儲存在 config.toml 中的各技能啟用狀態覆蓋設定。 |
skills.config.<index>.enabled |
boolean |
啟用或停用所引用的技能。 |
skills.config.<index>.path |
string (path) |
包含 SKILL.md 的技能資料夾路徑。 |
skills.max_context_tokens |
integer (positive) |
可用技能目錄的 token 預算。預設為模型上下文視窗的 2%。顯式值的上限為 10000 個 token。 |
sqlite_home |
string (path) |
Codex 儲存基於 SQLite 的狀態資料庫的目錄,該資料庫用於智能體作業及其他可恢復的執行時狀態。 |
suppress_unstable_features_warning |
boolean |
隱藏啟用開發中功能標誌時出現的警告。 |
tool_output_token_limit |
number |
在歷史記錄中儲存單個工具或函式輸出的 token 預算。 |
tool_suggest.disabled_tools |
array<table> |
停用對特定可發現連接器或外掛的建議。每個條目使用 type = "connector" 或 "plugin",以及一個 id。 |
tool_suggest.discoverables |
array<table> |
允許對額外的可發現連接器或外掛提供工具建議。每個條目使用 type = "connector" 或 "plugin",以及一個 id。 |
tools.view_image |
boolean |
啟用本機影像附件工具 view_image。 |
tools.web_search |
boolean | { context_size = "low|medium|high", allowed_domains = [string], location = { country, region, city, timezone } } |
可選的網頁搜尋工具設定。物件形式可以設定搜尋上下文大小、允許搜尋的域名和使用者的大致位置。這些搜尋域名篩選器獨立於沙箱命令的網路域名規則,不會限制連接器或 MCP 伺服器。 |
tui |
table |
TUI 專屬選項,例如啟用內聯桌面通知。 |
tui.alternate_screen |
auto | always | never |
控制 TUI 是否使用備用螢幕(預設值:auto;auto 在 Zellij 中會跳過備用螢幕,以保留回滾歷史)。 |
tui.animations |
boolean |
啟用終端動畫(歡迎螢幕、閃光效果、載入指示器)(預設值:true)。 |
tui.keymap.<context>.<action> |
string | array<string> |
TUI 操作的鍵盤快捷鍵繫結。支援的上下文包括 global、chat、composer、editor、vim_normal、vim_operator、vim_text_object、pager、list 和 approval。部分輸入框操作會回退到匹配的 tui.keymap.global 繫結;在支援的情況下,上下文專屬繫結優先。 |
tui.keymap.<context>.<action> = [] |
empty array |
解除該鍵位對映上下文中此操作的繫結。按鍵名稱使用規範化字串,例如 ctrl-a、shift-enter、page-down 或 minus。 |
tui.model_availability_nux.<model> |
integer |
以模型 slug 為鍵的內部啟動提示狀態。 |
tui.notification_condition |
unfocused | always |
控制 TUI 通知是僅在終端未獲得焦點時觸發,還是無論焦點狀態如何都觸發。預設值為 unfocused。 |
tui.notification_method |
auto | osc9 | bel |
終端通知的通知方式(預設值:auto)。 |
tui.notifications |
boolean | array<string> |
啟用 TUI 通知;可選擇僅限特定事件類型。 |
tui.raw_output_mode |
boolean |
以原始回滾模式啟動 TUI,方便在終端中選擇和複製文本(預設值:false)。可通過 /raw 或預設快捷鍵 alt-r 切換。 |
tui.resume_cwd |
current | session |
恢復會話或建立會話分支時使用的工作目錄。未設定時,如果當前目錄與會話儲存的目錄不同,Codex 會提示你選擇。 |
tui.show_tooltips |
boolean |
在 TUI 歡迎螢幕中顯示入門提示(預設值:true)。 |
tui.status_line |
array<string> | null |
TUI 底部狀態列條目識別符的有序列表。null 會停用狀態列。 |
tui.terminal_title |
array<string> | null |
終端視窗或標籤頁標題條目識別符的有序列表。預設值為 ["spinner", "project"];null 會停用標題更新。 |
tui.theme |
string |
語法高亮主題覆蓋設定(使用 kebab-case 格式的主題名稱)。 |
tui.vim_mode_default |
boolean |
以 Vim 普通模式而非插入模式啟動輸入框(預設值:false)。仍可在每個會話中通過 /vim 切換。 |
web_search |
disabled | cached | indexed | live |
網頁搜尋模式(預設值:"cached";cached 使用 OpenAI 維護的索引,不存取外部網頁;indexed 僅允許經搜尋索引把關的外部存取;如果使用 --yolo 或其他完全存取沙箱設定,則預設為 "live")。使用 "live" 進行不受限制的即時檢索,或使用 "disabled" 移除此工具。 |
windows_wsl_setup_acknowledged |
boolean |
記錄 Windows 入門引導的確認狀態(僅限 Windows)。 |
windows.sandbox |
unelevated | elevated |
在 Windows 上原生執行 Codex 時使用的原生沙箱模式,僅適用於 Windows。 |
windows.sandbox_private_desktop |
boolean |
在原生 Windows 環境中,預設在私有桌面上執行最終的沙箱子程序。僅在需要相容舊版 Winsta0\\Default 行為時設定 false。 |
沒有相符的設定選項。
你可以在此處找到 config.toml 的最新 JSON Schema。
要在 VS Code 或 Cursor 中編輯 config.toml 時獲得自動補全和診斷功能,可以安裝 Even Better TOML 擴充套件,並將以下行新增到 config.toml 頂部:
#:schema https://developers.openai.com/codex/config-schema.json注意:將 experimental_instructions_file 重新命名為 model_instructions_file。Codex 已棄用舊鍵;請將現有設定更新為新名稱。
requirements.toml
requirements.toml 是由管理員強制執行的設定檔,用於約束使用者無法覆蓋的安全敏感設定。有關詳細資訊、位置和範例,請參閱管理員強制執行的要求。
對於 ChatGPT Business 和 Enterprise 使用者,Codex 還可以應用從雲端取得的 要求。有關優先順序的詳細資訊,請參閱安全頁面。
在 requirements.toml 中使用 [features],通過與 config.toml 所用相同的
規範鍵固定執行時功能標誌。要求還可以包含不屬於 config.toml 的、已有文件說明的
僅限應用的鍵。未指定的鍵不受
約束。
某些託管要求會強制執行精確的設定值,而不是 允許列表。使用者無法覆蓋強制執行的路徑、更新偏好設定、登入 shell 策略、回饋設定或 Windows 私有桌面設定。
託管權限設定檔允許列表要求 Codex 0.138.0 或更高版本。Codex
0.137.0 及更早版本會忽略 allowed_permission_profiles 和託管的
default_permissions。
將 allowed_sandbox_modes 與 sandbox_mode 搭配使用。對於權限設定檔
部署,請將 allowed_permission_profiles 與託管的
default_permissions 搭配使用。
untrusted 條目在 allowed_approval_policies 中仍然有效,適用於
Codex 在專案使用以下設定時推匯出的更嚴格的審批行為:
trust_level = "untrusted"。這並不允許顯式設定
approval_policy = "untrusted"。
[models.new_thread] 表提供受管理的預設值,而非強制約束。
如果你通過 --model、
--config 或 --profile 顯式覆蓋模型或推理強度,Codex 會忽略 model 和
model_reasoning_effort,這兩個欄位均位於 [models.new_thread] 中。service_tier 獨立生效。
瀏覽器要求涵蓋三個獨立的操作介面。in_app_browser
控制由使用者直接開啟和使用的瀏覽器窗格。browser_use
控制由代理在瀏覽器中執行的操作。computer_use 控制由代理在
原生桌面應用中執行的操作。
巢狀的 Browser Use 和 Computer Use 策略值本身並不會授予存取權限。
針對特定來源或應用的 allow 可以覆蓋同一策略來源的
回退設定,但常規的功能、審批及其他策略檢查仍然適用。當託管要求與
config.toml 同時適用時,只要其中任一方設為 deny,
就以此為準。
| 鍵 | 類型 / 值 | 詳細資訊 |
|---|---|---|
allow_appshots |
boolean |
設為 false 可為受管理使用者停用 Appshots。如果省略,Appshots 不受要求約束,並遵循正常的產品可用性規則。 |
allow_browser_and_computer_use |
boolean |
設為 false 可同時阻止智能體驅動的 Browser Use 和原生應用 Computer Use。將其設為 true 或省略此項都不會啟用這兩項功能;其餘功能、策略和審批檢查仍然適用。 |
allow_login_shell |
boolean |
強制規定 shell 工具是否可以啟動登入 shell。 |
allow_managed_hooks_only |
boolean |
為 true 時,Codex 會跳過使用者、專案、會話和外掛鉤子,但仍允許來自 requirements.toml 及其他託管設定層的託管鉤子。 |
allow_remote_control |
boolean |
設為 false 可為受管理使用者停用裝置遠端控制。如果省略,裝置遠端控制不受要求約束,並遵循正常的產品可用性規則。 |
allowed_approval_policies |
array<string> |
允許的審批策略,例如 on-request、never 和 granular。加入 untrusted 可允許從不受信任專案派生的更嚴格策略;該策略無法通過 approval_policy 直接選擇。 |
allowed_approvals_reviewers |
array<string> |
approvals_reviewer 允許的值,例如 user 和 auto_review。 |
allowed_chatgpt_workspaces |
array<string> |
將 ChatGPT 登入(包括 Codex 存取令牌)限制為列出的工作區 ID。空列表會停用 ChatGPT 登入;在獲准的情況下,API 身份驗證仍然可用。通過本機系統要求檔案或 macOS MDM 設定;雲端託管的值會被忽略。 |
allowed_login_methods |
array<string> |
允許 chatgpt、api 或兩者。如果省略,此設定不限制登入方式。如果設定,列表必須至少包含一種方式。api 允許 API 身份驗證,包括 Amazon Bedrock。通過本機系統要求檔案或 macOS MDM 設定。雲端託管的值會被忽略。 |
allowed_permission_profiles |
table<boolean> |
允許的權限設定檔的完整列表。設為 true 的設定檔會被允許。省略或設為 false 的設定檔會被拒絕,包括未來版本中新增的設定檔。合並要求來源時,條目按設定檔名稱匹配。 |
allowed_permission_profiles.<name> |
boolean |
允許或拒絕已載入的設定或要求來源中定義的內建或自定義權限設定檔。後續優先順序更高的要求來源可以使用 false,關閉先前優先順序較低的來源所允許的設定檔。 |
allowed_sandbox_modes |
array<string> |
sandbox_mode 允許的值。 |
allowed_web_search_modes |
array<string> |
web_search 允許的值(disabled、cached、indexed、live)。disabled 始終被允許;空列表實際上僅允許 disabled。 |
apps |
table |
以應用識別符為鍵的託管應用要求。要求可以停用應用,或限制單個工具的審批行為。 |
apps.<id>.enabled |
boolean |
設為 false 可停用應用。合並多個要求來源時,停用要求仍保持限制作用。 |
apps.<id>.tools.<tool>.approval_mode |
auto | prompt | writes | approve |
設定單個應用工具的託管審批模式。 |
browser_use |
table |
智能體驅動的 Browser Use 的託管要求。 |
browser_use.allow_global_persistent_approval |
boolean |
設為 false 可阻止 Browser Use 建立或採用涵蓋所有網站的 Always allow 審批,例如允許從任意網站下載。已儲存的審批會被忽略,但不會被刪除。將其設為 true 或省略此項不會建立審批。 |
browser_use.allow_history_access |
boolean |
設為 false 可阻止 Browser Use 讀取瀏覽器歷史記錄。將其設為 true 或省略此項時,正常的歷史記錄設定和可用性檢查仍然生效。 |
browser_use.default_origin_policy |
table |
當 browser_use.origins 下沒有匹配條目定義某項 Browser Use 設定時,該設定使用的回退值。匹配的源規則會替換該策略來源的回退值。隨後,Codex 會在託管要求和使用者設定之間採用更嚴格的結果。 |
browser_use.default_origin_policy.access |
allow | deny |
使用 deny 可在採用回退值的源上阻止 Browser Use。拒絕存取某個源也會阻止在該源上上傳、下載、進行完整瀏覽器除錯存取和自動審查。allow 僅允許繼續執行正常的審批和策略檢查。 |
browser_use.default_origin_policy.access_approval_lifetime |
turn | thread |
設定非永續性網站存取審批的有效期:turn 將其限制在當前輪次,thread 則使其在當前執行緒的剩餘時間內有效。persistent_approval 單獨控制 Always allow 是否可用。產品預設值為 thread。 |
browser_use.default_origin_policy.auto_review |
allow | deny |
使用 deny 可在採用回退值的源上跳過自動審查,改為請求使用者審批。allow 會在其他設定允許時保持自動審查可用。 |
browser_use.default_origin_policy.downloads |
allow | deny |
使用 deny 可在採用回退值的源上阻止 Browser Use 下載。allow 僅允許繼續執行正常的審批和策略檢查。 |
browser_use.default_origin_policy.full_cdp_access |
allow | deny |
使用 deny 可在採用回退值的源上阻止完整的 Chrome DevTools Protocol(CDP)存取。allow 僅允許繼續執行正常的主動啟用和審批檢查。 |
browser_use.default_origin_policy.persistent_approval |
boolean |
設為 false 可阻止 Browser Use 在採用回退值的源上儲存或採用 Always allow 審批。當前輪次或執行緒的審批仍然可以生效。true 會在其他條件允許時使 Always allow 可用,但不會建立審批。 |
browser_use.default_origin_policy.uploads |
allow | deny |
使用 deny 可在採用回退值的源上阻止 Browser Use 上傳。allow 僅允許繼續執行正常的審批和策略檢查。 |
browser_use.disable_auto_review |
boolean |
設為 true 可跳過 Browser Use 的自動審查,改為請求使用者審批。將其設為 false 或省略此項時,只要其他設定允許,自動審查就仍然可用。 |
browser_use.origins |
map<string, table> |
特定源的 Browser Use 策略。鍵使用 <scheme>://<host-pattern>[:<port>],搭配 http 或 https。可以使用精確主機名、僅匹配子域名的 *.example.com,或匹配基礎域名及其子域名的 **.example.com。其他 * 萬用字元可以跨越點號,因此 region*.example.com 也會匹配 region.api.example.com;主機名為 * 時,會匹配該協議方案下的所有主機。協議方案和非預設埠會影響匹配;顯式指定的預設埠會在規範化時移除。路徑、查詢、內嵌的使用者名稱或密碼,以及含萬用字元的協議方案或埠均無效。在 TOML 中,請用引號括起模式,例如 [browser_use.origins."https://**.example.com"]。 |
browser_use.origins.<pattern> |
table |
與此模式匹配的源的策略。如果多個模式匹配,Codex 會為每項能力採用限制最嚴格的值:deny 優先於 allow,false 優先於 true,turn 優先於 thread。 |
browser_use.origins.<pattern>.access |
allow | deny |
使用 deny 可在匹配的源上阻止 Browser Use。拒絕存取也會阻止在該源上上傳、下載、進行完整瀏覽器除錯存取和自動審查。allow 僅允許繼續執行正常的審批和策略檢查。 |
browser_use.origins.<pattern>.access_approval_lifetime |
turn | thread |
設定匹配源的非永續性網站存取審批的有效期:turn 將其限制在當前輪次,thread 則使其在當前執行緒的剩餘時間內有效。persistent_approval 單獨控制 Always allow 是否可用。 |
browser_use.origins.<pattern>.auto_review |
allow | deny |
使用 deny 可在匹配的源上跳過自動審查,改為請求使用者審批。allow 會在其他設定允許時保持自動審查可用。 |
browser_use.origins.<pattern>.downloads |
allow | deny |
使用 deny 可在匹配的源上阻止 Browser Use 下載。allow 僅允許繼續執行正常的審批和策略檢查。 |
browser_use.origins.<pattern>.full_cdp_access |
allow | deny |
使用 deny 可在匹配的源上阻止完整的 Chrome DevTools Protocol(CDP)存取。allow 僅允許繼續執行正常的主動啟用和審批檢查。 |
browser_use.origins.<pattern>.persistent_approval |
boolean |
設為 false 可阻止 Browser Use 在匹配的源上儲存或採用 Always allow 審批。當前輪次或執行緒的審批仍然可以生效。true 會在其他條件允許時使 Always allow 可用,但不會建立審批。 |
browser_use.origins.<pattern>.uploads |
allow | deny |
使用 deny 可在匹配的源上阻止 Browser Use 上傳。allow 僅允許繼續執行正常的審批和策略檢查。 |
chatgpt_base_url |
string |
在身份驗證和取得雲端策略前強制指定 ChatGPT 服務的基礎 URL。這不會設定 Codex 的所有網路目標。通過本機系統要求檔案或 macOS MDM 設定;雲端託管的值會被忽略。 |
check_for_update_on_startup |
boolean |
強制規定 Codex 是否在啟動時檢查更新。 |
cli_auth_credentials_store |
file | keyring | auto | ephemeral |
在載入身份驗證前強制指定 CLI 憑據儲存方式。file 使用 CODEX_HOME/auth.json;keyring 要求使用作業系統憑據儲存;auto 在憑據儲存不可用時回退到檔案;ephemeral 將憑據儲存在當前程序的記憶體中。通過本機系統要求檔案或 macOS MDM 設定;雲端託管的值會被忽略。 |
computer_use |
table |
智能體在原生桌面應用中工作的託管要求。託管應用規則和 config.toml 應用規則都會執行;應用必須得到每個策略來源的允許。 |
computer_use.allow_locked_computer_use |
boolean |
設為 false 可阻止使用者在受管理的 macOS 裝置上啟用 Locked Use。此要求會移除啟用控制項;如果 Locked Use 已啟用,則不會將其關閉。如果省略,則遵循正常的產品可用性規則。 |
computer_use.allow_persistent_approval |
boolean |
設為 false 可移除跨會話儲存應用審批的選項。當前會話的審批仍然可用。將其設為 true 或省略此項不會核准應用。 |
computer_use.default_app_access |
allow | deny |
未匹配平台特定規則的原生應用的回退存取設定。deny 會阻止存取。allow 僅允許繼續執行正常的審批和策略檢查。產品預設值為 allow。 |
computer_use.macos |
table |
適用於 macOS 的 Computer Use 應用規則。 |
computer_use.macos.bundle_ids |
map<string, allow | deny> |
將精確的 macOS bundle 識別符對映到 allow 或 deny。匹配的規則會替換同一策略來源中的 computer_use.default_app_access。託管要求或使用者設定中任一方的拒絕仍會阻止存取。 |
computer_use.macos.bundle_ids.<bundle-id> |
allow | deny |
使用 deny 可阻止具有該精確 bundle 識別符的應用。allow 僅覆蓋此策略來源的預設值,仍需要其他所有策略來源和正常審批流程允許該應用。 |
computer_use.windows |
table |
適用於已打包和未打包 Windows 應用的 Computer Use 應用規則。 |
computer_use.windows.aumids |
map<string, allow | deny> |
將已簽名的打包應用的精確、已註冊的應用程式使用者模型 ID(AUMID)對映到 allow 或 deny。匹配的規則會替換同一策略來源中的 computer_use.default_app_access。 |
computer_use.windows.aumids.<aumid> |
allow | deny |
使用 deny 可阻止具有該精確打包應用識別的應用。allow 僅覆蓋此策略來源的預設值,仍需要其他所有策略來源和正常審批流程允許該應用。 |
computer_use.windows.exes |
array<table> |
適用於已簽名、未打包的 Windows 執行檔的規則。規則匹配執行檔經過驗證的發布者和已簽名的版本資訊,而非其路徑或當前檔名。匹配的拒絕規則優先於匹配的允許規則。未簽名的執行檔使用 computer_use.default_app_access;無法明確驗證簽名識別的執行檔會被阻止。 |
computer_use.windows.exes[].access |
allow | deny |
必填的匹配執行檔的存取決定。deny 會阻止存取。allow 僅覆蓋此策略來源的預設值,仍需要其他所有策略來源和正常審批流程允許該應用。 |
computer_use.windows.exes[].binary_name |
string |
可選的 OriginalFilename,取自執行檔的已簽名版本資訊。匹配不區分大小寫。如果匹配的發布者和產品規則要求此值,但執行檔未提供,Computer Use 會阻止該執行檔。 |
computer_use.windows.exes[].product_name |
string |
必填的精確 ProductName,取自執行檔的已簽名版本資訊。 |
computer_use.windows.exes[].publisher_name |
string |
必填的精確發布者名稱,取自執行檔的受信任簽名證書,格式為 Windows X.500 可分辨名稱。 |
default_permissions |
string |
託管的預設權限設定檔。該設定檔必須得到 allowed_permission_profiles 的允許。請顯式設定此項以確保行為可預測;如果省略,Codex 僅在 :workspace 所需的 :workspace 和 :read-only 均被顯式允許時,才使用該預設設定檔。 |
enforce_residency |
string |
要求 Codex 服務流量使用受支援的資料駐留區域。目前接受 us。 |
experimental_network |
table |
管理員管理的沙箱內本機命令網路要求,由 requirements.toml 強制執行。啟用後,這些要求可在沒有 features.network_proxy 的情況下啟動命令網路代理。瀏覽器工具會單獨檢查託管的網路拒絕規則和排他性允許列表。這些要求不會將瀏覽器流量經由代理路由,也不控制網頁搜尋、應用、MCP 伺服器、原生應用流量或 Codex 雲端網路。 |
experimental_network.allow_local_binding |
boolean |
允許沙箱網路更廣泛地存取本機/私有網路。即使此項保持為停用,精確的本機 IP 字面量或 localhost 允許規則仍可允許特定本機目標;該停用值為 false。 |
experimental_network.allow_upstream_proxy |
boolean |
允許沙箱網路通過環境中指定的上游代理進行鏈式連線。 |
experimental_network.allowed_domains |
array<string> |
啟用託管網路代理時,適用於沙箱內命令網路存取的管理員允許規則。這些規則不適用於網頁搜尋、應用或 MCP 伺服器。請勿將此項與 experimental_network.domains 同時使用。 |
experimental_network.dangerously_allow_all_unix_sockets |
boolean |
允許存取任意 Unix 套接字目標,而非僅限允許列表中的目標。僅應在嚴格受控的環境中使用。 |
experimental_network.dangerously_allow_non_loopback_proxy |
boolean |
允許 [experimental_network] 要求使用非迴環監聽地址。啟用後,監聽器可能暴露給 localhost 以外的主機。 |
experimental_network.denied_domains |
array<string> |
以列表形式表示的管理員沙箱網路拒絕規則。請勿將此項與 experimental_network.domains 同時使用。 |
experimental_network.domains |
map<string, allow | deny> |
以對映形式表示的管理員沙箱網路域名策略。支援精確主機名、僅匹配子域名的 *.example.com、匹配根域名及子域名的 **.example.com,以及全域 * 允許規則;建議使用限定範圍的規則,因為 * 會廣泛開放公網出站存取。發生衝突時,deny 優先。請勿將此項與 experimental_network.allowed_domains 或 experimental_network.denied_domains 同時使用。 |
experimental_network.enabled |
boolean |
啟用沙箱網路要求。如果當前沙箱仍然停用命令網路存取,此設定不會授予網路存取權限。 |
experimental_network.http_port |
integer |
用於 [experimental_network] 要求的迴環 HTTP 監聽埠。 |
experimental_network.managed_allowed_domains_only |
boolean |
為 true 時,在沙箱網路要求生效期間,僅管理員管理的允許規則繼續有效;使用者新增的允許列表條目會被忽略。如果沒有託管允許規則,使用者新增的域名允許規則也不會繼續生效。 |
experimental_network.socks_port |
integer |
用於 [experimental_network] 要求的迴環 SOCKS5 監聽埠。 |
experimental_network.unix_sockets |
map<string, allow | deny> |
管理員管理的沙箱網路 Unix 套接字策略。 |
features |
table |
固定的功能值。執行時功能使用 config.toml 中的規範名稱;此處也支援文件中列出的僅適用於應用的要求鍵。 |
features.<name> |
boolean |
要求文件中列出的執行時或應用功能保持啟用或停用。 |
features.apps |
boolean |
為受管理使用者將 Apps 整合固定為啟用或停用。 |
features.browser_use |
boolean |
設為 false(在 requirements.toml 中),可停用智能體驅動的 Browser Use。 |
features.browser_use_external |
boolean |
設為 false(在 requirements.toml 中),可阻止 Codex 通過 ChatGPT 瀏覽器擴充套件操作受支援的瀏覽器,包括現有標籤頁和已登入的會話。 |
features.browser_use_full_cdp_access |
boolean |
設為 false(在 requirements.toml 中),可停用本機執行時中的完整 Chrome DevTools Protocol 存取權限(包括瀏覽器開發者模式),並阻止 ChatGPT 桌面應用啟用相應設定。如果省略,則遵循正常的產品可用性規則。 |
features.computer_use |
boolean |
設為 false(在 requirements.toml 中),可停用 Computer Use、Record & Replay 以及相關的安裝或啟用流程。 |
features.fast_mode |
boolean |
為受管理使用者將規範的 fast_mode 功能固定為啟用或停用。 |
features.guardian_approval |
boolean |
為受管理使用者將 Guardian 審批固定為啟用或停用。 |
features.in_app_browser |
boolean |
設為 false(在 requirements.toml 中),可停用由使用者直接開啟和控制的內建瀏覽器面板。 |
features.in_app_updates |
boolean |
設為 false(在 requirements.toml 中),可停用應用內更新。省略此要求時,更新預設保持啟用。 |
features.memories |
boolean |
為受管理使用者將 Memories 固定為啟用或停用。 |
features.multi_agent |
boolean |
為受管理使用者將多智能體功能固定為啟用或停用。 |
features.plugin_sharing |
boolean |
設為 false(在雲端託管的 requirements.toml 中),可停用本機建置外掛的工作區共享。 |
features.plugins |
boolean |
為受管理使用者將外掛功能固定為啟用或停用。 |
features.remote_plugin |
boolean |
為受管理使用者將遠端外掛目錄固定為啟用或停用。 |
features.workspace_dependencies |
boolean |
為受管理使用者將隨附的工作區依賴執行時固定為啟用或停用。 |
feedback |
table |
託管回饋設定。 |
feedback.enabled |
boolean |
強制規定使用者是否可以在各個 Codex 客戶端中提交回饋。 |
guardian_policy_config |
string |
用於自動審查的託管 Markdown 策略指令。其優先順序高於本機 [auto_review].policy。空白值會被忽略。 |
hooks |
table |
管理員強制執行的託管生命週期鉤子。需要託管鉤子目錄,並使用與內聯 [hooks](位於 config.toml 中)相同的事件架構。 |
hooks.<Event> |
array<table> |
鉤子事件的匹配器組,例如 PreToolUse、PermissionRequest、PostToolUse、PreCompact、PostCompact、SessionStart、SessionEnd、SubagentStart、SubagentStop、UserPromptSubmit 或 Stop。 |
hooks.<Event>[].hooks |
array<table> |
匹配器組的鉤子處理程序。支援命令和 MCP 工具鉤子;提示詞和智能體鉤子處理程序會被解析,但會跳過執行。 |
hooks.<Event>[].hooks[].additionalContextLimit |
integer |
每個處理程序的大致 token 閾值,用於將過大的 additionalContext 儲存到磁碟,並向模型顯示較短的預覽。預設為 2500;0 會將完整上下文直接傳遞給模型。請參閱大型鉤子輸出。 |
hooks.<Event>[].hooks[].async |
boolean |
在後臺執行命令鉤子,不延遲觸發它的操作。預設為 false;SessionEnd 始終同步執行。請參閱在後臺執行鉤子。 |
hooks.<Event>[].hooks[].commandWindows |
string |
僅適用於 Windows 的命令鉤子命令覆蓋設定。也接受 TOML 別名 command_windows。 |
hooks.managed_dir |
string (absolute path) |
macOS 和 Linux 上存放託管鉤子指令碼的目錄。Codex 會在載入託管鉤子前驗證該路徑是否為絕對路徑且目錄存在。 |
hooks.windows_managed_dir |
string (absolute path) |
Windows 上存放託管鉤子指令碼的目錄。Codex 會在載入託管鉤子前驗證該路徑是否為絕對路徑且目錄存在。 |
in_app_browser |
table |
內建瀏覽器面板的要求。這些設定不控制智能體驅動的 Browser Use。 |
in_app_browser.allow_external_browser_settings_import |
boolean |
設為 false 可阻止使用者將外部瀏覽器的設定或瀏覽資料匯入內建瀏覽器。將其設為 true 或省略此項時,只要其他產品檢查允許,匯入功能就仍然可用。此設定僅可通過託管方式設定,無法通過 config.toml 覆蓋。 |
log_dir |
string (path) |
強制指定 Codex 寫入本機日誌檔案的目錄。 |
marketplaces |
table |
外掛市場來源的管理員要求。當 restrict_to_allowed_sources 為 true 時,規則生效。 |
marketplaces.allowed_sources |
table |
允許的市場來源,以管理員選擇的規則名稱為鍵。不同名稱的規則會跨要求層累積;同名規則下的欄位採用正常的層級優先順序。 |
marketplaces.allowed_sources.<name> |
table |
一條允許來源規則。要求合並後的最終 source 值決定 Codex 解釋哪些同級欄位。 |
marketplaces.allowed_sources.<name>.host_pattern |
string |
當 source = "host_pattern" 時必填的正規表示式。Codex 將其與從 HTTPS、SSH 或 SCP 風格的 Git 來源中解析出的小寫主機名進行匹配。使用 ^ 和 $ 可要求匹配完整主機名。 |
marketplaces.allowed_sources.<name>.path |
string (absolute path) |
當 source = "local" 時必填的本機市場目錄。Codex 要求使用絕對路徑,並在規範化後比較路徑。 |
marketplaces.allowed_sources.<name>.ref |
string |
git 規則的可選精確 Git ref。省略時,該規則允許匹配儲存庫的任意 ref。 |
marketplaces.allowed_sources.<name>.source |
git | host_pattern | local |
市場來源匹配器類型。使用 git 指定單個儲存庫,使用 host_pattern 通過正規表示式匹配 Git 主機,或使用 local 指定單個目錄。 |
marketplaces.allowed_sources.<name>.url |
string |
當 source = "git" 時必填的 Git 儲存庫 URL。Codex 會先規範化已設定和允許的 URL,再要求儲存庫精確匹配。 |
marketplaces.restrict_to_allowed_sources |
boolean |
為 true 時,要求在新增市場、安裝外掛、重新整理和執行時載入期間,設定的市場來源必須匹配 allowed_sources。OpenAI 精選的 Git 目錄(包括 API key 目錄)也必須匹配允許列表。隨附的工作區外掛和遠端安裝的工作區外掛不屬於此精選 Git 來源策略的適用範圍。 |
mcp_servers |
table |
可啟用的 MCP 伺服器允許列表。伺服器名稱(<id>)及其識別必須同時匹配,才能啟用該 MCP 伺服器。任何已設定但不在允許列表中(或識別不匹配)的 MCP 伺服器都會被停用。 |
mcp_servers.<id>.identity |
table |
單個 MCP 伺服器的識別規則。設定 command(stdio)或 url(流式 HTTP),二選一。 |
mcp_servers.<id>.identity.command |
string | table |
通過精確命令字串允許 MCP stdio 伺服器,或使用匹配器表要求精確匹配執行檔,並按順序匹配參數。字串形式不檢查參數、cwd、env 或 env_vars。 |
mcp_servers.<id>.identity.command.args |
array<table> |
stdio 伺服器的有序參數匹配器。設定的參數列表長度必須相同,且每個位置都必須匹配。命令匹配器不檢查 cwd、env 或 env_vars。 |
mcp_servers.<id>.identity.command.args[].expression |
string |
regex 參數匹配器使用的正規表示式。表示式必須有效,且匹配完整的參數值。 |
mcp_servers.<id>.identity.command.args[].match |
exact | prefix | regex |
此參數位置的匹配操作。 |
mcp_servers.<id>.identity.command.args[].value |
string |
exact 或 prefix 參數匹配器使用的值。 |
mcp_servers.<id>.identity.command.executable |
string |
stdio 伺服器設定的 command 必須精確匹配的執行檔。 |
mcp_servers.<id>.identity.url |
string | table |
通過精確 URL 字串允許 MCP 流式 HTTP 伺服器,或使用 exact、prefix 或 regex 值匹配器表。 |
mcp_servers.<id>.identity.url.expression |
string |
regex URL 匹配器使用的正規表示式。表示式必須有效,且匹配完整的 URL 值。 |
mcp_servers.<id>.identity.url.match |
exact | prefix | regex |
已設定的 MCP 伺服器 URL 的匹配操作。 |
mcp_servers.<id>.identity.url.value |
string |
exact 或 prefix URL 匹配器使用的值。 |
model_catalog_json |
string (path) |
強制指定 Codex 啟動時使用的 JSON 模型目錄。 |
models |
table |
新執行緒的託管模型預設值。這些值優先於使用者和專案的預設值,但為新執行緒顯式作出的選擇可以覆蓋它們。 |
models.new_thread |
table |
啟動新本機執行緒時應用的預設值。每項模型設定都是可選的。 |
models.new_thread.model |
string |
新執行緒的預設模型。顯式的 --model 或模型/推理 --config 覆蓋設定優先。 |
models.new_thread.model_reasoning_effort |
string |
新執行緒的預設推理強度。顯式的模型或推理強度覆蓋設定會跳過兩個託管模型欄位。 |
models.new_thread.service_tier |
string |
新執行緒的預設服務層級。顯式的服務層級覆蓋設定獨立於模型欄位生效,且優先順序更高。 |
permissions |
table |
管理員定義的權限設定檔,以設定檔名稱為鍵。使用與 config.toml 相同的設定檔欄位。 |
permissions.<name> |
table |
管理員定義的權限設定檔。名稱不能以 : 開頭,不能使用保留名稱 filesystem,也不能與已載入設定中的設定檔重名。使用與 config.toml 相同的設定檔欄位;完整的設定檔架構請參閱權限指南。 |
permissions.filesystem.deny_read |
array<string> |
管理員強制執行的檔案系統讀取拒絕規則。條目可以是路徑或 glob 模式,使用者無法通過本機設定削弱這些限制。 |
plugins |
table |
以外掛識別符為鍵的特定外掛 MCP 伺服器允許列表。此表存在時,如果外掛隨附的伺服器沒有匹配的外掛和伺服器條目,則會被停用。 |
plugins.<plugin>.mcp_servers |
table |
單個外掛隨附的 MCP 伺服器的允許列表。外掛伺服器要求使用與頂層 mcp_servers 要求相同的精確識別和匹配器形式。 |
plugins.<plugin>.mcp_servers.<server>.identity |
table |
單個外掛隨附的 MCP 伺服器的識別規則。設定 command(stdio)或 url(流式 HTTP),二選一。 |
plugins.<plugin>.mcp_servers.<server>.identity.command |
string | table |
通過精確命令字串允許外掛的 stdio MCP 伺服器,或使用匹配器表要求精確匹配執行檔,並按順序匹配參數。 |
plugins.<plugin>.mcp_servers.<server>.identity.command.args |
array<table> |
外掛隨附的 stdio 伺服器的有序參數匹配器。設定的參數列表長度必須相同,且每個位置都必須匹配。 |
plugins.<plugin>.mcp_servers.<server>.identity.command.args[].expression |
string |
regex 參數匹配器使用的正規表示式。表示式必須匹配完整的參數值。 |
plugins.<plugin>.mcp_servers.<server>.identity.command.args[].match |
exact | prefix | regex |
此參數位置的匹配操作。 |
plugins.<plugin>.mcp_servers.<server>.identity.command.args[].value |
string |
exact 或 prefix 參數匹配器使用的值。 |
plugins.<plugin>.mcp_servers.<server>.identity.command.executable |
string |
外掛隨附的 stdio 伺服器所設定的命令必須精確匹配的執行檔。 |
plugins.<plugin>.mcp_servers.<server>.identity.url |
string | table |
通過精確 URL 字串允許外掛的流式 HTTP MCP 伺服器,或使用 exact、prefix 或 regex 值匹配器表。 |
plugins.<plugin>.mcp_servers.<server>.identity.url.expression |
string |
regex URL 匹配器使用的正規表示式。表示式必須匹配完整的 URL 值。 |
plugins.<plugin>.mcp_servers.<server>.identity.url.match |
exact | prefix | regex |
外掛隨附的 MCP 伺服器 URL 的匹配操作。 |
plugins.<plugin>.mcp_servers.<server>.identity.url.value |
string |
exact 或 prefix URL 匹配器使用的值。 |
remote_sandbox_config |
array<table> |
特定主機的沙箱要求。第一個其 hostname_patterns 與解析後的主機名匹配的條目,會覆蓋該要求來源的頂層 allowed_sandbox_modes。特定主機條目目前僅覆蓋沙箱模式。 |
remote_sandbox_config[].allowed_sandbox_modes |
array<string> |
此特定主機條目匹配時應用的允許沙箱模式。 |
remote_sandbox_config[].hostname_patterns |
array<string> |
不區分大小寫的主機名模式。支援使用 * 匹配任意字元序列,使用 ? 匹配單個字元。 |
rules |
table |
管理員強制執行的命令規則,與 .rules 檔案合並。要求中的規則必須具有限制性。 |
rules.prefix_rules |
array<table> |
強制執行的字首規則列表。每條規則必須包含 pattern 和 decision。 |
rules.prefix_rules[].decision |
prompt | forbidden |
必填。要求中的規則只能請求審批或禁止,不能允許。 |
rules.prefix_rules[].justification |
string |
可選的非空理由,顯示在審批提示或拒絕訊息中。 |
rules.prefix_rules[].pattern |
array<table> |
以模式詞元表示的命令字首。每個詞元設定 token 或 any_of,二選一。 |
rules.prefix_rules[].pattern[].any_of |
array<string> |
此位置上允許的備選詞元列表。 |
rules.prefix_rules[].pattern[].token |
string |
此位置上的單個字面量詞元。 |
sqlite_home |
string (path) |
強制指定 Codex 儲存基於 SQLite 的執行時狀態的目錄。 |
windows |
table |
原生 Windows 沙箱要求。 |
windows.allowed_sandbox_implementations |
array<string> |
windows.sandbox 允許的原生 Windows 沙箱實現(elevated 和 unelevated)。列表不能為空。當兩者均被允許且未選擇模式時,Codex 優先使用 elevated。 |
windows.sandbox_private_desktop |
boolean |
強制規定原生 Windows 沙箱是否在專用桌面上啟動其子程序。 |
沒有相符的設定選項。