環境變數
環境變數
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 日誌檔案。