Dodo CLI

Le Dodo CLI gère vos ressources Dodo Payments, répond à vos questions sur votre compte avec un assistant IA intégré, crée des sessions de paiement et teste les webhooks, le tout depuis votre terminal. Utilisez son TUI interactif ou exécutez des sous-commandes directes depuis des scripts.

Fonctionnalités

TUI interactif : exécutez dodo sans argument pour ouvrir l’interface interactive, avec une palette de commandes, un historique et des notifications en temps réel.
Assistant IA intégré : posez des questions ou effectuez des actions en anglais courant avec /ai. L’assistant s’exécute localement via dodopayments-mcp et ne nécessite aucune configuration supplémentaire.
Identifiants chiffrés : les clés API sont stockées dans ~/.dodopayments/config.json, chiffrées avec AES-256-GCM et une clé dérivée de votre machine. Aucun identifiant en clair n’est stocké sur le disque.
Mise à jour automatique : le CLI recherche les nouvelles versions au démarrage et vous en informe dans le TUI. Pour les installations npm et Bun, exécutez /update pour effectuer la mise à niveau sur place.
Outils pour les webhooks : transférez les webhooks du mode test vers votre serveur local ou envoyez des payloads de webhook simulés hors ligne.
Génération de structure : ajoutez des routes de facturation aux projets Next.js, Express et Better Auth avec dodo init.

Installation

Sur macOS ou Linux, installez le dernier binaire avec le script d’installation :

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

Le script vérifie le binaire à l’aide des sommes de contrôle SHA-256 de la version. Il installe dodo dans le premier répertoire accessible en écriture parmi /usr/local/bin, ~/.local/bin et ~/bin, ou dans ~/.local/bin si aucun ne peut être modifié. Pour installer une version spécifique, définissez la variable d’environnement DODO_VERSION sur son tag. Pour choisir le répertoire, définissez DODO_INSTALL_DIR.

Installer avec NPM ou Bun

Si vous disposez de Node.js ou de Bun, installez globalement le package dodopayments-cli. Les installations via un gestionnaire de packages utilisent la dernière version publiée :

npm install -g dodopayments-cli

bun install -g dodopayments-cli

Les sous-commandes directes telles que dodo login s’exécutent avec Node.js 18 ou une version ultérieure. Lorsque vous installez le CLI via un gestionnaire de packages, le TUI interactif nécessite également Bun. Les binaires de version ne nécessitent aucun de ces environnements d’exécution.

Installation manuelle (sans Node ni Bun)

Pour installer le CLI sans exécuter de script distant, téléchargez vous-même le binaire.

Download the Binary

Téléchargez le binaire correspondant à votre plateforme depuis la dernière version GitHub.

Plateforme	Binaire
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`

Rename the Binary to dodo

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

ren .\dodo-cli-windows-x64.exe .\dodo.exe

Move It to a Directory on Your PATH

Sous Windows, le déplacement du fichier vers C:\Windows\System32 nécessite les privilèges administrateur.

sudo mv ./dodo /usr/local/bin/

move .\dodo.exe C:\Windows\System32\dodo.exe

(Optional) Verify the Download

Chaque version publie un fichier SHA256SUMS.txt. Téléchargez-le à côté du binaire, puis vérifiez le binaire :

shasum -a 256 -c SHA256SUMS.txt

Authentification

Connectez-vous avec une clé API avant d’exécuter des commandes qui lisent ou modifient votre compte. Pour vous connecter avec une sous-commande directe, transmettez la clé et son mode, test ou live :

dodo login "$DODO_PAYMENTS_API_KEY" test

Ou, depuis le TUI interactif :

/login

Le processus de connexion au TUI :

Ouvre dans votre navigateur la page Developer → API Keys du dashboard.
Vous invite à coller votre clé API.
Vous demande de choisir Test Mode ou Live Mode.

Les deux commandes vérifient la clé en envoyant une requête à l’API, puis la stockent de manière chiffrée dans ~/.dodopayments/config.json.

La clé de chiffrement est dérivée de votre machine : les identifiants enregistrés ne fonctionnent donc que sur cette machine. Si vous effectuez une mise à niveau depuis v3.0.x, qui stockait les clés dans le trousseau du système d’exploitation, exécutez à nouveau dodo login. Les clés présentes dans l’ancien fichier en clair ~/.dodopayments/api-key sont migrées automatiquement, puis ce fichier est supprimé.

Changer de mode et se déconnecter

Vous pouvez rester connecté simultanément avec une clé en mode test et une clé en mode live. Pour changer de mode actif dans le TUI, exécutez /switch. Pour supprimer les clés enregistrées :

dodo logout all

/logout

En mode direct, transmettez test, live ou all. Dans le TUI, /logout vous demande de choisir All accounts, Test Mode ou Live Mode, puis de confirmer.

Utilisation

Vous pouvez utiliser le CLI selon deux modes.

1. TUI interactif (recommandé)

Exécutez dodo sans argument pour ouvrir l’interface interactive :

dodo

Saisissez / pour ouvrir la palette de commandes. Le texte qui ne commence pas par / est envoyé à l’assistant IA.

Commande	Description
`/help`	Afficher la référence des commandes
`/update`	Rechercher et installer une mise à jour du CLI
`/login`	S’authentifier avec une clé API
`/logout`	Se déconnecter d’un ou de tous les environnements
`/switch`	Basculer entre le mode test et le mode live
`/clear`	Effacer l’écran du TUI
`/exit`	Quitter le TUI (également : saisissez `exit` ou appuyez deux fois sur `Esc`)

2. Sous-commandes directes

Exécutez une commande sans ouvrir le TUI :

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

Par exemple :

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

Les tableaux de référence ci-dessous répertorient chaque commande au format du mode direct. Dans le TUI, remplacez dodo par /, par exemple /payments list 1. Les commandes marquées TUI only sont des assistants interactifs. En mode direct, elles affichent un message vous invitant à ouvrir le TUI.

Assistant IA

Posez des questions sur votre compte ou effectuez des actions en anglais courant. L’assistant s’exécute via dodopayments-mcp sur votre machine et ne nécessite donc aucune configuration supplémentaire ni flux OAuth. Il appelle l’API Dodo Payments depuis votre machine avec votre clé enregistrée et envoie vos requêtes au modèle de langage.

Commande	Description
`/ai <query>`	Poser une question à l’assistant IA ou lui donner une instruction
(tout texte ne commençant pas par une barre oblique)	Envoyé par défaut à l’assistant IA depuis le TUI

En mode direct, exécutez dodo ai suivi de votre question. Exemples dans le TUI :

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

L’assistant utilise votre mode actif (mode test ou mode live) et ne fonctionne qu’avec les données de ce mode.

Génération de structure du projet

dodo init ajoute des routes de facturation Dodo Payments à un projet existant. Il écrit les fichiers de route, installe le package d’adaptation @dodopayments/* correspondant et ajoute les variables DODO_PAYMENTS_* manquantes à votre fichier .env avec des valeurs factices. Les fichiers et variables existants sont conservés, et la commande s’exécute sans connexion.

dodo init <framework>

Structure	Description
`dodo init nextjs`	Générer les routes de facturation Next.js App Router (checkout, portail client et gestionnaires de webhook) avec `@dodopayments/nextjs`
`dodo init express`	Générer les routes de facturation d’un serveur Express avec `@dodopayments/express`
`dodo init better-auth`	Générer la configuration d’un plugin Better-Auth avec `@dodopayments/better-auth`

Pour la structure Better-Auth, vous pouvez transmettre une liste séparée par des virgules de plugins à générer : checkout, portal, usage et webhooks. Sans liste, les quatre plugins sont générés.

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

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

Si votre projet contient un répertoire src/, le générateur y écrit les fichiers. Il choisit la commande d’installation à partir du fichier de verrouillage de votre projet (bun, pnpm ou yarn) et utilise npm s’il n’en trouve aucun.

Référence des commandes

Ces commandes nécessitent une clé API connectée. Les commandes de liste acceptent un numéro de page facultatif, égal à 1 par défaut, et affichent jusqu’à 100 éléments par page.

Produits

Gérez votre catalogue de produits.

Commande	Description
`dodo products list <page>`	Lister les produits
`dodo products create`	Ouvrir le dashboard pour créer un produit
`dodo products info <id>`	Afficher les détails d’un produit spécifique

Paiements

Afficher les transactions de paiement.

Commande	Description
`dodo payments list <page>`	Lister les paiements
`dodo payments info <id>`	Obtenir les informations d’un paiement spécifique

Clients

Gérez vos clients.

Commande	Description
`dodo customers list <page>`	Lister les clients
`dodo customers create`	Créer un client (TUI only)
`dodo customers update <id>`	Mettre à jour un client existant (TUI only)
`dodo customers portal <id>`	Créer une session temporaire du Customer Portal pour un client

Remises

Gérez les codes de remise.

Commande	Description
`dodo discounts list <page>`	Lister les remises
`dodo discounts create`	Créer une nouvelle remise en pourcentage (TUI only)
`dodo discounts delete <id>`	Supprimer une remise par ID (TUI only)

Licences

Afficher les clés de licence. La commande s’écrit licences.

Commande	Description
`dodo licences list <page>`	Lister les licences

Modules complémentaires

Gérez les modules complémentaires des produits.

Commande	Description
`dodo addons list <page>`	Lister les modules complémentaires
`dodo addons create`	Ouvrir le dashboard pour créer un module complémentaire
`dodo addons info <id>`	Afficher les détails d’un module complémentaire spécifique

Remboursements

Afficher les informations de remboursement.

Commande	Description
`dodo refunds list <page>`	Lister les remboursements
`dodo refunds info <id>`	Afficher les détails d’un remboursement spécifique

Checkout

Créer des sessions de checkout hébergées.

Commande	Description
`dodo checkout new`	Créer interactivement une session de checkout hébergée et obtenir un lien de paiement (TUI only)

Webhooks

Le CLI propose deux outils de webhook pour le développement : un listener qui transfère les webhooks du mode test vers votre serveur local, et un trigger qui envoie des payloads de webhook simulés à n’importe quel endpoint.

Commande	Description
`dodo wh listen <url>`	Écouter les webhooks en temps réel et les transférer à votre serveur de développement local
`dodo wh trigger <event> <url>`	Envoyer un événement de webhook simulé, même sans être connecté

En mode direct, les arguments sont obligatoires. Dans le TUI, exécutez /wh listen ou /wh trigger sans argument pour ouvrir un assistant interactif.

Écouter les webhooks

Transférez en temps réel les webhooks de votre compte Dodo Payments vers votre serveur de développement local.

dodo wh listen nécessite une clé API en Test Mode. Les clés Live Mode ne sont pas prises en charge par le flux d’écoute.

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

Enter Your Local Endpoint URL

Transmettez l’URL locale qui doit recevoir les webhooks, par exemple http://localhost:3000/webhook. Dans l’assistant du TUI, le CLI vous la demande.

Automatic Setup

Si votre compte ne possède aucun endpoint de webhook pour le serveur relais du CLI, le CLI en crée un. L’endpoint apparaît dans Developer → Webhooks. Le CLI ouvre ensuite une connexion WebSocket avec le relais pour recevoir les événements en temps réel.

Receive and Forward

Lorsqu’un événement webhook se produit, par exemple à la suite d’un paiement test ou d’une modification d’abonnement, le CLI transfère le payload et les en-têtes vers votre endpoint local dans une requête POST. Il consigne le type d’événement et la réponse de votre endpoint, puis renvoie la réponse au relais.

Le listener conserve les en-têtes webhook d’origine (webhook-id, webhook-signature, webhook-timestamp) lors du transfert vers votre endpoint local, afin que vous puissiez tester votre logique de vérification de signature.

Le relais et la CLI analysent le corps JSON, puis le sérialisent à nouveau avant de le transmettre. Si le corps transmis diffère, octet par octet, de l’original, par exemple au niveau du formatage des nombres, la vérification de la signature échoue même si les en-têtes sont intacts.

Déclencher des webhooks de test

Envoyez un payload de webhook simulé à n’importe quel endpoint, sans créer de transactions réelles.

Les événements déclenchés ne sont pas signés : la requête ne contient aucun en-tête webhook-id, webhook-signature ou webhook-timestamp. Pendant les tests, analysez-les avec la méthode non vérifiée (unsafeUnwrap en TypeScript, unsafe_unwrap en Python, UnsafeUnwrap en Go) plutôt qu’avec unwrap, puis repassez à unwrap avant la mise en production.

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

En mode direct, le payload utilise des ID et des informations client factices. L’assistant /wh trigger du TUI vous guide pour :

Définir une URL d’endpoint de destination.
Saisir éventuellement un Business ID, un Product ID, des Metadata (un objet JSON), l’e-mail du client et le Customer ID du payload. Les champs vides utilisent des valeurs factices.
Sélectionner un événement à envoyer depuis un menu interactif. Vous pouvez envoyer plusieurs événements à la suite. Choisissez exit pour terminer.

dodo wh trigger ne nécessite aucune connexion. Il fonctionne comme un générateur local et hors ligne de payloads de webhook.

Événements webhook pris en charge

dodo wh trigger peut envoyer des payloads simulés pour 46 des 48 types d’événement fournis par Dodo Payments. Il ne prend pas en charge subscription.past_due ni subscription.unpaused. Transmettez le nom de l’événement exactement comme indiqué :

Catégorie	Événements
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`

Trois noms de trigger diffèrent de l’événement type dans le payload qu’ils envoient : payment.success envoie payment.succeeded, refund.success envoie refund.succeeded et licence.created envoie license_key.created.

La structure des payloads simulés suit les schémas correspondants de la référence API. Consultez Événements webhook pour savoir ce que signifie chaque événement et quand Dodo Payments l’émet en production.

payout.created est émis alors que le paiement indique encore un statut not_initiated ; le payload simulé le reflète donc également. Consultez Événements de paiement pour connaître le cycle de vie complet d’un paiement.

Variables d’environnement

Cette variable modifie la manière dont dodo wh listen se connecte :

Variable	Description
`DODO_WH_TEST_SERVER_URL`	Remplace le serveur relais de webhook par défaut utilisé par `dodo wh listen`. Définissez un nom d’hôte sans schéma.

Mises à jour

Le CLI recherche une nouvelle version au démarrage et affiche une notification dans la barre d’état lorsqu’elle est disponible. Pour mettre à niveau une installation npm ou Bun depuis le TUI, exécutez :

/update

/update ne peut pas mettre à niveau un binaire de version. Pour les installations binaires, y compris celles effectuées avec le script d’installation, il renvoie plutôt vers la dernière version GitHub. Pour effectuer la mise à niveau depuis votre shell, réexécutez la commande utilisée lors de l’installation :

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

npm install -g dodopayments-cli

bun install -g dodopayments-cli

Ressources

GitHub Repository

Code source et versions.

npm Package

Le package dodopayments-cli dans le registre npm.

Assistance

Discord : rejoignez le serveur communautaire.
GitHub : ouvrez un ticket dans le dépôt.
E-mail : contactez support@dodopayments.com.

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

Fonctionnalités

Installation

Installer avec NPM ou Bun

Installation manuelle (sans Node ni Bun)

Authentification

Changer de mode et se déconnecter

Utilisation

1. TUI interactif (recommandé)

2. Sous-commandes directes

Assistant IA

Génération de structure du projet

Référence des commandes

Produits

Paiements

Clients

Remises

Licences

Modules complémentaires

Remboursements

Checkout

Webhooks

Écouter les webhooks

Déclencher des webhooks de test

Événements webhook pris en charge

Variables d’environnement

Mises à jour

Ressources

GitHub Repository

npm Package

Assistance

​Fonctionnalités

​Installation

​Installer avec NPM ou Bun

​Installation manuelle (sans Node ni Bun)

​Authentification

​Changer de mode et se déconnecter

​Utilisation

​1. TUI interactif (recommandé)

​2. Sous-commandes directes

​Assistant IA

​Génération de structure du projet

​Référence des commandes

​Produits

​Paiements

​Clients

​Remises

​Licences

​Modules complémentaires

​Remboursements

​Checkout

​Webhooks

​Écouter les webhooks

​Déclencher des webhooks de test

​Événements webhook pris en charge

​Variables d’environnement

​Mises à jour

​Ressources

GitHub Repository

npm Package

​Assistance

Fonctionnalités

Installation

Installer avec NPM ou Bun

Installation manuelle (sans Node ni Bun)

Authentification

Changer de mode et se déconnecter

Utilisation

1. TUI interactif (recommandé)

2. Sous-commandes directes

Assistant IA

Génération de structure du projet

Référence des commandes

Produits

Paiements

Clients

Remises

Licences

Modules complémentaires

Remboursements

Checkout

Webhooks

Écouter les webhooks

Déclencher des webhooks de test

Événements webhook pris en charge

Variables d’environnement

Mises à jour

Ressources

Assistance