Cara Menggunakan Apidog CLI di Hermes Agent

Hermes Agent berjalan dari terminal Anda, mengingat apa yang dipelajarinya lintas sesi, dan menggunakan perintah shell nyata untuk menyelesaikan pekerjaan. Bagian terakhir adalah pembukanya: jika dapat menjalankan perintah, ia dapat menjalankan pengujian API Anda.

Runner yang menghubungkan keduanya adalah Apidog CLI, sebuah paket npm bernama apidog-cli. Ini menjalankan skenario pengujian yang Anda bangun secara visual di Apidog langsung dari terminal dan keluar dengan kode status yang dapat ditindaklanjuti oleh Hermes. Panduan ini mencakup setengah bagian spesifik Hermes: alat terminal yang menjalankan perintah, file konteks yang mengajarkan alur kerja Anda kepada Hermes, bagaimana eksekusi masuk ke dalam lingkarannya, dan server Apidog MCP opsional yang menyerahkan spesifikasi API Anda kepada Hermes saat ia bekerja.

Jika CLI belum terinstal, mulailah dengan cara menginstal Apidog CLI dengan agen pengkodean AI, yang memandu agen melalui instalasi dan otentikasi. Kembali setelah apidog --version mencetak nomor. Anda juga memerlukan akun Apidog dengan setidaknya satu skenario pengujian yang tersimpan; unduh Apidog jika Anda belum memilikinya.

button

Apa arti “menggunakan CLI di Hermes”

Hermes Agent, yang dibangun oleh Nous Research, berjalan di terminal Anda, berbicara dengan model AI Anda, dan bertindak melalui alat bawaan. Yang penting di sini adalah alat terminal: Hermes menjalankan perintah shell dengan memanggilnya di direktori kerja Anda, lalu membaca kembali keluarannya ke dalam penalarannya. Tidak ada plugin Apidog yang perlu diinstal, dan Anda tidak memerlukannya. Menggunakan Apidog CLI di Hermes berarti tiga hal:

Ajarkan alur kerja Hermes sekali dengan menuliskannya ke dalam file konteks yang dimuat Hermes saat startup, sehingga ia mengetahui perintah, flag, dan bahwa kode keluar adalah sumber kebenaran.
Minta Hermes menjalankan apidog run melalui alat terminal, seperti perintah lainnya.
Secara opsional sambungkan server Apidog MCP, sehingga Hermes dapat membaca spesifikasi API Anda saat ia menulis kode yang diuji oleh pengujian tersebut.

File konteks inilah yang membuat ini berbentuk Hermes, bukan panduan "buka terminal dan ketik" yang umum, mengubah "jalankan pengujian saya" yang hanya sekali pakai menjadi sesuatu yang ia gunakan sendiri.

Mekanisme: file konteks, bukan pengingat obrolan

Hermes memuat konteks proyek di awal sesi. Mesin konteksnya memindai direktori kerja Anda untuk mencari file instruksi, termasuk CLAUDE.md dan AGENTS.md, dan menyuntikkannya ke dalam prompt sistem. Itu konvensi yang sama yang digunakan Claude Code dan Codex, jadi jika repo Anda sudah memiliki AGENTS.md, Hermes juga membacanya.

Inilah mengapa Anda menulis CLI ke dalam file konteks alih-alih menyebutkannya dalam obrolan. ID skenario yang diketik ke dalam sesi akan hilang saat sesi berakhir; ID yang ada di AGENTS.md akan ada untuk setiap rekan tim dan setiap eksekusi Hermes mulai sekarang. (Hermes juga membaca SOUL.md, tapi itu untuk persona agen, bukan proyek Anda. Simpan instruksi pengujian di AGENTS.md.)

Langkah 1: Tambahkan blok Apidog ke file konteks Anda

Buka AGENTS.md di root repositori Anda, atau buatlah, dan tambahkan bagian yang memberi tahu Hermes bahwa CLI ada, cara menjalankannya, dan cara membaca hasilnya. Berikan perintah dan ID yang sebenarnya, bukan deskripsi.

## Pengujian API dengan Apidog CLI

Repo ini menggunakan Apidog CLI (`apidog-cli`, perintah `apidog`) untuk menjalankan
skenario pengujian API. Skenario-skenario ini ada di proyek Apidog kita,
bukan di repo ini.

Saat Anda mengubah handler API, rute, atau bentuk respons, jalankan
skenario Apidog yang relevan melalui alat terminal sebelum menganggap
perubahan selesai:

    apidog run -t 605067 -e 1629989 -n 1 -r cli

- `-t 605067` adalah skenario pengujian checkout-flow.
- `-e 1629989` adalah environment staging.
- Mesin sudah terautentikasi melalui `apidog login`, jadi JANGAN lewatkan
  token akses dan JANGAN mencetaknya.

Perlakukan kode keluar sebagai sumber kebenaran: `0` berarti setiap
assertion berhasil, non-nol berarti kegagalan. Jika keluar non-nol, baca
assertion yang gagal dalam laporan dan perbaiki kodenya, lalu jalankan
ulang. Jangan melaporkan berhasil jika keluar non-nol.

Ganti 605067 dengan ID skenario asli Anda dan 1629989 dengan lingkungan yang harus diakses Hermes selama pekerjaan normal, biasanya staging atau pengembangan lokal, jangan pernah produksi. Untuk mendapatkan ID yang benar, salin perintah apidog run yang dihasilkan Apidog di tab CI/CD skenario (akan dibahas selanjutnya), dan hilangkan token akses sebelum menempelkannya, karena mesin sudah login dan token tidak boleh ada dalam file yang dikomit.

Dua hal membuat blok ini berfungsi. Ia menamai perintah dengan tepat, sehingga Hermes tidak menebak-nebak flag. Dan ia menyatakan aturan lulus/gagal dalam bahasa yang jelas, sehingga Hermes tahu bahwa kode keluar mengalahkan ringkasannya sendiri, yang menyelamatkan Anda dari kegagalan agen yang paling umum: "pengujian berhasil" yang meyakinkan di atas eksekusi merah.

Langkah 2: Dapatkan perintah dari Apidog

Dapatkan perintah yang sudah teruji baik sebelum Anda meminta Hermes untuk menjalankan apa pun. Buka skenario Anda di Apidog, beralih ke tab CI/CD-nya, dan pilih opsi baris perintah. Apidog membangun perintah apidog run lengkap dengan ID dan token akses yang sudah terisi:

apidog run --access-token YOUR_ACCESS_TOKEN -t 605067 -e 1629989 -n 1 -r cli

605067 adalah ID skenario dan 1629989 adalah ID lingkungan; milik Anda akan berbeda. Karena Anda telah mengautentikasi CLI selama instalasi, hilangkan bagian --access-token dan simpan ID-nya. Itulah perintah yang file konteks Anda perintahkan kepada Hermes untuk digunakan.

Langkah 3: Minta Hermes menjalankan pengujian

Mulai Hermes di repo Anda, lalu minta untuk menjalankan pemeriksaan. Dengan blok yang sudah ada, prompt-nya singkat:

Jalankan skenario pengujian API Apidog kita seperti yang dijelaskan AGENTS.md. Saya sudah terautentikasi, jadi jangan berikan token akses. Gunakan apidog run -t 605067 -e 1629989 -n 1 -r cli. Tunjukkan output lengkapnya dan beri tahu kode keluarnya.

Hermes memanggil alat terminal-nya untuk menjalankan perintah di direktori kerja Anda, dan reporter -r cli mengalirkan hasil langkah demi langkah kembali ke konteksnya, di mana Anda dapat melihat setiap permintaan dan assertion. Karena Hermes mengarahkan perintah melalui lapisan persetujuan, Anda mungkin melihat prompt sebelum dijalankan, tergantung pada konfigurasi Anda. Skenario pengujian read-only terhadap staging adalah jenis perintah yang aman dan dalam ruang kerja yang boleh diizinkan.

Pemeriksaan Anda: lihat kode keluar, bukan ringkasannya. apidog run keluar 0 ketika setiap assertion berhasil dan non-nol ketika salah satunya gagal. Perilaku itulah alasan mengapa ini berfungsi sebagai gerbang, untuk CI dan untuk Hermes. Jika Hermes mengatakan "pengujian berhasil" tetapi kode keluar non-nol, itu salah; percayai kodenya. Ini adalah kegagalan yang dicegah oleh blok Langkah 1.

Untuk format laporan yang berbeda atau lebih banyak iterasi, minta Hermes menjalankan apidog run --help agar ia membaca daftar flag yang sebenarnya. Panduan Apidog CLI lengkap mendokumentasikan setiap flag, termasuk reporter html, json, dan junit.

Langkah 4: Pengujian Hermes dalam lingkarannya sendiri

Intinya adalah apa yang terjadi ketika Anda berhenti bertanya dan Hermes menjalankan skenario sendiri karena AGENTS.md memerintahkannya. Bayangkan ia mengedit handler yang membangun respons checkout: ia mengedit kode, menjalankan skenario Apidog Anda terhadap staging melalui alat terminal, membaca kode keluar, dan bertindak berdasarkan itu. Hijau, ia melanjutkan. Merah, ia membuka laporan, membaca assertion mana yang gagal (kode status, bidang yang hilang, nilai yang salah), mencoba perbaikan, dan menjalankan ulang. Pengujian API menjadi bagian dari siklus edit-uji-perbaiki yang sama dengan yang sudah ia jalankan untuk pengujian unit Anda. Anda menulis satu instruksi dan ia melipat perintah itu ke dalam cara kerjanya yang sudah ada.

Ini adalah model delegasikan-lalu-verifikasi yang membuat alur kerja agen mana pun aman. Hermes menjalankan perintah dan membaca hasilnya; Anda terus membuat skenario di Apidog dan memeriksa bahwa ia membaca kode keluar dengan jujur. Untuk eksekusi yang lambat, folder besar, atau jumlah iterasi tinggi, alat terminal memiliki flag background=true, sehingga Hermes dapat meluncurkan proses, terus bekerja, dan memeriksa kode keluar alih-alih memblokir. Untuk pola yang lebih luas, lihat cara menggunakan agen AI untuk pengujian API dan alat pengujian AI Apidog.

Opsional: Sambungkan server Apidog MCP

CLI memungkinkan Hermes menjalankan pengujian Anda; server Apidog MCP memungkinkannya membaca spesifikasi API Anda saat ia menulis kode. Keduanya saling melengkapi: MCP memberi Hermes skema Anda sehingga ia menghasilkan kode yang sesuai dengan kontrak, dan CLI memverifikasi kode tersebut terhadap skenario nyata.

Hermes mendukung Model Context Protocol (MCP) secara langsung. Edit ~/.hermes/config.yaml dan tambahkan entri di bawah bagian mcp_servers. Untuk server stdio lokal seperti Apidog, itu adalah command, array args, dan nilai env apa pun:

mcp_servers:
  apidog:
    command: "npx"
    args: ["-y", "apidog-mcp-server@latest", "--project=YOUR_PROJECT_ID"]
    env:
      APIDOG_ACCESS_TOKEN: "YOUR_ACCESS_TOKEN"

Setelah menyimpan, jalankan /reload-mcp di dalam Hermes, atau restart. Hermes menemukan server MCP saat startup dan mendaftarkan alat-alatnya ke registri normalnya, dengan namespace mcp_apidog_<tool>, sehingga agen menggunakannya selama penalaran normal. Untuk pengaturan lengkap, termasuk ID proyek dan token, lihat panduan server Apidog MCP. Untuk versi paket dari loop ini, lihat panduan Apidog CLI dengan Claude Skills.

Dari loop lokal ke CI

Setelah Hermes menjalankan skenario secara lokal dan bertindak berdasarkan kode keluar, Anda telah memvalidasi perintah persis yang akan digunakan oleh pipeline Anda. Lompatan ke CI kecil: apidog run yang sama, dengan token diteruskan sebagai rahasia tersembunyi alih-alih login yang tersimpan. Minta Hermes untuk menulis langkahnya, karena ia mengetahui perintah dari file konteks Anda:

Tulis langkah GitHub Actions yang menginstal apidog-cli dan menjalankan apidog run -t 605067 -e 1629989 -r junit, membaca token akses dari rahasia repositori bernama APIDOG_ACCESS_TOKEN.

Mekanika langkah itu (rahasia, reporter, pembatasan kode keluar) ada di Apidog CLI di GitHub Actions. Perintah yang sama kemudian berjalan di tiga tempat, terminal Anda, loop Hermes, dan CI, semuanya dengan satu kode keluar.

Hambatan umum

Hermes mengabaikan blok konteks. Jika ia menjalankan perintah generik atau tidak sama sekali, pastikan nama file persis AGENTS.md (atau CLAUDE.md) dan berada di direktori tempat Hermes dimulai. Memulai ulang sesi akan memaksa pembacaan ulang.

Ia hanya menyarankan perintah daripada menjalankannya. Hermes menjalankan perintah melalui alat terminal di balik lapisan persetujuan. Setujui eksekusi yang tertunda; jika konfigurasi Anda menolak perintah terminal, longgarkan izin untuk apidog run.

apidog whoami menunjukkan Anda tidak terautentikasi. Login disimpan di mesin Anda, bukan di Hermes. Jalankan apidog login --with-token sendiri dengan token baru, lalu minta Hermes untuk mengonfirmasi dengan apidog whoami. Jaga agar token tidak masuk ke obrolan.

Ia menciptakan flag. Kesalahan "unknown option" berarti Hermes menebak flag yang tidak ada dalam versi Anda. Minta ia menjalankan apidog run --help dan salin flag yang benar.

Ia melaporkan berhasil pada eksekusi yang gagal. Yang paling mahal, dan alasan aturan kode keluar ada di AGENTS.md dan pemeriksaan manual Anda. Ketika prosa dan kode tidak sesuai, percayai kodenya.

Ringkasan

Pengaturan Hermes adalah satu file dan satu kebiasaan: blok AGENTS.md yang mengunci perintah, sumber otentikasi, dan aturan kode keluar, ditambah kebiasaan membiarkan Hermes menjalankan apidog run melalui alat terminal-nya dan memeriksa kode keluar sendiri. Tambahkan server Apidog MCP melalui ~/.hermes/config.yaml dan ia juga dapat membaca spesifikasi Anda saat mengkode.

Anda terus membuat skenario secara visual di Apidog; Hermes hanya menjalankannya. Dari sini, arahkan perintah yang sama ke pipeline Anda dengan Apidog CLI di GitHub Actions, atau baca referensi flag lengkap di panduan lengkap.

Pertanyaan yang Sering Diajukan

Apakah saya memerlukan plugin Hermes untuk menggunakan Apidog CLI?

Tidak. Hermes menjalankan perintah shell melalui alat terminal-nya, jadi ia memanggil apidog run secara langsung. Satu-satunya pengaturan khusus Hermes adalah blok AGENTS.md, ditambah server MCP opsional.

Di mana saya harus meletakkan instruksi yang mengajarkan alur kerja kepada Hermes?

Dalam file konteks yang dimuat Hermes saat startup. Mesin konteksnya memindai direktori kerja untuk mencari file seperti AGENTS.md dan CLAUDE.md dan menyuntikkannya ke dalam prompt sistem. Letakkan blok Apidog Anda di AGENTS.md di root repo dan setiap sesi di repo itu akan membacanya.

Bagaimana cara memastikan Hermes tidak memalsukan pengujian yang berhasil?

Minta ia melaporkan kode keluar, bukan hanya ringkasan, dan periksa kode itu sendiri. apidog run keluar 0 hanya ketika setiap assertion berhasil. Ketika tulisan dan kode tidak sesuai, percayai kodenya.

Bagaimana cara menghubungkan server Apidog MCP ke Hermes?

Tambahkan entri mcp_servers ke ~/.hermes/config.yaml dengan perintah apidog-mcp-server dan ID proyek Anda, lalu jalankan /reload-mcp atau mulai ulang Hermes. Ia menemukan server saat startup dan mendaftarkan alat-alatnya. Panduan server Apidog MCP mencakup ID proyek dan token.

Apakah ini bekerja sama di agen pengkodean AI lainnya?

CLI sama di mana-mana; hanya cara Anda mengajar agen yang berbeda. Hermes membaca AGENTS.md dan menjalankan perintah melalui alat terminal-nya; agen lain menggunakan file instruksi mereka sendiri. Instalasi dan otentikasi identik, jadi panduan instalasi berlaku untuk agen mana pun.