AbacatePay CLI

CLI oficial do AbacatePay para desenvolvimento local, webhooks e testes rápidos via terminal.

_{Instalação • Uso • Autenticação • Ambientes}

Instalação

Go (recomendado)

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

O binário automáticamente será instalado como abacatepay com um aliás abkt.

Homebrew (macOS / Linux)

brew install --build-from-source github.com/AbacatePay/abacatepay-cli

Uso Rápido

abacatepay login

Após a autenticação (OAuth Device Flow), você deve informar a URL do seu servidor local, então a CLI encaminhará todos os webhooks para você.

Todos os comandos podem ser usados com a seguinte sintaxe:

abacatepay <command> [...flags] [...args]

Use a flag -h para obter informações detalhadas sobre cada comando.

Ambientes

Atualmente a CLI suporta dois ambientes, o de produção (Padrão) e teste.

Produção (Padrão)

# API: https://api.abacatepay.com
# WebSocket: wss://ws.abacatepay.com/ws

abacatepay login

Servidor de Teste

Para usar o modo de desenvolvimento, use a flag -l

# API: http://191.252.202.128:8080
# WebSocket: ws://191.252.202.128:8080/ws

abacatepay login -l

Autenticação

A CLI usa OAuth2 Device Flow, sem necessidade de copiar tokens manualmente, apenas seguindo o fluxo abaixo

1. Use abacatepay login
2. Abra a URL exibida no navegador
3. Autorize o acesso na sua conta AbacatePay
4. A CLI detecta a autorização automaticamente
5. Informe a URL para encaminhar webhooks (Ou pressione a tecla Enter para usar o padrão)

Armazenamento

O token da sua conta é armazenado com segurança no keyring nativo do seu sistema operacional:

• macOS: Keychain
• Linux: gnome-keyring ou kwallet
• Windows: Credential Manager

Caso o token não consiga ser salvo, você deverá instalar o keyring no seu sistema operacional (Linux)

# Debian/Ubuntu
sudo apt install gnome-keyring

# Fedora
sudo dnf install gnome-keyring

Logs

Todos os logs são salvos ni caminho ~/.abacatepay/logs/ com uma rotação automática de 10mb por arquivo, 5 backups e 30 dias de retenção

• abacatepay.log - Log geral (JSON)
• transactions.log - Webhooks recebidos e encaminhados

Use jq para analisar os logs

# Erros
cat ~/.abacatepay/logs/abacatepay.log | jq 'select(.level=="ERROR")'

# Webhooks recebidos
cat ~/.abacatepay/logs/transactions.log | jq 'select(.msg=="webhook_received")'

# Tempo médio de encaminhamento
cat ~/.abacatepay/logs/transactions.log | jq 'select(.msg=="webhook_forwarded") | .duration_ms' | jq -s 'add/length'

Documentação

Para uma documentação completa, veja a documentação oficial.