环境变量
环境变量
Codex 支持的环境变量
Codex 使用 config.toml 存储持久设置。环境变量适用于
作用域限定于 shell 的覆盖、自动化密钥、安装程序行为或诊断。
本页面列出了 Codex 直接读取的稳定公共环境变量。
其中不包括内部开发变量、测试变量，也不包括你通过
env_key自行选择的提供商专用密钥名称。
核心位置
| 变量 | 使用方 | 默认值 | 说明 |
|---|---|---|---|
CODEX_HOME |
CLI、IDE 扩展、app-server、安装程序 | ~/.codex |
设置 Codex 状态的根目录，包括配置、身份验证、日志、会话、技能以及独立软件包元数据。如果设置此变量，该目录必须已存在。 |
CODEX_SQLITE_HOME |
CLI 和 app-server 状态 | CODEX_HOME |
设置 SQLite 后端状态的存储位置。sqlite_home 配置选项具有更高优先级。相对路径从当前工作目录开始解析。 |
有关 CODEX_HOME 下所存储文件的更多信息，请参阅
配置和状态位置。
安装程序变量
这些变量适用于由
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身份验证和网络
| 变量 | 使用方 | 说明 |
|---|---|---|
CODEX_API_KEY |
Exec、审查、TypeScript SDK、远程 exec-server | 为非交互式 Codex 进程提供 API key。运行仓库控制的代码时，请以内联方式设置，而不要为整个作业设置。 |
CODEX_ACCESS_TOKEN |
CLI、app-server、可信自动化 | 为可信自动化提供 ChatGPT 或 Codex 访问令牌。若要持久保存登录，请通过管道将其传给 codex login --with-access-token。 |
OPENAI_FEDERATION_RULE_ID |
工作负载身份 | 选择为该工作负载配置的联合规则。 |
OPENAI_IDENTITY_TOKEN_FILE |
工作负载身份 | 指向包含当前 OIDC 令牌或 SPIFFE JWT-SVID 的文件绝对路径。 |
OPENAI_WORKLOAD_IDENTITY_CONTEXT |
工作负载身份 | 可选地提供有界 JSON 标识符，用于客户端报告的审计归因。它不会影响身份验证或授权。 |
CODEX_CA_CERTIFICATE |
HTTPS、登录和 WebSocket 客户端 | 指向 PEM CA 包，适用于存在企业 TLS 拦截或私有根证书的环境。其优先级高于 SSL_CERT_FILE。 |
SSL_CERT_FILE |
HTTPS、登录和 WebSocket 客户端 | 未设置 CODEX_CA_CERTIFICATE 时使用的备用 PEM CA 包路径。 |
对于提供商 API key，请在模型提供商配置中设置
env_key。
Codex 会读取该配置所指定名称的变量，因此变量名称本身并不是固定的 Codex 环境变量。
有关自动化密钥处理，请参阅 使用 API key 身份验证。 有关访问令牌设置，请参阅访问令牌。 有关工作负载身份设置，请参阅 工作负载身份联合。
诊断
| 变量 | 使用方 | 说明 |
|---|---|---|
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-log
tail -F ./.codex-log/codex-tui.log在非交互模式下，codex exec 会内联输出消息，而不是将其写入
单独的 TUI 日志文件。