环境变量
如需完整文档索引,请参阅 llms.txt。文档页面的 Markdown 版本可通过在页面后追加
.md来获取 URL。
Codex 使用 config.toml 来保存持久设置。将环境变量用于
shell 作用域的覆盖、自动化密钥、安装程序行为或诊断。
本页列出 Codex 直接读取的稳定公开环境变量。
它不列出内部开发变量、测试变量,或
你通过
env_key自行选择的提供商特定密钥名称。
| 变量 | 使用方 | 默认值 | 描述 |
|---|---|---|---|
CODEX_HOME |
CLI、 IDE 扩展、应用服务器、安装程序 | ~/.codex |
设置 Codex 状态的根目录,包括配置、身份验证、日志、会话、技能和独立包元数据。如果设置它,该目录必须已存在。 |
CODEX_SQLITE_HOME |
CLI 和应用服务器状态 | 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 |
~/.local/bin 在 macOS/Linux上; %LOCALAPPDATA%\Programs\OpenAI\Codex\bin 在 Windows 上 |
更改可见 codex 命令的安装位置。独立包缓存仍位于 CODEX_HOME/packages/standalone下。 |
对于无人值守安装,请在运行 CODEX_NON_INTERACTIVE=1 已下载安装程序的 shell 上设置
:
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、应用服务器、受信任的自动化 | 为受信任的自动化提供 ChatGPT 或 Codex 访问令牌。对于持久登录,请将其通过管道传给 codex login --with-access-token。 |
CODEX_CA_CERTIFICATE |
HTTPS、登录和 WebSocket 客户端 | 指向一个 PEM CA 证书包,用于存在企业 TLS 拦截或私有根 CAs的环境。优先于 SSL_CERT_FILE。 |
SSL_CERT_FILE |
HTTPS、登录和 WebSocket 客户端 | 备用 PEM CA 证书包路径,当 CODEX_CA_CERTIFICATE 未设置时使用。 |
对于提供商 API 密钥,请在模型提供商
env_key 配置中设置
。 Codex 会读取该配置指定名称的变量,因此该变量
名称本身不是固定的 Codex 环境变量。
关于自动化密钥处理,请参阅 使用 API 密钥身份验证。 关于访问令牌设置,请参阅 访问令牌。
| 变量 | 使用方 | 描述 |
|---|---|---|
RUST_LOG |
CLI 和应用服务器 | 控制 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 日志文件。