Hoppa till huvudinnehåll

Documentation Index

Fetch the complete documentation index at: https://docs.dodopayments.com/llms.txt

Use this file to discover all available pages before exploring further.

Hantera dina Dodo Payments-resurser, kör AI-drivna frågor mot ditt konto, skapa betalsessioner och testa webhooks — allt från terminalen. CLI:n levereras med en interaktiv TUI, en inbyggd AI-assistent driven av MCP och offline-testning av webhooks.

Funktioner

  • Interaktiv TUI — starta dodo utan argument för att öppna hela det interaktiva gränssnittet med kommandopalett, historik och live-notiser.
  • Inbyggd AI-assistent — ställ frågor eller utför åtgärder på enkel engelska med /ai. Ingen extra installation krävs, körs dodopayments-mcp lokalt.
  • Säker som standard — API-nycklar lagras i ditt OS:s hemliga lagring (macOS Keychain, Windows Credential Vault, Linux libsecret). Ingen okrypterad konfiguration på disk.
  • Automatisk uppdatering — CLI:n kontrollerar efter nya versioner vid start och meddelar dig i appen. Kör /update för att uppgradera direkt.
  • Webhook-verktyg — lyssna på live-webhooks eller trigga nyttolaster offline för lokal utveckling.

Installation

Installera CLI:n i ett steg på macOS eller Linux:
curl -fsSL https://dodopayments.com/install.sh | sh

Installera med npm eller Bun

Om du redan har Node eller Bun, drar paketinstalleringarna alltid den senaste versionen:
npm install -g dodopayments-cli

Manuell installation (ingen Node / Bun krävs)

Om du hellre vill undvika att köra ett fjärrskript till sh, ladda ner binären själv.
1

Download the binary

Ladda ner binären för din plattform från den senaste GitHub Release.
PlattformBinär
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`

mv ./dodo-cli-* ./dodo && chmod +x ./dodo
3

Move it to a directory on your PATH

sudo mv ./dodo /usr/local/bin/
På Windows krävs administratörsrättigheter för att flytta till C:\Windows\System32.
4

(Optional) Verify the download

Varje release publicerar en SHA256SUMS.txt. Verifiera din nedladdning med:
shasum -a 256 -c SHA256SUMS.txt

Autentisering

Innan du använder autentiserade kommandon, logga in med din API-nyckel:
dodo login
Eller inifrån den interaktiva TUI:
/login
Inloggningsflödet kommer att:
  1. Öppna din webbläsare till Dodo Payments API-nyckelsida.
  2. Uppmana dig att klistra in din API-nyckel.
  3. Be dig välja en miljö — Testläge eller Livläge.
  4. Lagra autentiseringsuppgifterna i ditt OS hemlagring (Keychain på macOS, Credential Vault på Windows, libsecret på Linux).
Eftersom autentiseringsuppgifterna lagras i OS hemlagring kan du bli ombedd att ange ditt enhets lösenord första gången CLI:n läser eller skriver autentiseringsuppgifterna. Om du uppgraderar från en äldre version kommer eventuell befintlig okrypterad API-nyckel migreras till hemlagringen och den gamla filen tas bort automatiskt.

Byta läge och logga ut

Du kan hålla en Testläge och en Livläge nyckel autentiserad samtidigt. För att rensa autentiseringsuppgifterna:
dodo logout
Utloggningsflödet låter dig välja mellan Alla konton, Testläge eller Livläge oberoende.

Användning

Du kan använda CLI:n i två lägen.

1. Interaktiv TUI (rekommenderas)

Kör dodo utan argument för att starta det fullständiga interaktiva gränssnittet:
dodo
Skriv / för att öppna kommandopaletten, eller börja bara skriva — allt som inte är ett snedstreckskommando skickas till AI-assistenten.
KommandoBeskrivning
/helpVisa kommandoreferensen
/updateKontrollera och installera en CLI-uppdatering
/loginAutentisera med en API-nyckel
/logoutLogga ut från en eller alla miljöer
/clearRensa TUI-skärmen
/exitAvsluta TUI (också: skriv exit, eller tryck Esc två gånger)

2. Direkta underkommandon

Kör kommandon direkt utan att gå in i TUI:
dodo <category> <sub-command> [args...]
Till exempel:
dodo payments list 1
dodo customers create
dodo wh trigger
Referenstabellerna nedan visar varje kommando. I TUI, prefixa dem med /; i direktläge, ta bort /.

AI Assistent

Ställ frågor eller utför åtgärder på naturligt språk. Assistenten använder dodopayments-mcp som körs lokalt — ingen extra installation eller OAuth-flöde krävs, och din AI-trafik lämnar inte din maskin förutom för att kommunicera med modellleverantören.
KommandoBeskrivning
/ai <query>Ställ en fråga till AI-assistenten eller ge den en instruktion
(vilken som helst text utan snedstreck)Skickas till AI-assistenten som standard medan i TUI
Exempel:
how much revenue did I make this week?
/ai create a new customer named Acme Inc.
/ai find my last failed payment
Assistenten respekterar din aktiva miljö (Test / Live), så den fungerar endast på data från den miljö du är inloggad på för närvarande.

Kommandoreferens

Produkter

Hantera din produktkatalog.
KommandoBeskrivning
dodo products list <page>Lista produkter
dodo products createÖppna instrumentpanelen för att skapa en produkt
dodo products info <id>Visa detaljer för en specifik produkt

Betalningar

Visa betalningstransaktioner.
KommandoBeskrivning
dodo payments list <page>Lista betalningar
dodo payments info <id>Hämta information om en specifik betalning

Kunder

Hantera din kundbas.
KommandoBeskrivning
dodo customers list <page>Lista kunder
dodo customers createSkapa en ny kund
dodo customers update <id>Uppdatera en befintlig kund

Rabatter

Hantera kuponger och rabatter.
KommandoBeskrivning
dodo discounts list <page>Lista rabatter
dodo discounts createSkapa en ny procentbaserad rabatt
dodo discounts delete <id>Ta bort en rabatt enligt ID

Licenser

Hantera programvarulicenser.
KommandoBeskrivning
dodo licences list <page>Lista licenser

Tillbehör

Hantera produkt-tillbehör.
KommandoBeskrivning
dodo addons list <page>Lista tillbehör
dodo addons createÖppna instrumentpanelen för att skapa ett tillbehör
dodo addons info <id>Visa detaljer för ett specifikt tillbehör

Återbetalningar

Visa återbetalningsinformation.
KommandoBeskrivning
dodo refunds list <page>Lista återbetalningar
dodo refunds info <id>Visa detaljer för en specifik återbetalning

Kassa

Skapa värdkassa-sessioner.
KommandoBeskrivning
dodo checkout newSkapa interaktivt en värdkassa-session och få en betalningslänk

Webhooks

CLI:n inkluderar två kraftfulla verktyg för att testa webhooks under utveckling: en lyssnare som vidarebefordrar live-test-webhooks till din lokala server, och en trigger som skickar mock-webhook nyttolaster till valfri endpoint.
KommandoBeskrivning
dodo wh listenLyssna på webhooks i realtid och vidarebefordra dem till din lokala utvecklingsserver
dodo wh triggerTrigger ett test-webhook-event interaktivt — även när du är utloggad

Lyssna på webhooks

Vidarebefordra webhooks från Dodo Payments direkt till din lokala utvecklingsserver i realtid.
dodo wh listen
1

Enter your local endpoint URL

Ange den lokala URL:en där du vill ta emot webhooks (t.ex., http://localhost:3000/webhook).
2

Automatic setup

CLI:n skapar automatiskt en webhook-endpoint på ditt Dodo Payments-konto om en inte redan existerar, och öppnar sedan en WebSocket-anslutning för att ta emot händelser i realtid.
3

Receive and forward

När en webhook-händelse inträffar (från en testbetalning, abonnemangsförändring osv.), tar CLI:n emot den, loggar händelsetypen och vidarebefordrar hela förfrågan med headers och kropp till din lokala endpoint. Svar från din endpoint loggas och skickas tillbaka.
dodo wh listen kräver en Testläge API-nyckel. Livläge-nycklar stöds inte av lyssnarflödet.
Lyssnaren bevarar de ursprungliga webhook-headerarna (webhook-id, webhook-signature, webhook-timestamp) när den vidarebefordrar till din lokala endpoint, så att du kan testa din signaturverifieringslogik.

Trigger test-webhooks

Skicka mock-webhook nyttolaster till valfri endpoint för snabb testning utan att behöva skapa verkliga transaktioner.
dodo wh trigger
/wh trigger-flödet guidar dig genom:
  1. Ange en destination endpoint URL
  2. Välj en specifik händelse att trigga från en interaktiv meny
dodo wh trigger kräver inte inloggning. Det fungerar som en lokal/offline webhook nyttolastgenerator.
Triggade händelser är inte signerade. Under testning, inaktivera webhook-signaturverifiering på din endpoint — använd till exempel unsafe_unwrap() istället för unwrap() i din webhook-handler endast under testning.

Stödda webhook-händelser

KategoriHändelser
Abonnemangactive, updated, on_hold, renewed, plan_changed, cancelled, failed, expired
Betalningsucceeded, failed, processing, cancelled
Återbetalningsucceeded, failed
Tvistopened, expired, accepted, cancelled, challenged, won, lost
Licenscreated

Miljövariabler

VariabelBeskrivning
DODO_WH_TEST_SERVER_URLÅsidosätt standardwebhook-relayserver-URL som används av dodo wh listen

Uppdateringar

CLI:n kontrollerar efter en nyare version vid start och visar ett meddelande i statusfältet när en finns tillgänglig. För att uppgradera:
/update
Eller, kör om installationsprogrammet för att uppgradera direkt:
curl -fsSL https://dodopayments.com/install.sh | sh

Resurser

GitHub Repository

Visa källkod och utgåvor

npm Package

Visa på npm-registret

Support

Last modified on May 22, 2026