Kiến thức cơ bản về cấu hình
Để xem chỉ mục tài liệu đầy đủ, hãy xem llms.txt. Bạn có thể xem phiên bản Markdown của các trang tài liệu bằng cách thêm .md vào URL của trang.
Codex đọc thông tin cấu hình từ nhiều vị trí. Các giá trị mặc định cá nhân của bạn nằm trong ~/.codex/config.toml, và bạn có thể thêm các thiết lập ghi đè cho dự án bằng tệp .codex/config.toml. Để bảo mật, Codex chỉ tải các lớp .codex/ của dự án khi bạn tin cậy dự án đó.
Tệp cấu hình Codex
Codex lưu cấu hình cấp người dùng tại ~/.codex/config.toml. Để giới hạn phạm vi thiết lập cho một dự án hoặc thư mục con cụ thể, hãy thêm tệp .codex/config.toml vào kho lưu trữ của bạn.
Để mở tệp cấu hình từ tiện ích mở rộng Codex IDE, hãy chọn biểu tượng bánh răng ở góc trên bên phải, sau đó chọn Codex Settings > Open config.toml.
CLI và tiện ích mở rộng IDE dùng chung các lớp cấu hình. Bạn có thể sử dụng chúng để:
- Đặt model và nhà cung cấp mặc định.
- Cấu hình chính sách phê duyệt và thiết lập sandbox.
- Cấu hình máy chủ MCP.
Thứ tự ưu tiên cấu hình
Codex phân giải các giá trị theo thứ tự sau (mức ưu tiên cao nhất trước):
- Các cờ CLI và thiết lập ghi đè
--config - Các tệp cấu hình dự án:
.codex/config.toml, được sắp xếp từ thư mục gốc của dự án đến thư mục làm việc hiện tại của bạn (tệp gần nhất được ưu tiên; chỉ áp dụng cho dự án đáng tin cậy) - Các tệp hồ sơ được chọn bằng
--profile profile-name(~/.codex/profile-name.config.toml) - Cấu hình người dùng:
~/.codex/config.toml - Cấu hình hệ thống (nếu có):
/etc/codex/config.tomltrên Unix - Các giá trị mặc định tích hợp sẵn
Hãy sử dụng thứ tự ưu tiên này để đặt các giá trị mặc định dùng chung trong config.toml và chỉ giữ những giá trị khác biệt trong các tệp hồ sơ.
Nếu bạn đánh dấu một dự án là không đáng tin cậy, Codex sẽ bỏ qua các lớp .codex/ thuộc phạm vi dự án, bao gồm cấu hình, hook và quy tắc cục bộ của dự án. Cấu hình người dùng và hệ thống vẫn được tải, bao gồm hook và quy tắc cấp người dùng/toàn cục.
Để biết cách ghi đè dùng một lần qua -c/--config (bao gồm các quy tắc đặt dấu ngoặc kép của TOML), hãy xem Cấu hình nâng cao.
Các tùy chọn cấu hình phổ biến
Dưới đây là một số tùy chọn thường được thay đổi nhất:
Model mặc định
Chọn model mà Codex sử dụng theo mặc định trong CLI và IDE.
model = "gpt-5.6"Lời nhắc phê duyệt
Kiểm soát thời điểm Codex tạm dừng để xin phép trước khi chạy các lệnh được tạo.
approval_policy = "on-request"Để biết sự khác biệt về hành vi giữa untrusted, on-request và never, hãy xem Chạy mà không có lời nhắc phê duyệt và Các tổ hợp sandbox và phê duyệt phổ biến.
Cấp độ sandbox
Điều chỉnh phạm vi truy cập hệ thống tệp và mạng mà Codex có khi thực thi lệnh.
sandbox_mode = "workspace-write"Để biết hành vi của từng chế độ (bao gồm các đường dẫn .git/.codex được bảo vệ và thiết lập mạng mặc định), hãy xem Sandbox và phê duyệt, Đường dẫn được bảo vệ trong các thư mục gốc có thể ghi và Quyền truy cập mạng.
Hồ sơ quyền
Codex cũng hỗ trợ các hồ sơ quyền có tên để tái sử dụng chính sách hệ thống tệp và
mạng. Các hồ sơ tích hợp sẵn gồm :read-only, :workspace và
:danger-full-access. Hồ sơ tùy chỉnh sử dụng các bảng [permissions.<name>] và một giá trị
default_permissions tương ứng. Hãy xem Quyền.
Chế độ sandbox trên Windows
Khi chạy Codex trực tiếp trên Windows, hãy đặt chế độ sandbox gốc thành elevated trong bảng windows. Chỉ sử dụng unelevated nếu bạn không có quyền quản trị viên hoặc quá trình thiết lập nâng cao thất bại.
[windows]
sandbox = "elevated" # Recommended
# sandbox = "unelevated" # Fallback if admin permissions/setup are unavailableChế độ tìm kiếm web
Codex bật tìm kiếm web theo mặc định cho các cuộc trò chuyện cục bộ và cung cấp kết quả từ bộ nhớ đệm tìm kiếm web. Bộ nhớ đệm là chỉ mục kết quả web do OpenAI duy trì, vì vậy chế độ dùng bộ nhớ đệm trả về các kết quả đã được lập chỉ mục thay vì truy xuất trực tiếp các trang. Điều này giúp giảm nguy cơ bị chèn prompt từ nội dung trực tiếp tùy ý, nhưng bạn vẫn nên coi kết quả web là không đáng tin cậy. Nếu bạn đang sử dụng --yolo hoặc một thiết lập sandbox có toàn quyền truy cập khác, tìm kiếm web mặc định sẽ trả về kết quả trực tiếp. Chọn chế độ bằng web_search:
"cached"(mặc định) cung cấp kết quả từ bộ nhớ đệm tìm kiếm web."indexed"chỉ cho phép truy cập web bên ngoài khi chỉ mục tìm kiếm chấp thuận yêu cầu."live"truy xuất dữ liệu mới nhất từ web (giống như--search)."disabled"tắt công cụ tìm kiếm web.
web_search = "cached" # default; serves results from the web search cache
# web_search = "indexed" # gate external web access through the search index
# web_search = "live" # fetch the most recent data from the web (same as --search)
# web_search = "disabled"Mức độ suy luận
Điều chỉnh mức độ suy luận mà model áp dụng khi được hỗ trợ.
model_reasoning_effort = "high"Phong cách giao tiếp
Đặt phong cách giao tiếp mặc định cho các model được hỗ trợ.
personality = "friendly" # or "pragmatic" or "none"Bạn có thể ghi đè thiết lập này sau đó trong một phiên đang hoạt động bằng /personality hoặc theo từng luồng/lượt khi sử dụng các API app-server.
Sơ đồ phím TUI
Tùy chỉnh các phím tắt trong terminal tại tui.keymap. Các thao tác soạn thảo được chọn sẽ dùng phương án dự phòng là các liên kết tui.keymap.global tương ứng; các liên kết theo ngữ cảnh cụ thể được ưu tiên khi được hỗ trợ. Danh sách trống sẽ hủy liên kết của thao tác.
[tui.keymap.global]
open_transcript = "ctrl-t"
[tui.keymap.composer]
submit = ["enter", "ctrl-m"]
[tui.keymap.chat]
interrupt_turn = "f12"Môi trường lệnh
Kiểm soát các biến môi trường mà Codex chuyển tiếp đến những lệnh được khởi chạy. Sử dụng các bộ lọc theo khóa để chỉ giữ lại những biến bạn cần:
[shell_environment_policy]
ignore_default_excludes = false
[shell_environment_policy.filters]
"PATH" = "include"
"HOME" = "include"ignore_default_excludes mặc định là true, do đó bỏ qua việc lọc tự động
đối với tên biến chứa KEY, SECRET hoặc TOKEN. Đặt thành false
khi bạn muốn áp dụng cơ chế lọc tự động đó. Để biết các quy tắc loại trừ, thứ tự ưu tiên và
cấu hình cũ, hãy xem Chính sách môi trường
shell.
Thư mục nhật ký
Ghi đè vị trí Codex ghi các tệp nhật ký cục bộ. Việc đặt log_dir một cách rõ ràng cũng
bật nhật ký TUI dạng văn bản thuần cần chủ động tham gia, codex-tui.log, trong thư mục đó.
log_dir = "/absolute/path/to/codex-logs"Đối với các lần chạy dùng một lần, bạn cũng có thể đặt giá trị này từ CLI:
codex -c log_dir=./.codex-logCờ tính năng
Sử dụng bảng [features] trong config.toml để bật hoặc tắt các chức năng tùy chọn và thử nghiệm.
Các cờ tính năng phổ biến
| Khóa | Mặc định | Mức độ hoàn thiện | Mô tả |
|---|---|---|---|
apps |
true | Ổn định | Bật tích hợp ứng dụng (trình kết nối) |
goals |
true | Ổn định | Bật mục tiêu được lưu trữ và khả năng tự động tiếp tục |
hooks |
true | Ổn định | Bật hook vòng đời từ hooks.json hoặc [hooks] nội tuyến. Hãy xem Hook. |
fast_mode |
true | Ổn định | Bật lựa chọn chế độ Fast và đường dẫn service_tier = "fast" |
memories |
false | Thử nghiệm | Bật Memories |
multi_agent |
true | Ổn định | Bật các công cụ cộng tác với tác nhân phụ |
personality |
true | Ổn định | Bật các điều khiển lựa chọn tính cách |
remote_plugin |
true | Ổn định | Bật danh mục plugin từ xa |
shell_snapshot |
true | Ổn định | Chụp nhanh môi trường shell để tăng tốc các lệnh lặp lại |
shell_tool |
true | Ổn định | Bật công cụ shell mặc định |
unified_exec |
true trừ Windows |
Ổn định | Sử dụng công cụ exec hợp nhất dựa trên PTY |
web_search |
true | Không còn khuyến nghị | Cờ chuyển đổi cũ; nên dùng thiết lập web_search cấp cao nhất |
web_search_cached |
false | Không còn khuyến nghị | Cờ chuyển đổi cũ ánh xạ đến web_search = "cached" khi chưa được đặt |
web_search_request |
false | Không còn khuyến nghị | Cờ chuyển đổi cũ ánh xạ đến web_search = "live" khi chưa được đặt |
Để biết cách cấu hình hook vòng đời, hãy xem Hook.
Bật tính năng
- Trong
config.toml, thêmfeature_name = truebên dưới[features]. - Từ CLI, chạy
codex --enable feature_name. - Để bật nhiều tính năng, hãy chạy
codex --enable feature_a --enable feature_b. - Để tắt một tính năng, hãy đặt khóa thành
falsetrongconfig.toml.