AbacatePay CLI

CLI oficial da AbacatePay para autenticação, recebimento de webhooks e simulação de pagamentos em modo de desenvolvimento.

_{Instalação • Uso rápido • Autenticação • Webhooks • Pagamentos em dev mode}

Instalação

Script de instalação (Linux e macOS)

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

Baixa o binário abacatepay do último release publicado, valida o checksum e instala em /usr/local/bin (use ABACATEPAY_INSTALL_DIR=<dir> para instalar em outro lugar).

Go

go install github.com/AbacatePay/abacatepay-cli/cmd/abacatepay@latest

Isso instala o binário abacatepay.

O comando antigo também funciona, mas instala o binário com o nome do repositório:

go install github.com/AbacatePay/abacatepay-cli@latest
# binário: abacatepay-cli

Binários prontos

Os releases publicam binários para Linux, macOS e Windows nas arquiteturas amd64 e arm64 em Releases.

Uso rápido

abacatepay login
abacatepay listen --forward-to http://localhost:3000/webhooks/abacatepay
abacatepay payments simulate <charge-id>

Use abacatepay <command> -h para ver as flags de cada comando.

Autenticação

abacatepay login

Abre um link no navegador para você aprovar o acesso da CLI na sua conta. O token da sessão fica salvo no keyring nativo do sistema operacional. Se nenhum nome for informado com --name, a CLI usa o perfil default.

Para sair: abacatepay logout.

Webhooks

Receba eventos da AbacatePay e encaminhe para sua aplicação local:

abacatepay listen --forward-to http://localhost:3000/webhooks/abacatepay

--forward-to define a URL local que receberá os eventos (padrão: http://localhost:3000/webhooks/abacatepay).

A CLI só recebe eventos de contas/cobranças em devMode — produção nunca chega no relay. A CLI assina os eventos encaminhados com o header X-Webhook-Signature, usando a mesma chave pública HMAC documentada em Segurança de Webhooks. Essa chave é fixa — a verificação que você já implementou seguindo a documentação funciona sem alteração.

Pagamentos em dev mode

Simule o pagamento de uma cobrança transparente criada com uma chave de dev mode:

abacatepay payments simulate <charge-id>

Esse comando chama a API v2:

POST /v2/transparents/simulate-payment?id=<charge-id>

Ele só funciona para cobranças em devMode. Em produção, o pagamento precisa acontecer pelo fluxo real.

Output

A flag global --output permite trocar o formato de saída:

abacatepay payments simulate <charge-id> --output json

Formatos disponíveis: text, json e table.

Escopo atual

Para manter a CLI simples e alinhada com a API v2, o escopo atual é:

• login/logout;
• receber webhooks;
• simular pagamento de cobranças transparentes em dev mode.

Recursos fora desse escopo foram removidos da codebase até existir paridade clara com a API v2 e documentação atualizada.