Dodo CLI

O Dodo CLI gerencia seus recursos do Dodo Payments, responde a perguntas sobre sua conta com um assistente de IA integrado, cria sessões de checkout e testa webhooks, tudo pelo terminal. Use sua TUI interativa ou execute subcomandos diretamente a partir de scripts.

Recursos

TUI interativa: Execute dodo sem argumentos para abrir a interface interativa, com paleta de comandos, histórico e notificações em tempo real.
Assistente de IA integrado: Faça perguntas ou execute ações em inglês simples com /ai. O assistente executa dodopayments-mcp localmente e não precisa de configuração adicional.
Credenciais criptografadas: As chaves de API são armazenadas em ~/.dodopayments/config.json, criptografadas com AES-256-GCM e uma chave derivada da sua máquina. Nenhuma credencial em texto simples é armazenada no disco.
Atualização automática: O CLI verifica novas versões na inicialização e envia uma notificação na TUI. Para instalações com npm e Bun, execute /update para atualizar no local.
Ferramentas para webhooks: Encaminhe webhooks do modo de teste para seu servidor local ou envie payloads de webhook simulados offline.
Scaffolding: Adicione rotas de cobrança a projetos Next.js, Express e Better Auth com dodo init.

Instalação

No macOS ou Linux, instale o binário da versão mais recente com o script de instalação:

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

O script verifica o binário usando os checksums SHA-256 da versão. Ele instala dodo no primeiro diretório gravável entre /usr/local/bin, ~/.local/bin e ~/bin, ou em ~/.local/bin se nenhum deles for gravável. Para instalar uma versão específica, defina a variável de ambiente DODO_VERSION com a tag correspondente. Para escolher o diretório, defina DODO_INSTALL_DIR.

Instalar com NPM ou Bun

Se você tiver Node.js ou Bun, instale o pacote dodopayments-cli globalmente. As instalações pelo gerenciador de pacotes obtêm a versão publicada mais recente:

npm install -g dodopayments-cli

bun install -g dodopayments-cli

Subcomandos diretos, como dodo login, são executados no Node.js 18 ou posterior. Quando você instala por meio de um gerenciador de pacotes, a TUI interativa também precisa do Bun. Os binários de versão não precisam de nenhum runtime.

Instalação manual (sem Node / Bun)

Para instalar sem executar um script remoto, baixe o binário por conta própria.

Download the Binary

Baixe o binário para sua plataforma na versão mais recente no GitHub.

Plataforma	Binário
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

No Windows, mover o arquivo para C:\Windows\System32 requer privilégios de administrador.

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

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

(Optional) Verify the Download

Cada versão publica um arquivo SHA256SUMS.txt. Baixe-o ao lado do binário e verifique o binário:

shasum -a 256 -c SHA256SUMS.txt

Autenticação

Faça login com uma chave de API antes de executar comandos que leem ou alteram sua conta. Para fazer login com um subcomando direto, informe a chave e seu modo, test ou live:

dodo login "$DODO_PAYMENTS_API_KEY" test

Ou, dentro da TUI interativa:

/login

O fluxo de login da TUI:

Abre a página Developer → API Keys do dashboard no seu navegador.
Solicita que você cole sua chave de API.
Solicita que você escolha Test Mode ou Live Mode.

Ambos os comandos verificam a chave com uma solicitação à API e depois a armazenam criptografada em ~/.dodopayments/config.json.

A chave de criptografia é derivada da sua máquina, portanto as credenciais armazenadas funcionam apenas nessa máquina. Se você atualizar da v3.0.x, que armazenava as chaves no chaveiro do sistema operacional, execute dodo login novamente. As chaves do arquivo antigo em texto simples ~/.dodopayments/api-key são migradas automaticamente, e esse arquivo é excluído.

Alternar modos e sair

Você pode manter uma chave do modo de teste e uma chave do modo ativo conectadas ao mesmo tempo. Para alternar o modo ativo na TUI, execute /switch. Para remover as chaves armazenadas:

dodo logout all

/logout

No modo direto, informe test, live ou all. Na TUI, /logout solicita que você escolha All accounts, Test Mode ou Live Mode e, em seguida, pede sua confirmação.

Uso

Você pode usar o CLI em dois modos.

1. TUI interativa (recomendado)

Execute dodo sem argumentos para abrir a interface interativa:

dodo

Digite / para abrir a paleta de comandos. Textos que não começam com / são enviados ao assistente de IA.

Comando	Descrição
`/help`	Mostrar a referência de comandos
`/update`	Verificar e instalar uma atualização do CLI
`/login`	Autenticar com uma chave de API
`/logout`	Sair de um ou de todos os ambientes
`/switch`	Alternar entre o modo de teste e o modo ativo
`/clear`	Limpar a tela da TUI
`/exit`	Sair da TUI (também: digite `exit` ou pressione `Esc` duas vezes)

2. Subcomandos diretos

Execute um comando sem abrir a TUI:

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

Por exemplo:

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

As tabelas de referência abaixo listam todos os comandos no formato de modo direto. Na TUI, substitua dodo por /, por exemplo /payments list 1. Os comandos marcados como somente TUI são assistentes interativos. No modo direto, eles exibem uma mensagem informando que você deve abrir a TUI.

Assistente de IA

Faça perguntas sobre sua conta ou execute ações em inglês simples. O assistente executa dodopayments-mcp na sua máquina, portanto não precisa de configuração adicional nem de fluxo OAuth. Ele chama a API do Dodo Payments a partir da sua máquina usando sua chave armazenada e envia seus prompts ao modelo de linguagem.

Comando	Descrição
`/ai <query>`	Fazer uma pergunta ao assistente de IA ou fornecer uma instrução
(qualquer texto sem barra)	Enviado ao assistente de IA por padrão quando você está na TUI

No modo direto, execute dodo ai seguido da sua pergunta. Exemplos na TUI:

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

O assistente usa seu modo ativo (modo de teste ou modo ativo) e funciona apenas com os dados desse modo.

Scaffolding do projeto

dodo init adiciona rotas de cobrança do Dodo Payments a um projeto existente. Ele grava os arquivos de rota, instala o pacote adaptador correspondente @dodopayments/* e acrescenta ao arquivo .env quaisquer variáveis DODO_PAYMENTS_* ausentes, com valores de placeholder. Ele ignora arquivos e variáveis que já existem e é executado sem fazer login.

dodo init <framework>

Scaffold	Descrição
`dodo init nextjs`	Criar rotas de cobrança do Next.js App Router (checkout, Customer Portal e handlers de webhook) usando `@dodopayments/nextjs`
`dodo init express`	Criar rotas de cobrança para servidor Express usando `@dodopayments/express`
`dodo init better-auth`	Criar uma configuração de plugin do Better-Auth usando `@dodopayments/better-auth`

Para o scaffold do Better-Auth, você pode informar uma lista separada por vírgulas de plugins a serem gerados: checkout, portal, usage e webhooks. Sem uma lista, todos os quatro são gerados.

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

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

Se o seu projeto tiver um diretório src/, o scaffolder grava os arquivos dentro dele. Ele escolhe o comando de instalação a partir do lock file do projeto (bun, pnpm ou yarn) e usa npm quando não encontra nenhum deles.

Referência de comandos

Esses comandos precisam de uma chave de API conectada. Os comandos de listagem aceitam um número de página opcional, cujo padrão é 1, e exibem até 100 itens por página.

Produtos

Gerencie seu catálogo de produtos.

Comando	Descrição
`dodo products list <page>`	Listar produtos
`dodo products create`	Abrir o dashboard para criar um produto
`dodo products info <id>`	Ver detalhes de um produto específico

Pagamentos

Ver transações de pagamento.

Comando	Descrição
`dodo payments list <page>`	Listar pagamentos
`dodo payments info <id>`	Obter informações sobre um pagamento específico

Clientes

Gerencie seus clientes.

Comando	Descrição
`dodo customers list <page>`	Listar clientes
`dodo customers create`	Criar um novo cliente (somente TUI)
`dodo customers update <id>`	Atualizar um cliente existente (somente TUI)
`dodo customers portal <id>`	Criar uma sessão temporária do Customer Portal para um cliente

Descontos

Gerencie códigos de desconto.

Comando	Descrição
`dodo discounts list <page>`	Listar descontos
`dodo discounts create`	Criar um novo desconto baseado em porcentagem (somente TUI)
`dodo discounts delete <id>`	Remover um desconto por ID (somente TUI)

Licenças

Visualize chaves de licença. O comando é escrito como licences.

Comando	Descrição
`dodo licences list <page>`	Listar licenças

Addons

Gerencie complementos de produtos.

Comando	Descrição
`dodo addons list <page>`	Listar addons
`dodo addons create`	Abrir o dashboard para criar um addon
`dodo addons info <id>`	Ver detalhes de um addon específico

Reembolsos

Ver informações de reembolso.

Comando	Descrição
`dodo refunds list <page>`	Listar reembolsos
`dodo refunds info <id>`	Ver detalhes de um reembolso específico

Checkout

Crie sessões de checkout hospedadas.

Comando	Descrição
`dodo checkout new`	Criar interativamente uma sessão de checkout hospedada e obter um link de pagamento (somente TUI)

Webhooks

O CLI tem duas ferramentas de webhook para desenvolvimento: um listener, que encaminha webhooks do modo de teste para seu servidor local, e um trigger, que envia payloads de webhook simulados para qualquer endpoint.

Comando	Descrição
`dodo wh listen <url>`	Escutar webhooks em tempo real e encaminhá-los para seu servidor de desenvolvimento local
`dodo wh trigger <event> <url>`	Enviar um evento de webhook simulado, mesmo sem estar conectado

No modo direto, os argumentos são obrigatórios. Na TUI, execute /wh listen ou /wh trigger sem argumentos para abrir um assistente interativo.

Escutar webhooks

Encaminhe webhooks da sua conta do Dodo Payments para seu servidor de desenvolvimento local em tempo real.

dodo wh listen requer uma chave de API do Test Mode. Chaves do Live Mode não são compatíveis com o fluxo de escuta.

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

Enter Your Local Endpoint URL

Informe a URL local que deve receber os webhooks, por exemplo http://localhost:3000/webhook. No assistente da TUI, o CLI solicita esse valor.

Automatic Setup

Se sua conta não tiver um endpoint de webhook para o servidor de retransmissão do CLI, o CLI criará um. O endpoint aparece em Developer → Webhooks. Em seguida, o CLI abre uma conexão WebSocket com o relay para receber eventos em tempo real.

Receive and Forward

Quando um evento de webhook é disparado, por exemplo, por um pagamento de teste ou uma alteração de assinatura, o CLI encaminha o payload e os headers para seu endpoint local como uma solicitação POST. Ele registra o tipo de evento e a resposta do seu endpoint e envia a resposta de volta ao relay.

O listener preserva os headers originais do webhook (webhook-id, webhook-signature, webhook-timestamp) ao encaminhá-los para seu endpoint local, permitindo testar sua lógica de verificação de assinatura.

O relay e a CLI analisam o corpo JSON e o serializam novamente antes de encaminhá-lo. Se o corpo encaminhado diferir byte a byte do original, por exemplo, na formatação de números, a verificação da assinatura falhará mesmo que os headers estejam intactos.

Disparar webhooks de teste

Envie um payload de webhook simulado para qualquer endpoint, sem criar transações reais.

Os eventos disparados não são assinados: a solicitação não contém os headers webhook-id, webhook-signature ou webhook-timestamp. Durante os testes, analise-os com o método sem verificação (unsafeUnwrap em TypeScript, unsafe_unwrap em Python e UnsafeUnwrap em Go), em vez de unwrap, e volte a usar unwrap antes de entrar em produção.

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

No modo direto, o payload usa IDs de placeholder e detalhes de cliente. O assistente /wh trigger na TUI orienta você sobre como:

Definir uma URL de endpoint de destino.
Opcionalmente informar um Business ID, Product ID, Metadata (um objeto JSON), Customer email e Customer ID para o payload. Campos vazios usam valores de placeholder.
Selecionar um evento para enviar em um menu interativo. Você pode enviar vários eventos em sequência. Escolha exit para finalizar.

dodo wh trigger não requer login. Ele funciona como um gerador local e offline de payloads de webhook.

Eventos de webhook compatíveis

dodo wh trigger pode enviar payloads simulados para 46 dos 48 tipos de evento entregues pelo Dodo Payments. Ele não é compatível com subscription.past_due nem com subscription.unpaused. Informe o nome do evento exatamente como listado:

Categoria	Eventos
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`

Três nomes de trigger diferem do evento type no payload que enviam: payment.success envia payment.succeeded, refund.success envia refund.succeeded e licence.created envia license_key.created.

Os formatos dos payloads simulados seguem os esquemas correspondentes na referência da API. Consulte Eventos de webhook para saber o que cada evento significa e quando o Dodo Payments o emite em produção.

payout.created é emitido enquanto o payout ainda apresenta o status not_initiated, portanto o payload simulado também reflete isso. Consulte Eventos de payout para conhecer todo o ciclo de vida do payout.

Variáveis de ambiente

Esta variável altera a forma como dodo wh listen se conecta:

Variável	Descrição
`DODO_WH_TEST_SERVER_URL`	Substitui o servidor de relay de webhook padrão usado por `dodo wh listen`. Defina um nome de host sem um esquema.

Atualizações

O CLI verifica uma versão mais recente na inicialização e exibe uma notificação na barra de status quando há uma disponível. Para atualizar uma instalação npm ou Bun pela TUI, execute:

/update

/update não pode atualizar um binário de versão. Para instalações binárias, incluindo as feitas pelo script de instalação, ele redireciona para a versão mais recente no GitHub. Para atualizar pelo shell, execute novamente o comando usado na instalação:

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

npm install -g dodopayments-cli

bun install -g dodopayments-cli

Recursos

GitHub Repository

Código-fonte e versões.

npm Package

O pacote dodopayments-cli no registro npm.

Suporte

Discord: Participe do servidor da comunidade.
GitHub: Abra uma issue no repositório.
E-mail: Entre em contato pelo endereço support@dodopayments.com.

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

Recursos

Instalação

Instalar com NPM ou Bun

Instalação manual (sem Node / Bun)

Autenticação

Alternar modos e sair

Uso

1. TUI interativa (recomendado)

2. Subcomandos diretos

Assistente de IA

Scaffolding do projeto

Referência de comandos

Produtos

Pagamentos

Clientes

Descontos

Licenças

Addons

Reembolsos

Checkout

Webhooks

Escutar webhooks

Disparar webhooks de teste

Eventos de webhook compatíveis

Variáveis de ambiente

Atualizações

Recursos

GitHub Repository

npm Package

Suporte

​Recursos

​Instalação

​Instalar com NPM ou Bun

​Instalação manual (sem Node / Bun)

​Autenticação

​Alternar modos e sair

​Uso

​1. TUI interativa (recomendado)

​2. Subcomandos diretos

​Assistente de IA

​Scaffolding do projeto

​Referência de comandos

​Produtos

​Pagamentos

​Clientes

​Descontos

​Licenças

​Addons

​Reembolsos

​Checkout

​Webhooks

​Escutar webhooks

​Disparar webhooks de teste

​Eventos de webhook compatíveis

​Variáveis de ambiente

​Atualizações

​Recursos

GitHub Repository

npm Package

​Suporte

Recursos

Instalação

Instalar com NPM ou Bun

Instalação manual (sem Node / Bun)

Autenticação

Alternar modos e sair

Uso

1. TUI interativa (recomendado)

2. Subcomandos diretos

Assistente de IA

Scaffolding do projeto

Referência de comandos

Produtos

Pagamentos

Clientes

Descontos

Licenças

Addons

Reembolsos

Checkout

Webhooks

Escutar webhooks

Disparar webhooks de teste

Eventos de webhook compatíveis

Variáveis de ambiente

Atualizações

Recursos

Suporte