Dodo CLI

A interface oficial de linha de comando para Dodo Payments — gerencie recursos, execute consultas com inteligência artificial, crie sessões de checkout e teste webhooks a partir do seu terminal.

Gerencie seus recursos de Dodo Payments, execute consultas com inteligência artificial na sua conta, crie sessões de checkout e teste webhooks — tudo a partir do terminal. O CLI é fornecido com uma TUI interativa, um assistente AI integrado com tecnologia MCP e testes de webhooks offline.

​

Recursos

• TUI interativa — execute dodo sem argumentos para abrir a interface interativa completa com paleta de comandos, histórico e notificações ao vivo.
• Assistente AI embutido — faça perguntas ou execute ações em inglês simples com /ai. Nenhuma configuração extra, executa dodopayments-mcp localmente.
• Seguro por padrão — Chaves de API são armazenadas no armazenamento de segredos do seu SO (macOS Keychain, Windows Credential Vault, Linux libsecret). Nenhuma configuração em plaintext no disco.
• Atualização automática — o CLI verifica novas versões na inicialização e notifica você no aplicativo. Execute /update para atualizar no local.
• Ferramentas de webhook — ouça webhooks ao vivo ou dispare cargas úteis offline para desenvolvimento local.

​

Instalação

Instale o CLI em uma linha no macOS ou Linux:

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

​

Instalar com npm ou Bun

Se você já possui Node ou Bun, as instalações de gerenciadores de pacotes sempre puxam a versão mais recente:

npm

npm install -g dodopayments-cli

​

Instalação manual (sem Node / Bun necessário)

Se preferir não conduzir um script remoto para sh, baixe o binário você mesmo.

1. Download the binary

   Baixe o binário para sua plataforma a partir da última GitHub Release.

   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

2. Rename the binary to `dodo`

   Linux / macOS

   mv ./dodo-cli-* ./dodo && chmod +x ./dodo
   
3. Move it to a directory on your PATH

   Linux / macOS

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

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

4. (Optional) Verify the download

   Cada lançamento publica um SHA256SUMS.txt. Verifique seu download com:

   shasum -a 256 -c SHA256SUMS.txt
   

​

Autenticação

Antes de usar comandos autenticados, faça login com sua chave API:

dodo login

Ou, de dentro da TUI interativa:

/login

O fluxo de login irá:

1. Abrir seu navegador na página de Chaves API do Dodo Payments.
2. Solicitar que você cole sua Chave API.
3. Pedir que você selecione um ambiente — Modo de Teste ou Modo ao Vivo.
4. Armazenar as credenciais no armazenamento de segredos do seu SO (Keychain no macOS, Credential Vault no Windows, libsecret no Linux).

Como as credenciais são armazenadas no armazenamento de segredos do SO, pode ser solicitado que você insira sua senha do dispositivo na primeira vez que o CLI lê ou escreve credenciais. Se você estiver atualizando de uma versão mais antiga, qualquer chave de API em plaintext existente será migrada para o armazenamento de segredos e o arquivo legado excluído automaticamente.

​

Alternando modos e desconectando

Você pode manter uma chave autenticada para Modo de Teste e outra para Modo ao Vivo ao mesmo tempo. Para limpar credenciais:

Direct

dodo logout

O fluxo de logout permite que você escolha entre Todas as contas, Modo de Teste, ou Modo ao Vivo de forma independente.

​

Uso

Você pode usar o CLI em dois modos.

​

1. TUI interativa (recomendada)

Execute dodo sem argumentos para iniciar a interface interativa completa:

dodo

Digite / para abrir a paleta de comandos, ou simplesmente comece a digitar — qualquer coisa que não seja um comando de barra é enviada para o assistente AI.

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	Desconectar de um ou de todos os ambientes
/clear	Limpar a tela da TUI
/exit	Sair da TUI (também: digite exit, ou pressione Esc duas vezes)

​

2. Subcomandos diretos

Execute comandos diretamente sem entrar na TUI:

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

Por exemplo:

dodo payments list 1
dodo customers create
dodo wh trigger

As tabelas de referência abaixo mostram todos os comandos. Na TUI, prefira-os com /; no modo direto, descarte o /.

​

Assistente AI

Faça perguntas ou aja em linguagem natural. O assistente usa dodopayments-mcp rodando localmente — sem necessidade de configuração adicional ou fluxo OAuth, e seu tráfego AI não sai da sua máquina, exceto para se comunicar com o provedor do modelo.

Comando	Descrição
/ai <query>	Fazer uma pergunta ao assistente AI ou dar uma instrução
(qualquer texto não-slash)	Enviado para o assistente AI por padrão enquanto estiver na TUI

Exemplos:

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

O assistente respeita seu ambiente ativo (Teste / Ao Vivo), então ele opera apenas em dados do ambiente em que você está logado.

​

Referência de Comandos

​

Produtos

Gerencie seu catálogo de produtos.

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

​

Pagamentos

Visualizar 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 sua base de clientes.

Comando	Descrição
dodo customers list <page>	Listar clientes
dodo customers create	Criar um novo cliente
dodo customers update <id>	Atualizar um cliente existente

​

Descontos

Gerencie cupons e descontos.

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

​

Licenças

Gerencie licenças de software.

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

​

Addons

Gerencie complementos de produto.

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

​

Reembolsos

Visualize 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

​

Webhooks

O CLI inclui duas ferramentas poderosas para testar webhooks durante o desenvolvimento: um ouvinte que encaminha webhooks de teste ao vivo para seu servidor local, e um gatilho que envia cargas úteis de webhook simuladas para qualquer endpoint.

Comando	Descrição
dodo wh listen	Ouça webhooks em tempo real e encaminhe-os para seu servidor local de desenvolvimento
dodo wh trigger	Disparar um evento de webhook de teste de forma interativa — até mesmo se você estiver desconectado

​

Ouça webhooks

Encaminhe webhooks do Dodo Payments diretamente para seu servidor de desenvolvimento local em tempo real.

dodo wh listen

1. Enter your local endpoint URL

   Forneça a URL local onde deseja receber webhooks (por exemplo, http://localhost:3000/webhook).

2. Automatic setup

   O CLI cria automaticamente um endpoint de webhook na sua conta Dodo Payments se um não existir, e depois abre uma conexão WebSocket para receber eventos em tempo real.

3. Receive and forward

   Quando um evento de webhook é acionado (a partir de um pagamento de teste, mudança de assinatura, etc.), o CLI o recebe, registra o tipo de evento e encaminha a solicitação completa com cabeçalhos e corpo para o endpoint local. A resposta do seu endpoint é registrada e enviada de volta.

dodo wh listen requer uma chave de API de Modo de Teste. Chaves do modo ao vivo não são suportadas pelo fluxo de escuta.

O ouvinte preserva os cabeçalhos originais do webhook (webhook-id, webhook-signature, webhook-timestamp) ao encaminhar para seu endpoint local, para que você possa testar sua lógica de verificação de assinaturas.

​

Disparar webhooks de teste

Envie cargas úteis de webhook simuladas para qualquer endpoint para testes rápidos sem precisar criar transações reais.

dodo wh trigger

O fluxo /wh trigger guia você por:

1. Definindo uma URL endpoint de destino
2. Selecionando um evento específico para desencadear de um menu interativo

dodo wh trigger não requer login. Ele funciona como um gerador de cargas úteis de webhook local/offline.

Os eventos gatilhados não são assinados. Durante os testes, desative a verificação de assinatura de webhook em seu endpoint — por exemplo, use unsafe_unwrap() em vez de unwrap() em seu manipulador de webhook somente durante os testes.

​

Eventos de webhook suportados

Categoria	Eventos
Assinatura	active, updated, on_hold, renewed, plan_changed, cancelled, failed, expired
Pagamento	succeeded, failed, processing, cancelled
Reembolso	succeeded, failed
Disputa	opened, expired, accepted, cancelled, challenged, won, lost
Licença	created

​

Variáveis de ambiente

Variável	Descrição
DODO_WH_TEST_SERVER_URL	Sobrescrever o URL do servidor de retransmissão de webhook padrão usado por dodo wh listen

​

Atualizações

O CLI verifica por uma versão mais recente na inicialização e mostra uma notificação na barra de status quando uma está disponível. Para atualizar:

/update

Ou, execute novamente o instalador para atualizar no local:

install.sh

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

​

Recursos

GitHub Repository

View source code and releases

npm Package

View on npm registry

​

Suporte

• Discord: Junte-se ao nosso servidor da comunidade
• GitHub: Abra um problema no repositório
• Email: Contate-nos através de [e-mail]