Dodo CLI

Kelola resource Dodo Payments, kueri akun Anda dengan asisten AI, buat sesi checkout, dan uji webhook dari terminal dengan Dodo CLI.

Dodo CLI mengelola resource Dodo Payments Anda, menjawab pertanyaan tentang akun dengan asisten AI bawaan, membuat sesi checkout, dan menguji webhook, semuanya dari terminal. Gunakan TUI interaktifnya, atau jalankan subperintah langsung dari skrip.

​

Fitur

• TUI interaktif: Jalankan dodo tanpa argumen untuk membuka antarmuka interaktif, lengkap dengan palet perintah, riwayat, dan notifikasi langsung.
• Asisten AI bawaan: Ajukan pertanyaan atau lakukan tindakan dalam bahasa Inggris biasa dengan /ai. Asisten menjalankan dodopayments-mcp secara lokal dan tidak memerlukan penyiapan tambahan.
• Kredensial terenkripsi: API keys disimpan di ~/.dodopayments/config.json, dienkripsi dengan AES-256-GCM dan kunci yang diturunkan dari mesin Anda. Tidak ada kredensial plaintext yang disimpan di disk.
• Pembaruan otomatis: CLI memeriksa versi baru saat dimulai dan memberi tahu Anda di TUI. Untuk instalasi npm dan Bun, jalankan /update untuk meningkatkan versi di tempat.
• Peralatan webhook: Teruskan webhook mode pengujian ke server lokal Anda, atau kirim payload webhook tiruan secara offline.
• Scaffolding: Tambahkan rute billing ke proyek Next.js, Express, dan Better Auth dengan dodo init.

​

Instalasi

Di macOS atau Linux, instal binary rilis terbaru dengan skrip instalasi:

curl -fsSL https://dodopayments.com/install.sh | sh

Skrip tersebut memverifikasi binary berdasarkan checksum SHA-256 rilis. Skrip menginstal dodo ke direktori pertama yang dapat ditulisi di antara /usr/local/bin, ~/.local/bin, dan ~/bin, atau ke ~/.local/bin jika tidak ada yang dapat ditulisi. Untuk menginstal rilis tertentu, tetapkan variabel lingkungan DODO_VERSION ke tag rilis tersebut. Untuk memilih direktori, tetapkan DODO_INSTALL_DIR.

​

Instal dengan NPM atau Bun

Jika Anda memiliki Node.js atau Bun, instal package dodopayments-cli secara global. Instalasi melalui package manager mengambil versi terbaru yang dipublikasikan:

npm

npm install -g dodopayments-cli

Subperintah langsung seperti dodo login berjalan pada Node.js 18 atau yang lebih baru. Saat Anda menginstal melalui package manager, TUI interaktif juga memerlukan Bun. Binary rilis tidak memerlukan runtime apa pun.

​

Instalasi Manual (Tanpa Node / Bun)

Untuk menginstal tanpa menjalankan skrip jarak jauh, unduh binary sendiri.

1. Download the Binary

   Unduh binary untuk platform Anda dari GitHub Release terbaru.

   Platform	Binary
   macOS (Apple Silicon)	dodo-cli-darwin-arm64
   macOS (Intel)	dodo-cli-darwin-x64
   Linux (x86_64)	dodo-cli-linux-x64
   Linux (arm64)	dodo-cli-linux-arm64
   Windows (x86_64)	dodo-cli-windows-x64.exe

2. Rename the Binary to dodo

   Linux / macOS

   mv ./dodo-cli-* ./dodo && chmod +x ./dodo
   
3. Move It to a Directory on Your PATH

   Di Windows, memindahkan file ke C:\Windows\System32 memerlukan hak administrator.

   Linux / macOS

   sudo mv ./dodo /usr/local/bin/
   
4. (Optional) Verify the Download

   Setiap rilis menerbitkan file SHA256SUMS.txt. Unduh file tersebut di samping binary, lalu verifikasi binary:

   shasum -a 256 -c SHA256SUMS.txt
   

​

Autentikasi

Login dengan API key sebelum menjalankan perintah yang membaca atau mengubah akun Anda. Untuk login dengan subperintah langsung, teruskan key dan modenya, test atau live:

dodo login "$DODO_PAYMENTS_API_KEY" test

Atau, dari dalam TUI interaktif:

/login

Alur login TUI:

1. Membuka halaman Developer → API Keys di dashboard melalui browser Anda.
2. Meminta Anda menempelkan API key.
3. Meminta Anda memilih Test Mode atau Live Mode.

Kedua perintah memverifikasi key dengan request ke API, lalu menyimpannya secara terenkripsi di ~/.dodopayments/config.json.

Kunci enkripsi diturunkan dari mesin Anda, sehingga kredensial yang tersimpan hanya berfungsi di mesin tersebut. Jika Anda melakukan upgrade dari v3.0.x, yang menyimpan key di keychain OS, jalankan kembali dodo login. Key dalam file plaintext lama ~/.dodopayments/api-key dimigrasikan secara otomatis, dan file tersebut dihapus.

​

Beralih Mode dan Logout

Anda dapat tetap login dengan satu key mode pengujian dan satu key live mode secara bersamaan. Untuk mengganti mode aktif di TUI, jalankan /switch. Untuk menghapus key yang tersimpan:

Direct

dodo logout all

Dalam mode langsung, teruskan test, live, atau all. Di TUI, /logout meminta Anda memilih All accounts, Test Mode, atau Live Mode, lalu meminta konfirmasi.

​

Penggunaan

Anda dapat menggunakan CLI dalam dua mode.

​

1. TUI Interaktif (Disarankan)

Jalankan dodo tanpa argumen untuk membuka antarmuka interaktif:

dodo

Ketik / untuk membuka palet perintah. Teks yang tidak dimulai dengan / akan dikirim ke asisten AI.

Command	Description
/help	Menampilkan referensi perintah
/update	Memeriksa dan menginstal pembaruan CLI
/login	Melakukan autentikasi dengan API key
/logout	Logout dari satu atau semua environment
/switch	Beralih antara mode pengujian dan live mode
/clear	Menghapus layar TUI
/exit	Keluar dari TUI (juga: ketik exit, atau tekan Esc dua kali)

​

2. Subperintah Langsung

Jalankan perintah tanpa membuka TUI:

dodo <category> <sub-command> [args...]

Contoh:

dodo payments list 1
dodo customers list 1
dodo wh trigger payment.success http://localhost:3000/webhook

Tabel referensi di bawah mencantumkan setiap perintah dalam bentuk mode langsung. Di TUI, ganti dodo dengan /, misalnya /payments list 1. Perintah yang ditandai TUI only adalah wizard interaktif. Dalam mode langsung, perintah tersebut mencetak pesan yang meminta Anda membuka TUI.

​

Asisten AI

Ajukan pertanyaan tentang akun Anda atau lakukan tindakan dalam bahasa Inggris biasa. Asisten menjalankan dodopayments-mcp di mesin Anda, sehingga tidak memerlukan penyiapan tambahan atau alur OAuth. Asisten memanggil API Dodo Payments dari mesin Anda menggunakan key yang tersimpan dan mengirimkan prompt Anda ke language model.

Command	Description
/ai <query>	Mengajukan pertanyaan atau memberikan instruksi kepada asisten AI
(any non-slash text)	Secara default dikirim ke asisten AI saat berada di TUI

Dalam mode langsung, jalankan dodo ai diikuti pertanyaan Anda. Contoh di TUI:

how much revenue did I make this week?
/ai create a new customer named Acme Inc.
/ai find my last failed payment

Asisten menggunakan mode aktif Anda (mode pengujian atau live mode) dan hanya berfungsi dengan data dari mode tersebut.

​

Scaffolding Proyek

dodo init menambahkan rute billing Dodo Payments ke proyek yang sudah ada. Perintah ini menulis file rute, menginstal package adapter @dodopayments/* yang sesuai, dan menambahkan variabel DODO_PAYMENTS_* yang belum ada ke file .env Anda dengan nilai placeholder. File dan variabel yang sudah ada akan dilewati, dan perintah ini berjalan tanpa login.

dodo init <framework>

Scaffold	Description
dodo init nextjs	Membuat scaffold rute billing Next.js App Router (checkout, Customer Portal, dan handler webhook) menggunakan @dodopayments/nextjs
dodo init express	Membuat scaffold rute billing server Express menggunakan @dodopayments/express
dodo init better-auth	Membuat scaffold konfigurasi plugin Better-Auth menggunakan @dodopayments/better-auth

Untuk scaffold Better-Auth, Anda dapat meneruskan daftar plugin yang dipisahkan koma untuk dibuat: checkout, portal, usage, dan webhooks. Tanpa daftar, keempatnya akan dibuat.

# Scaffold every Better-Auth plugin (default)
dodo init better-auth

# Scaffold only specific plugins
dodo init better-auth checkout,portal

Jika proyek Anda memiliki direktori src/, scaffolder menulis file di dalamnya. Scaffolder memilih perintah instalasi dari lock file proyek Anda (bun, pnpm, atau yarn) dan menggunakan npm jika tidak menemukan lock file.

​

Referensi Perintah

Perintah-perintah ini memerlukan API key yang sudah login. Perintah list menerima nomor halaman opsional, yang secara default bernilai 1, dan menampilkan hingga 100 item per halaman.

​

Produk

Kelola katalog produk Anda.

Command	Description
dodo products list <page>	Menampilkan daftar produk
dodo products create	Membuka dashboard untuk membuat produk
dodo products info <id>	Melihat detail produk tertentu

​

Pembayaran

Melihat transaksi pembayaran.

Command	Description
dodo payments list <page>	Menampilkan daftar pembayaran
dodo payments info <id>	Mendapatkan informasi tentang pembayaran tertentu

​

Pelanggan

Kelola pelanggan Anda.

Command	Description
dodo customers list <page>	Menampilkan daftar pelanggan
dodo customers create	Membuat pelanggan baru (TUI only)
dodo customers update <id>	Memperbarui pelanggan yang sudah ada (TUI only)
dodo customers portal <id>	Membuat sesi Customer Portal sementara untuk pelanggan

​

Diskon

Kelola kode diskon.

Command	Description
dodo discounts list <page>	Menampilkan daftar diskon
dodo discounts create	Membuat diskon berbasis persentase baru (TUI only)
dodo discounts delete <id>	Menghapus diskon berdasarkan ID (TUI only)

​

Lisensi

Melihat license key. Ejaan perintahnya adalah licences.

Command	Description
dodo licences list <page>	Menampilkan daftar lisensi

​

Addon

Kelola addon produk.

Command	Description
dodo addons list <page>	Menampilkan daftar addon
dodo addons create	Membuka dashboard untuk membuat addon
dodo addons info <id>	Melihat detail addon tertentu

​

Pengembalian Dana

Melihat informasi pengembalian dana.

Command	Description
dodo refunds list <page>	Menampilkan daftar pengembalian dana
dodo refunds info <id>	Melihat detail pengembalian dana tertentu

​

Checkout

Membuat sesi checkout hosted.

Command	Description
dodo checkout new	Membuat sesi checkout hosted secara interaktif dan mendapatkan payment link (TUI only)

​

Webhook

CLI memiliki dua alat webhook untuk pengembangan: listener yang meneruskan webhook mode pengujian ke server lokal Anda, dan trigger yang mengirim payload webhook tiruan ke endpoint mana pun.

Command	Description
dodo wh listen <url>	Mendengarkan webhook secara real time dan meneruskannya ke server dev lokal Anda
dodo wh trigger <event> <url>	Mengirim event webhook tiruan, bahkan saat logout

Dalam mode langsung, argumen wajib diberikan. Di TUI, jalankan /wh listen atau /wh trigger tanpa argumen untuk membuka wizard interaktif.

​

Mendengarkan Webhook

Teruskan webhook dari akun Dodo Payments Anda ke server pengembangan lokal secara real time.

dodo wh listen memerlukan API key Test Mode. Key Live Mode tidak didukung oleh alur listen.

dodo wh listen http://localhost:3000/webhook

1. Enter Your Local Endpoint URL

   Teruskan URL lokal yang akan menerima webhook, misalnya http://localhost:3000/webhook. Dalam wizard TUI, CLI akan memintanya.

2. Automatic Setup

   Jika akun Anda tidak memiliki endpoint webhook untuk server relay CLI, CLI akan membuatnya. Endpoint tersebut muncul di Developer → Webhooks. CLI kemudian membuka koneksi WebSocket ke relay untuk menerima event secara real time.

3. Receive and Forward

   Saat event webhook aktif, misalnya dari pembayaran pengujian atau perubahan subscription, CLI meneruskan payload dan header ke endpoint lokal Anda sebagai request POST. CLI mencatat tipe event dan respons endpoint Anda, lalu mengirimkan respons tersebut kembali ke relay.

Listener mempertahankan header webhook asli (webhook-id, webhook-signature, webhook-timestamp) saat meneruskannya ke endpoint lokal Anda, sehingga Anda dapat menguji logika verifikasi signature.

Relay dan CLI mengurai body JSON lalu melakukan serialisasi ulang sebelum meneruskannya. Jika body yang diteruskan berbeda byte demi byte dari yang asli, misalnya dalam pemformatan angka, verifikasi tanda tangan akan gagal meskipun header tetap utuh.

​

Memicu Webhook Pengujian

Kirim payload webhook tiruan ke endpoint mana pun, tanpa membuat transaksi nyata.

Event yang dipicu tidak ditandatangani: request tidak membawa header webhook-id, webhook-signature, atau webhook-timestamp. Saat pengujian, parsing event tersebut dengan metode yang tidak terverifikasi (unsafeUnwrap dalam TypeScript, unsafe_unwrap dalam Python, UnsafeUnwrap dalam Go), bukan unwrap, lalu kembali ke unwrap sebelum Anda melakukan live.

dodo wh trigger payment.success http://localhost:3000/webhook

Dalam mode langsung, payload menggunakan ID placeholder dan detail pelanggan. Wizard /wh trigger di TUI memandu Anda melalui langkah-langkah berikut:

1. Menetapkan endpoint URL tujuan.
2. Secara opsional memasukkan Business ID, Product ID, Metadata (objek JSON), Customer email, dan Customer ID untuk payload. Kolom kosong menggunakan nilai placeholder.
3. Memilih event yang akan dikirim dari menu interaktif. Anda dapat mengirim beberapa event secara berurutan. Pilih exit untuk selesai.

dodo wh trigger tidak memerlukan login. Perintah ini berfungsi sebagai generator payload webhook lokal dan offline.

​

Event Webhook yang Didukung

dodo wh trigger dapat mengirim payload tiruan untuk 46 dari 48 tipe event yang dikirimkan Dodo Payments. Perintah ini tidak mendukung subscription.past_due atau subscription.unpaused. Teruskan nama event persis seperti yang tercantum:

Category	Events
Subscription	subscription.active, subscription.updated, subscription.on_hold, subscription.renewed, subscription.plan_changed, subscription.cancelled, subscription.failed, subscription.expired, subscription.paused, subscription.update_payment_method
Payment	payment.success, payment.failed, payment.processing, payment.cancelled
Refund	refund.success, refund.failed
Dispute	dispute.opened, dispute.expired, dispute.accepted, dispute.cancelled, dispute.challenged, dispute.won, dispute.lost
License Key	licence.created
Payout	payout.created, payout.in_progress, payout.on_hold, payout.failed, payout.success
Credit	credit.added, credit.deducted, credit.expired, credit.rolled_over, credit.rollover_forfeited, credit.overage_charged, credit.overage_reset, credit.manual_adjustment, credit.balance_low
Abandoned Checkout	abandoned_checkout.detected, abandoned_checkout.recovered
Dunning	dunning.started, dunning.recovered
Entitlement Grant	entitlement_grant.created, entitlement_grant.delivered, entitlement_grant.failed, entitlement_grant.revoked

Tiga nama trigger berbeda dari event type dalam payload yang dikirim: payment.success mengirim payment.succeeded, refund.success mengirim refund.succeeded, dan licence.created mengirim license_key.created.

Bentuk payload tiruan mengikuti schema terkait dalam referensi API. Lihat Webhook Events untuk mengetahui arti setiap event dan kapan Dodo Payments menerbitkannya dalam production.

payout.created diterbitkan saat payout masih melaporkan status not_initiated, sehingga payload tiruan juga mencerminkan hal tersebut. Lihat Payout Events untuk siklus hidup payout selengkapnya.

​

Variabel Environment

Variabel ini mengubah cara dodo wh listen terhubung:

Variable	Description
DODO_WH_TEST_SERVER_URL	Mengganti server relay webhook default yang digunakan oleh dodo wh listen. Tetapkan nama host tanpa scheme.

​

Pembaruan

CLI memeriksa versi yang lebih baru saat dimulai dan menampilkan notifikasi di status bar jika tersedia. Untuk meningkatkan versi instalasi npm atau Bun dari TUI, jalankan:

/update

/update tidak dapat meningkatkan versi binary rilis. Untuk instalasi binary, termasuk instalasi dengan skrip instalasi, perintah ini mengarahkan Anda ke GitHub release terbaru. Untuk meningkatkan versi dari shell, jalankan kembali perintah yang Anda gunakan saat menginstal:

install.sh

curl -fsSL https://dodopayments.com/install.sh | sh

​

Resource

GitHub Repository

Source code dan rilis.

npm Package

Package dodopayments-cli di registry npm.

​

Dukungan

• Discord: Bergabunglah dengan server komunitas.
• GitHub: Buka issue di repository.
• Email: Hubungi [e-mail].