Appearance
环境变量
Codex 使用 config.toml 进行持久化设置。环境变量适用于 shell 级别的覆盖、自动化密钥、安装程序行为或诊断。
本页列出了 Codex 直接读取的稳定公共环境变量。不包括内部开发变量、测试变量或你通过 env_key 自行选择的特定于提供商的密钥名称。
核心路径
| 变量 | 使用方 | 默认值 | 说明 |
|---|---|---|---|
CODEX_HOME | CLI、IDE扩展、app-server、安装程序 | ~/.codex | 设置 Codex 状态的根目录,包括配置、认证、日志、会话、Skills 和独立包元数据。如果设置了此变量,目录必须已存在。 |
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:
bash
curl -fsSL https://chatgpt.com/codex/install.sh | CODEX_NON_INTERACTIVE=1 shpowershell
$env:CODEX_NON_INTERACTIVE=1; irm https://chatgpt.com/codex/install.ps1 | iex认证与网络
| 变量 | 使用方 | 说明 |
|---|---|---|
CODEX_API_KEY | codex exec | 为单次非交互式运行提供 API key。仅在 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 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:
bash
RUST_LOG=debug codex -c log_dir=./.codex-log
tail -F ./.codex-log/codex-tui.log在非交互模式下,codex exec 会内联打印消息,而不是写入单独的 TUI 日志文件。