本文为非官方中文翻译,内容以 OpenAI 官方英文文档为准。
官方来源:https://developers.openai.com/codex/config-reference
配置参考
Codex 的 config.toml 和 requirements.toml 完整参考
将此页面用作 Codex 配置文件的可搜索参考。若需概念性指导和示例,请先阅读 配置基础 和 高级配置。
config.toml
用户级配置位于 ~/.codex/config.toml。你也可以在 .codex/config.toml 文件中添加项目作用域的覆盖项。仅当你信任该项目时,Codex 才会加载项目作用域的配置文件。
项目作用域配置不能覆盖机器本地的 provider、auth、
notification、profile 或 telemetry 路由键。Codex 会忽略
出现在项目本地 .codex/config.toml 中的
openai_base_url、chatgpt_base_url、model_provider、model_providers、
notify、profile、profiles、experimental_realtime_ws_base_url 和
otel;请改为将这些内容放在用户级配置中。
对于沙箱和审批键(approval_policy、sandbox_mode 和 sandbox_workspace_write.*),请将本参考与沙箱与审批、可写根中的受保护路径 和 网络访问 一并阅读。对于 beta 权限配置文件,请参阅权限。
你可以在这里找到 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。有关优先级的详细信息,请参阅安全页面。
在 requirements.toml 中使用 [features],可通过与 config.toml 相同的
规范键固定 feature flags。省略的键将保持不受约束。