Cara Menggunakan Apidog CLI di Codex

Minta OpenAI Codex menjalankan pengujian API Anda. Tambahkan blok CLI Apidog ke AGENTS.md, berikan perintah kepada Codex, dan saksikan ia menjalankan `apidog run` di dalam siklus edit-uji-perbaiki miliknya sendiri.

INEZA Felin-Michel

INEZA Felin-Michel

16 June 2026

Cara Menggunakan Apidog CLI di Codex

Apidog untuk Perusahaan

Penerapan On-Premises

SSO & RBAC

Sesuai SOC 2

Jelajahi Apidog Enterprise

Codex adalah sebuah putaran: ia mengedit file, menjalankan perintah, membaca output, dan memutuskan apa yang harus dilakukan selanjutnya. Jadi, mengapa tes API Anda tidak ada dalam putaran itu? Mereka berada di Apidog di balik GUI, dijalankan saat seseorang ingat untuk mengklik. Agen Anda tidak pernah menyentuhnya.

Perbaikannya adalah satu blok konfigurasi. Apidog CLI adalah paket npm, apidog-cli, yang menjalankan skenario tes yang Anda buat di Apidog langsung dari terminal. Setelah CLI terinstal dan Codex tahu keberadaannya, agen Anda menjalankan skenario Apidog dengan cara yang sama seperti menjalankan tes unit Anda: tembak perintahnya, baca kode keluarnya, perbaiki kode jika merah.

Panduan ini mencakup bagian khusus Codex yang dilewati oleh panduan instalasi generik: baris persis untuk AGENTS.md Anda, perintah untuk diberikan kepada Codex, bagaimana ia menjalankan apidog run di dalam putarannya sendiri, dan bagaimana membaca hasilnya.

Jika Anda belum menginstal CLI, lakukan itu terlebih dahulu. Cara menginstal Apidog CLI dengan agen pengkodean AI membahas instalasi npm, token akses, dan jalankan pertama, dengan Codex yang melakukan pengetikan. Artikel ini mengasumsikan apidog --version mencetak angka dan akun Apidog Anda terautentikasi.

button

Codex yang mana yang dimaksud

Baik OpenAI Codex CLI maupun Codex App. Ini berjalan secara lokal, membaca repositori Anda, mengedit file, dan menjalankan perintah shell di dalam sandbox, meminta persetujuan berdasarkan mode izin Anda. Ini bukan API penyelesaian kode Codex yang lama. Jika Anda menjalankan codex dan mendapatkan antarmuka layar penuh yang menampilkan perbedaan dan output perintah, Anda berada di tempat yang tepat. Panduan OpenAI Codex CLI mencakup dasar-dasarnya.

Perbedaan ini penting karena Codex memiliki caranya sendiri untuk mempelajari aturan proyek, dan mekanisme itu mengubah “jalankan tes saya” yang sekali jalan menjadi sesuatu yang dicari Codex sendiri. Mekanisme itu adalah AGENTS.md.

Mekanismenya: AGENTS.md, bukan pengingat obrolan

Codex membaca file AGENTS.md sebelum mulai bekerja. Anggap saja sebagai CLAUDE.md untuk Claude Code: file Markdown biasa berisi instruksi proyek yang dimuat Codex ke dalam konteks di awal setiap sesi. Ia membangun set instruksi dengan berjalan dari root Git Anda hingga ke direktori saat ini, menggabungkan setiap AGENTS.md dari root-pertama, sehingga file yang lebih dekat menang dalam konflik. Ada juga ~/.codex/AGENTS.md global. Untuk tujuan kita, satu file di root repo sudah cukup.

Inilah mengapa Anda menulis CLI ke dalam AGENTS.md daripada menyebutkannya dalam obrolan. ID skenario yang diketik ke dalam obrolan akan hilang saat sesi berakhir. ID dalam AGENTS.md ada untuk setiap rekan tim dan setiap jalankan Codex mulai sekarang.

Langkah 1: Beri Codex perintah dan lihat ia berjalan

Dengan blok yang sudah ada, mulai Codex di repo Anda:

Codex memuat AGENTS.md saat dimulai, jadi ia sudah tahu CLI ada di sana. Lakukan perubahan yang menyentuh API Anda, atau minta untuk menjalankan pemeriksaan:

Codex mengeluarkan perintah apidog run dari AGENTS.md Anda. Dalam mode Otomatis default, ia dapat membaca file, mengeditnya, dan menjalankan perintah di dalam direktori kerja sendiri, sehingga apidog run biasa biasanya berjalan tanpa perintah. Reporter -r cli mencetak hasil langkah demi langkah dan ringkasan langsung di terminal, tempat Anda melihat setiap permintaan dan pernyataan saat itu terjadi.

Anda ingin melihat eksekusi berjalan dan Codex melaporkan kembali baik ringkasan maupun kode keluar. Jika mode izin Anda adalah Read-only, Codex akan berhenti sejenak dan bertanya sebelum menjalankan; setujui, atau ubah mode dengan /permissions di dalam sesi. Otomatis adalah default yang masuk akal, karena skenario pengujian read-only terhadap staging adalah jenis perintah aman, dalam ruang kerja yang memang dirancang untuk mode itu.

Langkah 2: Pengujian Codex di dalam putarannya sendiri

Intinya adalah apa yang terjadi ketika Anda berhenti bertanya dan Codex menjalankan skenario sendiri karena AGENTS.md menyuruhnya.

Bayangkan Codex mengedit penangan yang membangun respons checkout. Putarannya berubah: ia mengedit kode, lalu, alih-alih menyatakan kemenangan, menjalankan skenario Apidog Anda terhadap staging, membaca kode keluar, dan bertindak berdasarkan itu. Hijau, ia melanjutkan. Merah, ia membuka laporan, membaca pernyataan mana yang gagal (kode status, bidang yang hilang, nilai yang salah), mencoba perbaikan, dan menjalankannya kembali. Tes API menjadi bagian dari putaran edit-tes-perbaiki yang sama yang sudah digunakan Codex untuk menjalankan tes unit Anda. Anda menulis satu instruksi dan Codex memasukkan perintah tersebut ke dalam cara kerjanya yang sudah ada.

Ini adalah model delegasikan-lalu-verifikasi yang membuat alur kerja agen apa pun aman. Codex menjalankan perintah dan membaca hasilnya; Anda terus membuat skenario secara visual di Apidog dan memeriksa apakah agen membaca kode keluar dengan jujur. Untuk pola yang lebih luas, lihat cara menggunakan agen AI untuk pengujian API dan alat uji Apidog AI.

Verifikasi bahwa Codex benar-benar menjalankan CLI

Agen melaporkan keberhasilan yang tidak mereka peroleh, dan Codex tidak terkecuali. Tiga pemeriksaan, berdasarkan seberapa sering mereka menemukan masalah.

Pertama, konfirmasikan apakah perintah tersebut dijalankan sama sekali. Antarmuka Codex menunjukkan perintah yang dijalankan dan outputnya secara in-line. Cari baris literal apidog run ... dan hasilnya di bawahnya. Jika Codex mengatakan telah menjalankan pengujian tetapi Anda tidak melihat perintahnya, itu meringkas sesuatu yang tidak pernah dilakukannya. Minta untuk dijalankan lagi dan tunjukkan output mentah.

Kedua, konfirmasikan kode keluar, yang paling penting:

Berapa kode keluar dari perintah apidog run itu?

apidog run keluar 0 ketika setiap pernyataan lolos dan bukan nol ketika ada yang gagal. Perilaku tunggal itu memungkinkan Codex, atau pipeline, memperlakukan jalannya sebagai gerbang yang bersih. Ketika prosa Codex mengatakan "tes lulus" tetapi kode keluarnya bukan nol, kode keluar adalah yang benar.

Ketiga, konfirmasikan bahwa ia menggunakan skenario yang sebenarnya. Jika eksekusi gagal dengan "skenario tidak ditemukan," Codex mungkin telah membuat atau salah mengingat ID. Periksa kembali nilai -t dan -e terhadap AGENTS.md dan perintah yang dihasilkan Apidog di tab CI/CD. ID di AGENTS.md adalah kebenaran.

Membaca laporan pengujian

Ketika eksekusi menjadi merah, laporan memiliki jawabannya. Dengan -r cli, Codex mendapatkan rincian yang mudah dibaca di terminal: setiap permintaan, setiap pernyataan, dan mana yang gagal dengan nilai yang diharapkan versus nilai aktual. Pernyataan yang gagal menyebutkan bidang atau kode status yang tepat, yang biasanya cukup bagi Codex untuk menemukan perbaikannya.

Untuk laporan yang dapat Anda buka di browser atau berikan kepada rekan kerja, tambahkan reporter HTML

Reporter html menulis file mandiri ke ./apidog-reports. Tetap sertakan cli dalam daftar agar Codex tetap mendapatkan output in-line yang dibacanya untuk memutuskan langkah selanjutnya. Untuk setiap flag dan reporter, termasuk format JUnit yang diurai dasbor CI, lihat panduan lengkap Apidog CLI dan referensi perintah apidog run.

Dua cara untuk melangkah lebih jauh dari perintah shell

Menjalankan apidog run dari AGENTS.md mencakup sebagian besar yang Anda butuhkan. Dua jalur melangkah lebih jauh.

Yang pertama adalah MCP. Codex mendukung Model Context Protocol, dan Anda dapat menambahkan server dengan codex mcp add atau dengan mengedit ~/.codex/config.toml dengan blok [mcp_servers.NAME]. Server MCP Apidog mengekspos spesifikasi API Anda melalui MCP, sehingga Codex dapat membaca skema Anda saat menulis kode, tidak hanya setelah fakta. CLI menjalankan pengujian; MCP memberi agen spesifikasi.

Yang kedua adalah codex exec. Di mana codex biasa membuka antarmuka interaktif, codex exec "..." menjalankan Codex secara non-interaktif dan mengalirkan hasilnya ke stdout, yang Anda butuhkan dalam skrip dan CI. Untuk menjalankan apidog run dalam pipeline tanpa kehadiran Codex, Apidog CLI di GitHub Actions membahas rahasia, reporter, dan gating kode keluar.

Ketika Codex melakukan kesalahan

Beberapa kegagalan sering muncul selama pengaturan.

Ia mengabaikan blok AGENTS.md. Jika Codex menjalankan perintah generik atau tidak sama sekali, blok tersebut mungkin tidak dimuat. Konfirmasikan bahwa nama file persis AGENTS.md dan terletak di root Git Anda atau direktori induk dari direktori saat ini. Kesalahan ketik pada nama file berarti Codex tidak pernah membacanya; memulai ulang sesi akan memaksa pembacaan ulang.

Ia tetap meneruskan token akses. Jika Codex mencoba menambahkan --access-token, itu berarti ia menebak dari contoh publik. Blok tersebut sudah memberitahunya untuk tidak melakukannya, karena mesin sudah diautentikasi melalui apidog login. Tegaskan kembali baris tersebut, dan jangan pernah menempatkan token nyata di AGENTS.md.

Ia menciptakan flag. Kesalahan "unknown option" berarti Codex menebak flag yang tidak dimiliki versi Anda. Beri tahu ia untuk menjalankan apidog run --help dan salin flag yang tepat dari sana, yang selalu benar untuk versi yang terinstal.

Ia melaporkan kelulusan pada eksekusi yang gagal. Yang paling mahal, dan alasan aturan kode keluar ada di AGENTS.md Anda dan langkah verifikasi Anda. Ketika ringkasan dan kode keluar tidak sesuai, kode keluar adalah yang benar.

Dari agen harian ke putaran yang teruji

Itulah pengaturannya. Instal apidog-cli sekali dengan mengikuti panduan instalasi, tambahkan blok Apidog singkat ke AGENTS.md repo Anda, dan Codex tahu cara menjalankan tes API Anda dan membaca hasilnya di dalam putaran yang sama yang sudah digunakannya untuk mengedit kode. Titik akhir yang rusak akan terdeteksi saat Codex masih mengerjakan perubahan, bukan setelah dikirim.

Sebuah tes di balik GUI berjalan saat manusia mengklik; perintah satu baris berjalan kapan pun Codex memutuskan. Anda terus membangun skenario secara visual di Apidog, dan agen Anda menjalankannya di tempat yang tidak Anda pantau. Unduh Apidog, buat satu skenario, masukkan perintah apidog run-nya ke dalam AGENTS.md, dan saksikan Codex mengambilnya pada perubahan berikutnya.

button

Mengembangkan API dengan Apidog

Apidog adalah alat pengembangan API yang membantu Anda mengembangkan API dengan lebih mudah dan efisien.