Skip to main content
A Avantti CLI permite interagir com toda a infraestrutura da Avantti diretamente do terminal. Crie cobranças, escute webhooks, gerencie contas, automatize fluxos financeiros e integre sistemas com velocidade e previsibilidade.

​
Visão geral

A CLI foi construída para desenvolvedores que precisam:
  • Automatizar operações financeiras
  • Integrar sistemas rapidamente
  • Escutar eventos em tempo real
  • Executar rotinas em CI/CD
  • Trabalhar localmente sem complexidade
  • Ter output estruturado para scripts

​
Filosofia

A Avantti CLI foi criada para ser:
  • Explícita
  • Scriptável
  • Unix-friendly
  • Rápida
  • Previsível
  • Compatível com automações
  • AI-ready

​
Instalação

go install github.com/avanttifinance/avantti-cli@latest
Verifique a instalação: 
avantti --version

​
Primeiros passos

1

Login

avantti login
O navegador será aberto para autenticação segura.
2

Configurar ambiente

avantti env use sandbox
3

Escutar webhooks

avantti listen --forward-to http://localhost:3000/webhooks
4

Criar pagamento PIX

avantti payments create pix \
  --amount 5000 \
  --customer "João Silva"

​
Estrutura da CLI

ComandoDescrição
authAutenticação e sessões
paymentsGerenciamento de pagamentos
customersClientes
subscriptionsAssinaturas
listenEscutar webhooks
logsLogs e debugging
configConfiguração da CLI
envAmbientes
webhooksGerenciamento de webhooks

​
Referência de comandos

​
Autenticação

avantti login

​
Ambientes

avantti env use sandbox

​
Pagamentos

avantti payments create pix \
  --amount 5000 \
  --customer "João Silva"

​
Clientes

avantti customers create \
  --name "João Silva" \
  --email "joao@email.com"

​
Assinaturas

avantti subscriptions create \
  --customer cus_123456 \
  --plan premium

​
Webhooks

avantti listen \
  --forward-to http://localhost:3000/webhooks

​
Logs

avantti logs tail

​
Configuração

avantti config list

​
Output

​
Output padrão

avantti payments list

​
Output JSON

avantti payments list --output json
Exemplo
{
  "success": true,
  "data": [
    {
      "id": "pay_123456",
      "status": "approved",
      "amount": 5000
    }
  ]
}

​
Flags globais

FlagAliasDescrição
--help-hAjuda
--version-vVersão
--output-otext, json ou table
--sandbox-sUsa ambiente sandbox
--verboseLogs detalhados

​
Automação

A CLI foi construída para funcionar perfeitamente em automações. 
PAYMENT_ID=$(avantti payments create pix \
  --amount 5000 \
  --output json | jq -r '.data.id')

echo $PAYMENT_ID

​
Segurança

A Avantti CLI utiliza:
  • Tokens seguros
  • Sessões criptografadas
  • HTTPS obrigatório
  • Rotação de credenciais
  • Ambientes isolados

​
Troubleshooting

avantti config reset

avantti logout

avantti logs tail --verbose

​
Atualização

brew upgrade avantti-cli

​
Referência completa

ComandoDescrição
avantti loginLogin
avantti logoutLogout
avantti whoamiUsuário atual
avantti env useAlterar ambiente
avantti payments createCriar pagamento
avantti payments listListar pagamentos
avantti customers createCriar cliente
avantti subscriptions createCriar assinatura
avantti listenEscutar webhooks
avantti logs tailLogs em tempo real
avantti config listVer configuração

​
Boas práticas

Use sandbox durante o desenvolvimento, nunca exponha chaves de produção, prefira output JSON em automações, utilize variáveis de ambiente e faça rotação periódica de credenciais.

​
Recursos relacionados e suporte

Referência da API

Explore todos os endpoints da API Avantti Finance

Webhooks

Configure e gerencie eventos em tempo real

SDKs

SDKs oficiais para Node.js, PHP, Python, Go e Java

Status Page

Acompanhe o status da plataforma em tempo real

Changelog

Veja as últimas atualizações da CLI e da API

Suporte por e-mail

suporte@avanttifinance.com

Discord da comunidade

Tire dúvidas com outros desenvolvedores

GitHub Issues

Reporte bugs e acompanhe o desenvolvimento
A Avantti CLI foi construída para acelerar integrações financeiras modernas com foco em velocidade, automação e experiência de desenvolvimento.