Dasar-dasar konfigurasi

Pelajari dasar-dasar konfigurasi klien Codex lokal Anda

Codex membaca detail konfigurasi dari lebih dari satu lokasi. Pengaturan default pribadi Anda berada di ~/.codex/config.toml, dan Anda dapat menambahkan penggantian khusus proyek dengan file .codex/config.toml. Demi keamanan, Codex hanya memuat lapisan .codex/ proyek jika Anda memercayai proyek tersebut.

File konfigurasi Codex

Codex menyimpan konfigurasi tingkat pengguna di ~/.codex/config.toml. Untuk membatasi cakupan pengaturan ke proyek atau subfolder tertentu, tambahkan file .codex/config.toml di repositori Anda.

Untuk membuka file konfigurasi dari ekstensi Codex IDE, pilih ikon roda gigi di sudut kanan atas, lalu pilih Codex Settings > Open config.toml.

CLI dan ekstensi IDE menggunakan lapisan konfigurasi yang sama. Anda dapat menggunakannya untuk:

Prioritas konfigurasi

Persyaratan membatasi perilaku; nilai konfigurasi menyediakan nilai default. Akses komputer lokal dengan Work Cloud mengikuti persyaratan berikut:

  • Antarkebijakan: Kebijakan dengan prioritas lebih tinggi mengesampingkan kebijakan dengan prioritas lebih rendah, meskipun kebijakan berprioritas lebih rendah lebih spesifik.
  • Dalam satu kebijakan: Penggantian pengaturan lingkungan khusus OS didahulukan daripada penggantian pengaturan lingkungan untuk semua OS, lalu diikuti oleh Global.
  • Untuk eksekusi lokal: Persyaratan MDM dan persyaratan perangkat terkelola lama memiliki prioritas lebih tinggi daripada Agent Security. File persyaratan sistem perangkat memiliki prioritas lebih rendah daripada Agent Security.
  • Untuk Work Cloud: Kontainer cloud Work tetap menggunakan kebijakan Work Cloud yang sudah ada. Untuk Work dengan akses lokal dan dots, kebijakan Global yang didukung mengatur orkestrator cloud bersama saat kebijakan terkelola diaktifkan; persyaratan eksekusi lokal yang berlaku mengatur komputer yang terhubung.

Beberapa persyaratan memiliki aturan penggabungan khusus per bidang. Lihat Konfigurasi terkelola untuk cakupan kebijakan dan batasan runtime, serta Referensi Konfigurasi untuk kompatibilitas Work.

Codex menentukan nilai dalam urutan berikut (prioritas tertinggi lebih dahulu):

  1. Flag CLI dan penggantian nilai melalui --config
  2. File konfigurasi proyek: .codex/config.toml, diurutkan dari direktori akar proyek hingga direktori kerja Anda saat ini (yang terdekat diutamakan; hanya untuk proyek tepercaya)
  3. File profil yang dipilih dengan --profile profile-name (~/.codex/profile-name.config.toml)
  4. Konfigurasi pengguna: ~/.codex/config.toml
  5. Nilai bawaan config.toml yang dikelola melalui cloud, jika disediakan untuk ruang kerja tempat Anda masuk
  6. Konfigurasi sistem (jika ada): /etc/codex/config.toml di Unix
  7. Nilai bawaan aplikasi

Gunakan urutan prioritas tersebut untuk menetapkan pengaturan default bersama di config.toml dan menjaga agar file profil hanya berisi nilai yang berbeda.

Konfigurasi yang dikelola melalui cloud dan konfigurasi sistem dapat menentukan marketplace plugin dan mengatur apakah plugin diaktifkan secara bawaan. Konfigurasi ini terpisah dari kebijakan requirements.toml yang diberlakukan secara wajib. Lihat Mengonfigurasi marketplace plugin dan nilai bawaan.

Jika Anda menandai proyek sebagai tidak tepercaya, Codex melewati lapisan .codex/ yang dicakup oleh proyek, termasuk konfigurasi, hook, dan aturan lokal proyek. Konfigurasi pengguna dan sistem tetap dimuat, termasuk hook dan aturan pengguna/global.

Untuk penggantian sekali pakai melalui -c/--config (termasuk aturan tanda kutip TOML), lihat Konfigurasi Lanjutan.

Opsi konfigurasi umum

Berikut beberapa opsi yang paling sering diubah:

Model default

Pilih model yang digunakan Codex secara default di CLI dan IDE.

model = "gpt-6.1-sol"

Permintaan persetujuan

Atur kapan Codex berhenti sementara untuk meminta persetujuan sebelum menjalankan perintah yang dihasilkan.

approval_policy = "on-request"

Untuk perbedaan perilaku antara on-request dan never, lihat Menjalankan tanpa permintaan persetujuan dan Kombinasi sandbox dan persetujuan yang umum. Jika konfigurasi yang ada menggunakan approval_policy = "untrusted", lihat Bermigrasi dari kebijakan persetujuan untrusted yang telah dihentikan.

Tingkat sandbox

Sesuaikan tingkat akses sistem file dan jaringan yang dimiliki Codex saat menjalankan perintah.

sandbox_mode = "workspace-write"

Untuk perilaku setiap mode (termasuk jalur .git, .agents, .codex, dan .aws yang dilindungi serta pengaturan default jaringan), lihat Sandbox dan persetujuan, Jalur yang dilindungi dalam direktori akar yang dapat ditulisi, dan Akses jaringan.

Profil izin

Codex juga mendukung profil izin bernama untuk kebijakan sistem file dan jaringan yang dapat digunakan kembali. Profil bawaan adalah :read-only, :workspace, dan :danger-full-access. Profil khusus menggunakan tabel [permissions.<name>] dan nilai default_permissions yang cocok. Lihat Izin.

Mode sandbox Windows

Di Windows, utamakan MXC jika perangkat dan kebijakan mendukungnya. Tetapkan implementasi lama sebagai opsi cadangan:

[windows]
sandbox = "elevated" # Legacy fallback

[features]
prefer_mxc = true

Gunakan unelevated hanya jika penyiapan dengan hak akses yang ditingkatkan tidak tersedia dan kebijakan organisasi Anda mengizinkannya. Lihat panduan sandbox Windows untuk mengetahui batasan kompatibilitas dan kontrol peluncuran.

Mode pencarian web

Codex mengaktifkan pencarian web secara default untuk percakapan lokal dan menyajikan hasil dari cache pencarian web. Cache ini merupakan indeks hasil web yang dikelola OpenAI, sehingga mode cache mengembalikan hasil yang telah diindeks alih-alih mengambil halaman secara langsung. Hal ini mengurangi paparan terhadap injeksi prompt dari konten langsung yang tidak terkontrol. Perlakukan hasil web sebagai data yang tidak tepercaya. Jika Anda menggunakan --yolo atau pengaturan sandbox dengan akses penuh lainnya, pencarian web secara default menggunakan hasil langsung. Pilih mode dengan web_search:

  • "cached" (default) menyajikan hasil dari cache pencarian web.
  • "indexed" mengizinkan akses web eksternal hanya jika indeks pencarian menyetujui permintaan tersebut.
  • "live" mengambil data terbaru dari web (sama seperti --search).
  • "disabled" menonaktifkan alat pencarian 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"

Upaya penalaran

Sesuaikan seberapa besar upaya penalaran yang diterapkan model jika didukung.

model_reasoning_effort = "medium"

Gaya komunikasi

Untuk tidak menyertakan instruksi kepribadian bawaan, tetapkan:

personality = "none"

Pengaturan ini menghapus bagian Personality dari instruksi bawaan model. Pengaturan ini tidak mengubah instruksi dasar kustom yang ditetapkan secara eksplisit. Nilai lama friendly dan pragmatic tidak lagi digunakan untuk memilih gaya. Codex tidak lagi menyediakan perintah /personality.

Pemetaan tombol TUI

Sesuaikan pintasan terminal di bawah tui.keymap. Tindakan composer yang dipilih menggunakan binding tui.keymap.global yang cocok sebagai fallback; binding khusus konteks memiliki prioritas jika didukung. Daftar kosong menghapus binding tindakan tersebut.

[tui.keymap.global]
open_transcript = "ctrl-t"

[tui.keymap.composer]
submit = ["enter", "ctrl-m"]

[tui.keymap.chat]
interrupt_turn = "f12"

Lingkungan perintah

Atur variabel lingkungan mana yang diteruskan Codex ke perintah yang dijalankan. Gunakan filter berbasis kunci agar hanya variabel yang Anda perlukan yang dipertahankan:

[shell_environment_policy]
ignore_default_excludes = false

[shell_environment_policy.filters]
"PATH" = "include"
"HOME" = "include"

ignore_default_excludes secara default bernilai true, yang melewati pemfilteran otomatis untuk nama variabel yang mengandung KEY, SECRET, atau TOKEN. Tetapkan ke false jika Anda menginginkan pemfilteran otomatis tersebut. Untuk aturan pengecualian, prioritas, dan konfigurasi lama, lihat Kebijakan lingkungan shell.

Direktori log

Ganti lokasi tempat Codex menulis file log lokal. Menetapkan log_dir secara eksplisit juga mengaktifkan log TUI teks biasa opsional, codex-tui.log, di direktori tersebut.

log_dir = "/absolute/path/to/codex-logs"

Untuk proses sekali pakai, Anda juga dapat menetapkannya dari CLI:

codex -c log_dir=./.codex-log

Flag fitur

Gunakan tabel [features] di config.toml untuk mengaktifkan atau menonaktifkan kemampuan opsional dan eksperimental.

Flag fitur umum

Kunci Default Kematangan Deskripsi
apps true Stabil Mengaktifkan integrasi aplikasi (konektor)
goals true Stabil Mengaktifkan sasaran tersimpan dan kelanjutan otomatis
hooks true Stabil Mengaktifkan hook siklus hidup dari hooks.json atau [hooks] inline. Lihat Hook.
fast_mode true Stabil Mengaktifkan pemilihan mode Fast dan jalur service_tier = "fast"
memories false Eksperimental Mengaktifkan Memori
multi_agent true Stabil Mengaktifkan alat kolaborasi subagen
remote_plugin true Stabil Mengaktifkan katalog plugin jarak jauh
shell_snapshot true Stabil Mengambil snapshot lingkungan shell untuk mempercepat perintah berulang
shell_tool true Stabil Mengaktifkan alat eksekusi perintah
unified_exec true Stabil Mengaktifkan eksekusi perintah yang dapat dilanjutkan; hanya persyaratan terkelola yang dapat menonaktifkannya
web_search true Tidak digunakan lagi Tombol pengalih lama; utamakan pengaturan tingkat atas web_search
web_search_cached false Tidak digunakan lagi Tombol pengalih lama yang dipetakan ke web_search = "cached" jika belum ditetapkan
web_search_request false Tidak digunakan lagi Tombol pengalih lama yang dipetakan ke web_search = "live" jika belum ditetapkan

Untuk konfigurasi hook siklus hidup, lihat Hook.

Mengaktifkan fitur

  • Di config.toml, tambahkan feature_name = true di bawah [features].
  • Dari CLI, jalankan codex --enable feature_name.
  • Untuk mengaktifkan lebih dari satu fitur, jalankan codex --enable feature_a --enable feature_b.
  • Untuk menonaktifkan fitur, tetapkan kunci ke false di config.toml.