环境变量
Codex 使用 config.toml 保存持久设置。对于 shell 作用域内的覆盖、自动化密钥、安装程序行为或诊断,请使用环境变量。
此页面列出了 Codex 直接读取的稳定公共环境变量。不包括内部开发变量、测试变量,或你通过 env_key 自行选择的特定提供商密钥名称。
| 变量 | 使用者 | 默认值 | 描述 |
|---|---|---|---|
CODEX_HOME |
CLI、IDE extension、app-server、安装程序 | ~/.codex |
设置 Codex 状态的根目录,包括配置、身份验证、日志、会话、技能和独立软件包元数据。如果设置了该变量,目录必须已经存在。 |
CODEX_SQLITE_HOME |
CLI 和 app-server 状态 | CODEX_HOME |
设置 SQLite 支持的状态的存储位置。sqlite_home 配置选项优先级更高。相对路径以当前工作目录为基准解析。 |
有关 CODEX_HOME 下存储的文件的更多信息,请参阅配置和状态位置。
安装程序变量
Section titled “安装程序变量”这些变量适用于从 https://chatgpt.com/codex/install.sh 和 https://chatgpt.com/codex/install.ps1 提供的独立安装脚本。
| 变量 | 默认值 | 描述 |
|---|---|---|
CODEX_NON_INTERACTIVE |
false |
设置为 1、true 或 yes 可跳过安装程序提示。提示会使用其默认响应,因此该变量适用于脚本化安装和更新,不适用于首次运行设置。 |
CODEX_INSTALL_DIR |
macOS/Linux 上为 ~/.local/bin;Windows 上为 %LOCALAPPDATA%\Programs\OpenAI\Codex\bin |
更改可见的 codex 命令的安装位置。独立软件包缓存仍位于 CODEX_HOME/packages/standalone 下。 |
对于无人值守安装,请在运行下载的安装程序的 shell 中设置 CODEX_NON_INTERACTIVE=1:
curl -fsSL https://chatgpt.com/codex/install.sh | CODEX_NON_INTERACTIVE=1 sh$env:CODEX_NON_INTERACTIVE=1; irm https://chatgpt.com/codex/install.ps1 | iex身份验证和网络
Section titled “身份验证和网络”| 变量 | 使用者 | 描述 |
|---|---|---|
CODEX_API_KEY |
codex exec |
为单次非交互式运行提供 API 密钥。仅支持在 codex exec 中使用;运行由仓库控制的代码时,应以内联方式设置,而不是针对整个作业设置。 |
CODEX_ACCESS_TOKEN |
CLI、app-server、受信任的自动化 | 为受信任的自动化提供 ChatGPT 或 Codex 访问令牌。若要持久化登录,请将其通过管道传递给 codex login --with-access-token。 |
CODEX_CA_CERTIFICATE |
HTTPS、登录和 WebSocket 客户端 | 指向 PEM CA 捆绑包,用于存在企业 TLS 拦截或私有根 CA 的环境。其优先级高于 SSL_CERT_FILE。 |
SSL_CERT_FILE |
HTTPS、登录和 WebSocket 客户端 | 当未设置 CODEX_CA_CERTIFICATE 时使用的备用 PEM CA 捆绑包路径。 |
对于提供商 API 密钥,请在模型提供商配置中设置 env_key。Codex 会读取该配置指定的变量,因此变量名本身并不是固定的 Codex 环境变量。
有关自动化密钥处理,请参阅使用 API 密钥身份验证。有关访问令牌设置,请参阅访问令牌。
| 变量 | 使用者 | 描述 |
|---|---|---|
RUST_LOG |
CLI 和 app-server | 控制 Rust 日志筛选和详细程度。除非设置了更详细的值,否则 codex exec 默认输出 error 级别的内容。 |
RUST_LOG 接受 error、warn、info、debug 和 trace 等值。它还接受更有针对性的 Rust 日志筛选器,例如 codex_core=debug,codex_tui=debug。
交互式 CLI 默认会将诊断信息记录在有大小限制的本地存储中,但明文的 codex-tui.log 文件需要选择启用。需要使用明文日志进行故障排除时,请显式设置 log_dir:
RUST_LOG=debug codex -c log_dir=./.codex-logtail -F ./.codex-log/codex-tui.log在非交互模式下,codex exec 会直接内联打印消息,而不是写入单独的 TUI 日志文件。