https://github.com/AbacatePay/abacatepay-cli
AbacatePay’s developer-first CLI for APIs and local workflows
https://github.com/AbacatePay/abacatepay-cli
abacatepay cli payments webhooks
Last synced: 3 months ago
JSON representation
AbacatePay’s developer-first CLI for APIs and local workflows
- Host: GitHub
- URL: https://github.com/AbacatePay/abacatepay-cli
- Owner: AbacatePay
- License: other
- Created: 2024-11-18T12:36:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-30T14:30:29.000Z (5 months ago)
- Last Synced: 2026-01-31T05:26:05.149Z (5 months ago)
- Topics: abacatepay, cli, payments, webhooks
- Language: Go
- Homepage: https://docs.abacatepay.com
- Size: 17.7 MB
- Stars: 31
- Watchers: 6
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-abacatepay - CLI - AbacatePay CLI para rodar os seus Webhooks localmente. (Ecossistema)
README
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)
```bash
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)
```bash
brew install --build-from-source github.com/AbacatePay/abacatepay-cli
```
Uso Rápido
```bash
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:
```bash
abacatepay [...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)
```bash
# 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
```bash
# 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)
```bash
# 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
```bash
# 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.