Skip to main content
A AbacatePay CLI é a ferramenta oficial de linha de comando para testar sua integração com a AbacatePay direto do terminal. Com ela você recebe na sua máquina os webhooks da sua conta em dev mode e simula o pagamento de cobranças — sem precisar expor sua aplicação local na internet.

​
Principais Capacidades

Autenticação

Login pelo navegador ou com API key, com múltiplos perfis.

Webhooks

Receba eventos de dev mode e encaminhe para sua aplicação local.

Pagamentos

Simule o pagamento de cobranças transparentes em dev mode.

Configuração

Flags globais, saída no terminal, credenciais e logs.

Utilitários

Versão instalada e atualização da CLI.

Casos de Uso

Fluxos práticos de desenvolvimento e automação.

​
Instalação

​
Script de instalação (Linux e macOS)

Baixa o binário abacatepay do último release publicado, valida o checksum e instala em /usr/local/bin. Para instalar em outro diretório, use ABACATEPAY_INSTALL_DIR:

​
Go

Use o caminho .../cmd/abacatepay. O comando go install github.com/AbacatePay/abacatepay-cli@latest também funciona, mas instala o binário com o nome abacatepay-cli.

​
Binários prontos

Os releases no GitHub publicam binários para Linux, macOS e Windows, nas arquiteturas amd64 e arm64. Verificar instalação:

​
Primeiros passos

1

Autentique-se

O navegador abrirá para você aprovar o acesso da CLI na sua conta.
2

Inicie o listener

Se você rodar apenas abacatepay listen, a CLI pergunta para qual URL encaminhar os eventos.
3

Crie uma cobrança de teste

Crie uma cobrança transparente com uma chave de dev mode — pela API ou por um dos SDKs — e anote o id retornado.
4

Simule o pagamento

Em outro terminal:
O webhook do pagamento aparece no terminal do listen e é encaminhado para sua aplicação.

​
Escopo atual

A CLI cobre o ciclo de desenvolvimento local com a API v2:
  • login e logout;
  • receber webhooks de dev mode e encaminhar para sua aplicação;
  • simular o pagamento de cobranças transparentes em dev mode;
  • atualizar a própria CLI.
A CLI só recebe eventos de dev mode. Eventos de produção nunca são enviados para a CLI.

SDKs Oficiais

Bibliotecas oficiais para diferentes linguagens.

Repositório Open Source

Código-fonte, issues e contribuições.