Ruang kerja API Anda terdapat di GUI. Hari kerja Anda ada di terminal. Setiap perpindahan konteks antara keduanya memakan waktu dan fokus, dan dalam CI pipeline atau sesi agen AI, GUI bahkan bukan pilihan. Apidog CLI menutup celah itu: ia membawa seluruh platform Apidog, pengujian, endpoint, skema, lingkungan, ekspektasi mock, dan dokumen, ke shell prompt yang sudah Anda buka.
Satu definisi jujur sebelum yang lainnya. Apidog CLI bukanlah curl lain. Jika Anda ingin melakukan GET satu kali dan melihat JSON secara sekilas, curl dan HTTPie sudah melakukannya dengan baik, dan rangkuman terminal dan klien REST TUI mencakup sisi interaktifnya. Apidog CLI adalah klien untuk ruang kerja API Anda sendiri: ia menjalankan skenario pengujian yang telah Anda buat, membaca dan memperbarui kontrak API, serta memindahkan spesifikasi masuk dan keluar dari proyek, semuanya dari perintah yang dapat dipanggil oleh skrip atau agen.
Apa arti "ada di terminal Anda" di sini
Alat HTTP terminal menangani satu permintaan pada satu waktu. Apidog CLI beroperasi pada tingkat proyek. Permukaan perintahnya mencakup lebih dari empat puluh grup, dan mereka terkelompok menjadi lima tugas:
| Tugas | Perintah |
|---|---|
| Jalankan pengujian | run, test-scenario, test-suite, test-case, test-data, test-report |
| Kelola kontrak | endpoint, schema, folder, common-parameter, response-component, security-scheme |
| Kirim dokumen dan mock | doc, docs-site, shared-doc, mock |
| Konfigurasi dan sambungkan | environment, variables, vault, database-connection, websocket, socketio |
| Beroperasi sebagai tim | branch, merge-request, runner, scheduled-task, audit-log, import, export |
Setiap perintah mendukung --help, outputnya adalah JSON terstruktur, dan sebagian besar respons menyertakan agentHints.nextSteps yang memberi tahu Anda (atau agen Anda) apa yang harus dijalankan selanjutnya. Detail terakhir itu terdengar kecil. Ini mengubah bagaimana alat itu terasa: CLI memandu alur kerja daripada berasumsi Anda telah menghafalnya.
Instal dalam satu perintah
CLI dikirim sebagai paket npm (apidog-cli) dan berjalan di macOS, Linux, dan Windows. Ini membutuhkan Node.js 16 atau yang lebih baru.
npm install -g apidog-cli
apidog --version
Kemudian masuk dengan token akses API. Ambil dari aplikasi Apidog: klik avatar Anda, buka Pengaturan Akun, dan salin token di bawah Token Akses API.
apidog login --with-token <YOUR_TOKEN>
Token tersimpan di ~/.apidog/config.toml, jadi jauhkan dari repositori dan log Anda; di CI, lewatkan per-run dengan --access-token dari rahasia sebagai gantinya. Empat flag global mencakup sebagian besar konteks: --project memilih proyek, --branch memilih cabang, --access-token menimpa login yang tersimpan, dan --api-base-url mengarahkan CLI ke deployment Apidog yang di-hosting sendiri. Panduan autentikasi Apidog CLI menjelaskan token untuk CI secara rinci.
Jalankan pengujian yang Anda buat secara visual
Ini adalah alur kerja yang mendasari pembangunan CLI. Anda membuat skenario pengujian di editor visual Apidog: permintaan berantai, variabel yang diekstraksi dari satu respons dan disuntikkan ke yang berikutnya, pernyataan tentang status dan body. Kemudian Anda menjalankannya di mana pun shell tersedia.
# Salin perintah ini, termasuk ID, dari tab CI/CD skenario
apidog run -t <scenario_id> -e <env_id> -r cli
Perintah keluar dengan kode `0` ketika setiap pernyataan berhasil dan kode bukan nol ketika ada yang gagal, sehingga pipeline bergantung padanya tanpa tambahan apa pun. Ganti -e untuk mengarahkan skenario yang sama ke lingkungan dev, staging, atau produksi. Berikan file CSV atau JSON dan ia akan mengulang skenario di setiap baris, begitulah cara pengujian berbasis data bekerja tanpa menduplikasi langkah-langkah. Jika Anda memulai dari nol, panduan langkah demi langkah REST API membawa Anda dari instalasi hingga eksekusi hijau pertama.
Laporan keluar dalam empat format: cli mencetak hasil langkah demi langkah ke terminal, sementara html, json, dan junit tersimpan di apidog-reports/ untuk dashboard dan artefak CI. Gabungkan secara bebas, seperti pada -r cli,junit. Panduan laporan pengujian menunjukkan seperti apa setiap format.
Untuk eksekusi yang tidak boleh bergantung pada laptop Anda, perintah runner dan scheduled-task mengelola runner yang di-hosting sendiri dan eksekusi terjadwal, mesin yang sama di balik pengujian API terjadwal di Apidog.
Kelola kontrak API tanpa membuka aplikasi
Ini adalah bagian yang tidak dibawa oleh alat pengujian terminal lainnya. CLI yang sama yang menjalankan pengujian Anda dapat membaca dan menulis definisi API itu sendiri:
apidog endpoint list --project <project_id>
apidog schema get <schema_id>
apidog environment list
apidog mock list
Endpoint, skema data, folder, lingkungan, variabel, skema keamanan, dan komponen yang dapat digunakan kembali semuanya dapat ditanyakan dan diedit. Perintah mock mengelola ekspektasi mock, yaitu pasangan permintaan-dan-respons tetap yang dikembalikan oleh server mock Anda. Perintah doc dan docs-site mengelola dokumentasi yang dipublikasikan. Endpoint WebSocket dan Socket.IO memiliki grup sendiri, dan database-connection mencakup konfigurasi database yang dibaca oleh skenario pengujian Anda.
Impor dan ekspor mendukung format-format penting: OpenAPI 3.x dan Swagger 2.0 (spesifikasi yang distandarisasi oleh sebagian besar toolchain), ditambah koleksi Postman. Itu menjadikan CLI jembatan dalam skrip migrasi: tarik spesifikasi dari satu sistem, dorong ke Apidog, dan versi seluruh pertukaran.
apidog import openapi.json --project <project_id>
apidog export --format openapi
Dibangun agar agen AI dapat menggunakannya
Rilis CLI tahun 2026 sangat menekankan satu ide: agen pengkodean AI harus dapat mengoperasikan ruang kerja API Anda seaman manusia. Empat bagian membuat hal itu berhasil.
Pertama, output terstruktur. Setiap perintah mengembalikan JSON yang dapat diurai oleh agen, dan agentHints.nextSteps memberi tahu apa yang harus dilakukan setelah setiap hasil, termasuk cara memulihkan dari kesalahan.
Kedua, skema input yang dipublikasikan. apidog cli-schema list dan apidog cli-schema get mengekspos bentuk JSON persis yang diharapkan setiap perintah tulis, dan apidog cli-schema validate memeriksa payload sebelum ada yang menyentuh proyek. Ritual penulisan aman selalu sama: dapatkan skema, buat JSON, validasi, dan baru kemudian jalankan create atau update.
Ketiga, skill yang terkemas. Perintah skill mengirimkan pengetahuan operasional CLI dalam bentuk yang dapat dimuat langsung oleh agen, itulah kisah di balik mengapa kami membangun skill Apidog CLI. Dalam pengukuran kami sendiri, agen yang bekerja melalui skema CLI menggunakan sekitar 30% lebih sedikit panggilan alat dan 25% lebih sedikit token daripada agen yang menebak-nebak payload; angka-angkanya diuraikan dalam analisis ini.
Keempat, gerbang izin. Secara default, penulisan yang bersumber dari AI ke cabang diblokir hingga manusia mengaktifkan Izin Edit AI Eksternal (di klien Apidog 2.8.32 atau lebih baru, di bawah Pengaturan Proyek, Pengaturan Fitur, Pengaturan Fitur AI). Alternatifnya adalah cabang AI: cabang terisolasi tempat agen mengimpor sumber daya yang dibutuhkannya, membuat editnya, dan mengembalikan hasilnya sebagai permintaan penggabungan untuk ditinjau. Cabang AI yang tidak tersentuh akan otomatis diarsipkan setelah 24 jam, sehingga eksperimen tidak menumpuk. Kontrak API Anda tetap dapat ditinjau bahkan ketika agen yang menulis draf pertama.
Apa yang bukan Apidog CLI
Tiga batasan, dinyatakan dengan jelas, karena memilih alat berdasarkan informasi jujur lebih baik daripada menemukan celahnya nanti.
Ini bukan klien permintaan interaktif. Tidak ada perintah yang mengetik POST ad-hoc dan mencetak respons dengan indah; curl, HTTPie, dan klien TUI memiliki pekerjaan itu, dan mereka lebih baik dalam hal itu.
Ini bukan sumber terbuka. Paketnya adalah proprietary, npm adalah satu-satunya saluran instalasi, dan melakukan apa pun di luar --help memerlukan akun Apidog. Tingkat gratis mencakup seluruh alur kerja yang dijelaskan di sini, tetapi jika lisensi yang dapat diaudit adalah persyaratan wajib, runner sumber terbuka adalah rekomendasi yang jujur.
Ini tidak berdiri sendiri. CLI adalah bagian terminal dari platform: skenario, endpoint, dan lingkungan berada di proyek Apidog Anda, bukan di file lokal. Itulah kompromi yang memberi Anda satu sumber kebenaran di seluruh desain, pengujian, mocking, dan dokumen.
Di mana ia cocok dalam kotak alat terminal
Dibandingkan dengan runner lain, perbedaannya terletak pada tempat penulisan terjadi. Newman dan Postman CLI menjalankan koleksi yang dibuat di Postman; Hurl dan Bruno menjalankan pengujian yang dibuat sebagai file teks; Apidog CLI menjalankan skenario yang dibuat di editor visual yang juga menyimpan kontrak, mock, dan dokumen Anda. Perbandingan Apidog CLI vs Newman membahas lebih dalam, dan keseluruhan bidang diurutkan dalam rangkuman alat pengujian API berbasis terminal teratas.
Pengaturan kerja untuk sebagian besar tim: pertahankan curl atau xh dalam memori otot untuk 'pokes', dan biarkan apidog run membawa suite dalam CI. Panduan GitHub Actions memiliki pipeline siap pakai untuk memulai.
FAQ
Apakah Apidog CLI gratis digunakan? Ya. Paket ini diinstal gratis dari npm, dan tingkat gratis Apidog mencakup pembuatan skenario dan menjalankannya melalui CLI. Paket berbayar menambahkan fitur skala tim, bukan akses CLI dasar.
Apakah ini menggantikan curl atau HTTPie? Tidak, dan tidak berusaha untuk itu. Alat-alat itu mengirim permintaan ad-hoc; Apidog CLI menjalankan skenario pengujian yang disimpan dan mengelola sumber daya proyek. Kebanyakan terminal akhirnya memiliki keduanya.
Bisakah itu berjalan sepenuhnya tanpa kepala di CI? Ya. Autentikasi dengan --access-token dari rahasia CI, jalankan apidog run dengan ID skenario Anda, dan atur build berdasarkan kode keluar. Tidak diperlukan aplikasi desktop di runner.
Format apa saja yang bisa diimpor dan diekspor? OpenAPI 3.x, Swagger 2.0, dan koleksi Postman, dalam kedua arah. Itu mencakup migrasi masuk dan integrasi keluar.
Bagaimana agen AI menggunakannya dengan aman? Melalui ritual skema-validasi-tulis dan gerbang izin: cli-schema validate menangkap payload yang salah sebelum tersimpan, dan cabang AI menjaga editan agen tetap terisolasi hingga manusia menggabungkannya. Lihat cara kerjanya di dalam agen di cara menggunakan Apidog CLI di Claude Code.
Terminal adalah tempat di mana pengujian Anda sudah berjalan dan di mana agen Anda sudah bekerja. Menempatkan klien API di sana juga menghilangkan perpindahan konteks terakhir. Unduh Apidog, instal CLI dari npm, dan jalankan satu skenario dari awal hingga akhir; halaman Apidog CLI memiliki referensi perintah lengkap ketika Anda siap untuk melampaui run.