Biến môi trường
Biến môi trường
Các biến môi trường được Codex hỗ trợ
Codex sử dụng config.toml cho các thiết lập lâu dài. Hãy sử dụng biến môi trường cho
các giá trị ghi đè trong phạm vi shell, bí mật tự động hóa, hành vi của trình cài đặt hoặc chẩn đoán.
Trang này liệt kê các biến môi trường công khai, ổn định mà Codex đọc trực tiếp.
Trang không liệt kê các biến phát triển nội bộ, biến kiểm thử hoặc
tên bí mật dành riêng cho nhà cung cấp mà bạn tự chọn bằng
env_key.
Các vị trí cốt lõi
| Biến | Thành phần sử dụng | Mặc định | Mô tả |
|---|---|---|---|
CODEX_HOME |
CLI, tiện ích IDE, app-server, trình cài đặt | ~/.codex |
Đặt thư mục gốc cho trạng thái Codex, bao gồm cấu hình, xác thực, nhật ký, phiên, skill và siêu dữ liệu gói độc lập. Nếu đặt biến này, thư mục phải tồn tại sẵn. |
CODEX_SQLITE_HOME |
Trạng thái CLI và app-server | CODEX_HOME |
Đặt vị trí lưu trạng thái dựa trên SQLite. Tùy chọn cấu hình sqlite_home được ưu tiên. Đường dẫn tương đối được phân giải từ thư mục làm việc hiện tại. |
Để biết thêm về các tệp được lưu trong CODEX_HOME, hãy xem
Vị trí cấu hình và trạng thái.
Biến của trình cài đặt
Các biến này áp dụng cho các tập lệnh cài đặt độc lập được phân phối từ
https://chatgpt.com/codex/install.sh và
https://chatgpt.com/codex/install.ps1.
| Biến | Mặc định | Mô tả |
|---|---|---|
CODEX_NON_INTERACTIVE |
false |
Đặt thành 1, true hoặc yes để bỏ qua lời nhắc của trình cài đặt. Lời nhắc dùng phản hồi mặc định, vì vậy hãy dùng tùy chọn này cho cài đặt và cập nhật bằng tập lệnh, không dùng cho thiết lập lần đầu. |
CODEX_INSTALL_DIR |
~/.local/bin trên macOS/Linux; %LOCALAPPDATA%\Programs\OpenAI\Codex\bin trên Windows |
Thay đổi vị trí cài đặt lệnh codex hiển thị cho người dùng. Bộ nhớ đệm của gói độc lập vẫn nằm trong CODEX_HOME/packages/standalone. |
Đối với cài đặt không cần giám sát, hãy đặt CODEX_NON_INTERACTIVE=1 trong shell chạy
trình cài đặt đã tải xuống:
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 | iexXác thực và mạng
| Biến | Được sử dụng bởi | Mô tả |
|---|---|---|
CODEX_API_KEY |
Exec, đánh giá, TypeScript SDK, exec-server từ xa | Cung cấp API key cho một tiến trình Codex không tương tác. Hãy đặt nội tuyến thay vì cho toàn bộ tác vụ khi chạy mã do kho lưu trữ kiểm soát. |
CODEX_ACCESS_TOKEN |
CLI, app-server, tác vụ tự động đáng tin cậy | Cung cấp token truy cập ChatGPT hoặc Codex cho tác vụ tự động đáng tin cậy. Để duy trì trạng thái đăng nhập, hãy chuyển token qua pipe tới codex login --with-access-token. |
OPENAI_FEDERATION_RULE_ID |
Danh tính khối lượng công việc | Chọn quy tắc liên kết đã cấu hình cho khối lượng công việc. |
OPENAI_IDENTITY_TOKEN_FILE |
Danh tính khối lượng công việc | Trỏ tới đường dẫn tuyệt đối của tệp chứa token OIDC hoặc SPIFFE JWT-SVID hiện tại. |
OPENAI_WORKLOAD_IDENTITY_CONTEXT |
Danh tính khối lượng công việc | Tùy chọn cung cấp các mã định danh JSON có giới hạn để quy kết hoạt động kiểm tra do ứng dụng báo cáo. Không ảnh hưởng đến xác thực hoặc ủy quyền. |
CODEX_CA_CERTIFICATE |
Ứng dụng khách HTTPS, đăng nhập và WebSocket | Trỏ tới gói CA PEM cho các môi trường có chặn bắt TLS doanh nghiệp hoặc chứng chỉ gốc riêng tư. Được ưu tiên hơn SSL_CERT_FILE. |
SSL_CERT_FILE |
Ứng dụng khách HTTPS, đăng nhập và WebSocket | Đường dẫn gói CA PEM dự phòng khi CODEX_CA_CERTIFICATE chưa được đặt. |
Đối với API key của nhà cung cấp, hãy đặt
env_key trong cấu hình nhà cung cấp mô hình.
Codex đọc biến có tên được cấu hình đó chỉ định, vì vậy bản thân tên biến
không phải là một biến môi trường Codex cố định.
Để biết cách xử lý thông tin bí mật trong quy trình tự động hóa, xem Sử dụng xác thực bằng API key. Để thiết lập mã thông báo truy cập, xem Mã thông báo truy cập.
Chẩn đoán
| Biến | Thành phần sử dụng | Mô tả |
|---|---|---|
RUST_LOG |
CLI và app-server | Kiểm soát bộ lọc và mức độ chi tiết của nhật ký Rust. codex exec mặc định xuất error, trừ khi bạn đặt một giá trị chi tiết hơn. |
RUST_LOG chấp nhận các giá trị như error, warn, info, debug và
trace. Biến này cũng chấp nhận các bộ lọc nhật ký Rust có phạm vi cụ thể hơn, chẳng hạn như
codex_core=debug,codex_tui=debug.
Theo mặc định, CLI tương tác ghi dữ liệu chẩn đoán vào các kho lưu trữ cục bộ có giới hạn, nhưng
tệp văn bản thuần codex-tui.log là tùy chọn chủ động. Hãy đặt log_dir tường minh khi bạn
cần nhật ký văn bản thuần để khắc phục sự cố:
RUST_LOG=debug codex -c log_dir=./.codex-log
tail -F ./.codex-log/codex-tui.logTrong chế độ không tương tác, codex exec in thông báo ngay trong dòng thay vì ghi
vào một tệp nhật ký TUI riêng.