Cara Menggunakan Apidog CLI di Cline

Cline bekerja dalam sebuah siklus: merencanakan perubahan, mengedit file, menjalankan perintah, membaca output, lalu menentukan langkah berikutnya. Agar pengujian API masuk ke siklus tersebut, jalankan skenario Apidog dari terminal dengan apidog-cli, bukan dari GUI. Dengan begitu, Cline dapat menjalankan tes, memeriksa kode keluar, dan memperbaiki perubahan yang gagal.

Coba Apidog hari ini

Sebelum melanjutkan, pastikan CLI sudah tersedia dan akun Anda sudah diautentikasi:

apidog --version

Jika belum, ikuti panduan instalasi Apidog CLI dengan agen pengkodean AI. Panduan tersebut mencakup instalasi npm, autentikasi, dan eksekusi pertama.

Cline yang dimaksud

Cline adalah agen pengkodean sumber terbuka yang tersedia sebagai ekstensi VS Code, dengan build JetBrains dan CLI. Cline dapat membaca repositori, membuat rencana pada mode Plan, lalu mengedit file dan menjalankan perintah pada mode Act.

Agar Cline selalu mengetahui cara menjalankan tes API proyek Anda, gunakan aturan proyek di direktori .clinerules/. Aturan ini akan dimuat setiap kali Cline memulai tugas baru.

Untuk dasar instalasi dan pemilihan model, lihat cara menggunakan Cline.

Langkah 1: Tambahkan aturan Apidog ke .clinerules/

Buat direktori dan file aturan di root repositori:

mkdir -p .clinerules
touch .clinerules/apidog.md

Isi .clinerules/apidog.md dengan aturan berikut:

# API testing with Apidog

- To test the API, run the Apidog CLI, not curl or ad-hoc scripts.
- Command: apidog run -t <scenario_id> -e <env_id> -r cli
- The scenario ID and environment ID come from Apidog's CI/CD tab. Use those exact values.
- Exit code 0 means every assertion passed. Non-zero means a failure; the exit code is the source of truth, not your summary.
- The machine is already authenticated via `apidog login`. Never add --access-token and never put a token in this file.
- If a flag is unknown, run `apidog run --help` and use the exact flag from there.

Gunakan direktori .clinerules/, bukan instruksi sekali pakai di chat. File aturan:

• dimuat untuk tugas Cline berikutnya;
• dapat dibagikan melalui Git;
• menjaga ID skenario dan lingkungan tetap konsisten;
• mencegah agen menebak perintah atau flag.

Cline membaca file .md dan .txt dari direktori ini. Detailnya tersedia pada referensi aturan Cline.

Langkah 2: Salin perintah yang benar dari Apidog

Jangan menebak ID skenario atau ID lingkungan.

1. Buka skenario pengujian di Apidog.
2. Buka tab CI/CD.
3. Salin perintah apidog run yang dihasilkan.
4. Tempel nilai ID tersebut ke .clinerules/apidog.md.

Contoh:

apidog run -t 8291 -e 42 -r cli

Pada perintah tersebut:

• -t 8291 adalah ID skenario pengujian;
• -e 42 adalah ID lingkungan;
• -r cli mencetak hasil ke terminal agar dapat dibaca Cline.

Untuk daftar flag, lihat referensi perintah apidog run.

Langkah 3: Minta Cline menjalankan pengujian

Setelah aturan tersedia, mulai tugas baru di Cline dan gunakan prompt seperti ini:

Jalankan skenario tes Apidog dan beritahu saya hasilnya.

Cline seharusnya menjalankan perintah dari aturan proyek:

apidog run -t 8291 -e 42 -r cli

Persetujuan eksekusi bergantung pada konfigurasi Cline Anda. Jika perintah aman belum diizinkan otomatis, Cline akan meminta persetujuan sebelum menjalankannya.

Untuk alur yang lebih lancar pada tes staging hanya-baca, aktifkan persetujuan otomatis untuk execute-safe-commands bila sesuai dengan kebijakan tim Anda.

Langkah 4: Gunakan output CLI untuk memperbaiki kegagalan

Reporter cli menampilkan detail eksekusi langsung di terminal, termasuk:

• permintaan yang dijalankan;
• assertion yang diperiksa;
• assertion yang gagal;
• nilai yang diharapkan dan nilai aktual;
• ringkasan hasil eksekusi.

Cline dapat menggunakan output tersebut untuk menentukan perubahan berikutnya. Misalnya, jika assertion kode status gagal, Cline dapat memeriksa handler terkait, memperbaiki respons, lalu menjalankan skenario kembali.

Untuk menghasilkan laporan HTML sekaligus mempertahankan output terminal, gunakan dua reporter:

apidog run -t 8291 -e 42 -r cli,html

Reporter html menulis laporan mandiri ke:

./apidog-reports

Tetap gunakan cli agar Cline dapat membaca hasil inline saat menjalankan tugas.

Lihat juga:

• panduan lengkap Apidog CLI
• panduan laporan pengujian Apidog CLI

Masukkan pengujian API ke siklus edit–uji–perbaiki

Dengan aturan tersebut, Cline dapat mengikuti alur berikut saat mengubah endpoint:

1. Mengedit handler, service, atau schema respons.
2. Menjalankan apidog run.
3. Membaca kode keluar dan assertion yang gagal.
4. Memperbaiki kode jika hasilnya gagal.
5. Menjalankan skenario kembali.

Kode keluar adalah sumber kebenaran:

• 0: seluruh assertion lulus;
• selain 0: terdapat kegagalan.

Jangan hanya mengandalkan ringkasan bahasa alami dari agen. Jika Cline menyatakan tes berhasil tetapi proses mengembalikan kode keluar non-nol, eksekusi tersebut tetap gagal.

Untuk pola penggunaan agen yang lebih luas, lihat:

• cara menggunakan agen AI untuk pengujian API
• perangkat uji Apidog AI

Verifikasi bahwa Cline benar-benar menjalankan CLI

Gunakan tiga pemeriksaan berikut.

1. Pastikan perintah muncul di output

Di panel tugas Cline, cari perintah literal seperti:

apidog run -t 8291 -e 42 -r cli

Jika Cline mengklaim sudah menjalankan tes tetapi tidak ada perintah atau output mentahnya, minta Cline untuk menjalankannya ulang dan menampilkan output terminal.

2. Tanyakan kode keluarnya

Gunakan prompt berikut:

Berapa kode keluar dari perintah apidog run itu?

Kode keluar lebih penting daripada ringkasan agen. Pipeline CI dan Cline sama-sama dapat memakai nilai ini sebagai gerbang hasil pengujian.

3. Pastikan ID skenario dan lingkungan benar

Jika muncul error seperti “scenario not found”, periksa kembali:

• nilai -t;
• nilai -e;
• isi .clinerules/apidog.md;
• perintah yang dihasilkan pada tab CI/CD di Apidog.

Jangan biarkan Cline membuat atau mengingat ID secara manual.

Opsional: Hubungkan server Apidog MCP

apidog run sudah cukup untuk menjalankan pengujian. Namun, Anda dapat memberi Cline konteks tambahan dengan server Apidog MCP.

Di ekstensi VS Code:

1. Buka panel Cline.
2. Klik ikon MCP Servers.
3. Pilih Configure.
4. Buka cline_mcp_settings.json.
5. Tambahkan server di bawah objek mcpServers.

Cline juga menyediakan MCP Marketplace untuk instalasi server tanpa mengedit JSON secara manual. Lihat dokumentasi Cline MCP.

Server Apidog MCP dapat mengekspos spesifikasi API melalui MCP. Dengan itu, Cline dapat membaca schema API ketika menulis kode, sementara CLI tetap digunakan untuk menjalankan tes.

Untuk menjalankan Apidog CLI tanpa Cline di pipeline CI/CD, lihat:

• Apidog CLI di GitHub Actions
• panduan pipeline CI/CD Apidog CLI

Troubleshooting

Cline mengabaikan file aturan

Pastikan:

• direktori bernama tepat .clinerules;
• direktori berada di root workspace;
• file aturan menggunakan ekstensi .md atau .txt;
• Anda memulai tugas Cline baru setelah mengubah aturan.

Cline menambahkan --access-token

Jangan simpan token di .clinerules/. Jika mesin sudah diautentikasi dengan:

apidog login

perkuat aturan berikut:

Never add --access-token and never put a token in this file.

Untuk detail autentikasi, baca panduan autentikasi Apidog CLI.

Cline membuat flag yang tidak tersedia

Jika muncul error “unknown option”, jalankan:

apidog run --help

Lalu gunakan flag yang benar-benar tersedia pada versi CLI yang terinstal.

Cline melaporkan sukses untuk eksekusi gagal

Kembalikan pemeriksaan ke kode keluar. Jika nilainya bukan 0, pengujian gagal meskipun ringkasan Cline menyatakan sebaliknya.

Penutup

Konfigurasinya sederhana:

1. Instal apidog-cli.
2. Autentikasi dengan apidog login.
3. Salin perintah dari tab CI/CD Apidog.
4. Simpan perintah tersebut dalam .clinerules/apidog.md.
5. Biarkan Cline menjalankan skenario setelah perubahan API.

Anda tetap membuat dan memelihara skenario secara visual di Apidog, sementara Cline menjalankannya sebagai bagian dari siklus pengembangan. Endpoint yang rusak dapat terdeteksi saat agen masih mengerjakan perubahan, bukan setelah kode dikirim.

Unduh Apidog, buat satu skenario, lalu tambahkan perintah apidog run ke .clinerules/apidog.md.