Uso

Sintaxe

kobana <produto> <recurso> <método> [flags]

Produtos disponíveis:

Produto	Descrição
banking	Gateway Bancário — cobranças, pagamentos, transferências (API v1 e v2)
finance	Financeiro Inteligente — contas a pagar e a receber, lançamentos, fluxo de caixa
billing	Faturamento Automático — assinaturas, planos, faturas, notas fiscais
inbox	Inbox Autônomo — inboxes, agents, e-mails, webhooks (API v1)

O produto inbox tem API, credenciais e requisitos próprios — veja Autenticação.

Recursos de topo do produto banking (a versão da API — v1 ou v2 — é resolvida a partir da spec, nunca aparece no comando):

Comando	Descrição
charge	Cobranças — Pix, Pix automático
payment	Pagamentos — boletos, Pix, taxas, concessionárias
transfer	Transferências — Pix, TED, interna
financial	Financeiro — contas, saldos, extratos
admin	Administração — subcontas, usuários
mailbox	Caixa postal — EDI, arquivos
data	Consultas — boletos, QR codes Pix
security	Tokens de acesso
bank-billets, customers, webhooks, …	Boletos, clientes e demais recursos da API v1

Recursos do inbox: workspaces, inboxes, emails, agents, agent-runs, webhooks, system-events — cada um mapeia para o modelo equivalente na Referência da API.

Use kobana <produto> --help para a lista completa.

Exemplos

# Listar boletos com filtro
kobana banking bank-billets list \
  --params '{"status": "opened", "per_page": 25}' \
  --fields "id,amount,status,due_at"

# Criar cobrança Pix
kobana banking charge pix create \
  --json '{"amount": 99.90, "pix_account_uid": "UID"}'

# Consultar saldo
kobana banking financial accounts balances list \
  --params '{"financial_account_uid": "UID"}'

# Transferência Pix
kobana banking transfer pix create \
  --json '{"amount": 500, "pix_key": "email@example.com"}'

# Listar com paginação automática (NDJSON)
kobana banking charge pix list --page-all --fields "uid,amount,status"

# Ver detalhes de um boleto
kobana banking bank-billets get --params '{"id": 12345}'

# Cancelar boleto
kobana banking bank-billets cancel --params '{"id": 12345}'

# Dry-run — ver a requisição sem executar
kobana banking charge pix create --json '{"amount": 100}' --dry-run

# Saída em tabela
kobana banking bank-billets list --output-format table

# Salvar resposta em arquivo
kobana banking bank-billets get --params '{"id": 12345}' --output boleto.json

Inbox Autônomo

kobana inbox emails list --fields "id,subject,received_at"

kobana inbox webhooks deliveries replay \
  --params '{"id": "WEBHOOK_ID", "deliveryId": "DELIVERY_ID"}'

Próximos passos

• Introspecção de schema — inspecione os parâmetros e o corpo de qualquer endpoint.
• Flags globais — todas as flags que um comando aceita.
• Helpers — atalhos +verbo para operações comuns.