Skip to main content

Global Flags

Flags disponíveis em todos os comandos:
FlagAliasTipoPadrãoDescrição
--verbose-vboolfalseHabilita logging detalhado (nível debug)
--local-lboolfalseUsa servidor de teste
--output-ostringtextFormato de saída: text, json, table
# Exemplo combinando flags
abacatepay -v -l -o json payments create pix
A CLI suporta três formatos de saída, configuráveis via --output ou -o.

text (padrão)

Formato legível para uso interativo no terminal.
abacatepay whoami
╭───────────────────────────╮
│                           │
│  🥑 User Information      │
│                           │
│  Status: Authenticated    │
│  Profile: salve3          │
│  User: Mock User          │
│  Email: mock@example.com  │
│                           │
│                           │
╰───────────────────────────╯

json

Formato estruturado para scripts, pipelines e CI/CD.
abacatepay -o json whoami
{
  "profile": "salve3",
  "user": "Mock User",
  "email": "mock@example.com",
  "status": "authenticated"
}
Combine com jq para filtrar dados:
abacatepay -o json logs list | jq '.logs[] | select(.msg=="webhook_forwarded")'

table

Formato tabular para visualização de listas.
abacatepay -o table profile list
┌───────────┬────────────┬────────┐
│ Name      │ API Key    │ Active │
├───────────┼────────────┼────────┤
│ default   │ abc_prod...│ 🥑     │
│ staging   │ abc_dev... │        │
└───────────┴────────────┴────────┘

A CLI suporta dois ambientes: produção (padrão) e teste.

Produção (padrão)

abacatepay login
Conecta automaticamente com wss://ws.abacatepay.com/ws.

Servidor de Teste

abacatepay login -l
Conecta com o servidor de teste em ws://191.252.202.128:8080/ws.
O ambiente de teste usa dados fictícios. Nunca use credenciais reais no modo -l.

O token da sua conta é armazenado no keyring nativo do sistema:
  • macOS: Keychain
  • Windows: Credential Manager
  • Linux: gnome-keyring ou kwallet
Instale o keyring no seu sistema:
# Debian/Ubuntu
sudo apt install gnome-keyring

# Fedora
sudo dnf install gnome-keyring
Então tente novamente:
abacatepay login

Os logs são salvos em ~/.abacatepay/logs/:
  • abacatepay.log - Log geral (JSON)
  • transactions.log - Webhooks recebidos e encaminhados
Rotação automática: 10MB por arquivo, 5 backups, 30 dias de retenção.
# Ver erros
cat ~/.abacatepay/logs/abacatepay.log | jq 'select(.level=="ERROR")'

# Ver 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'