Introdução
kobana é a ferramenta de linha de comando das APIs dos produtos Kobana, o Gateway Bancário incluído. Ela é mantida em repositório próprio (kobana-cli) e os comandos de recurso não são escritos à mão: na inicialização, ela lê as specs OpenAPI embutidas no binário e monta a árvore de comandos a partir delas. Só os helpers +verbo são escritos à mão.
kobana <produto> <recurso> <metodo> [flags]
O CLI foi pensado tanto para pessoas quanto para agentes de IA: saída JSON por padrão, introspecção de schema, --dry-run e paginação automática.
Produtos
| Produto | Descrição |
|---|---|
banking | Gateway Bancário: cobranças, pagamentos, transferências (API v1 e v2) |
finance | Financeiro Inteligente: contas, lançamentos, fluxo de caixa |
billing | Faturamento Automático: assinaturas, planos, faturas |
inbox | Inbox Autônomo: caixas de entrada, agentes, e-mails, webhooks |
O produto banking fala com a mesma API documentada neste site, nas versões v1 e v2. A versão nunca entra no comando: /v1/bank_billets vira kobana banking bank-billets, e /v2/charge/pix vira kobana banking charge pix. Os recursos estão no catálogo.
Começando
-
Instale. Veja Instalação.
-
Autentique-se com
kobana auth loginou com um token emKOBANA_TOKEN. Veja Autenticação. -
Faça a primeira chamada, no sandbox:
kobana banking bank-billets list --env sandbox --output-format table -
Explore a superfície. Todo comando aceita
--help, ekobana schemamostra o caminho, os parâmetros e a descrição de qualquer endpoint sem sair do terminal.
CLI ou MCP?
O CLI é para scripts, automações e agentes que rodam comandos de terminal. Para conectar um assistente de IA (Claude, ChatGPT, uma IDE) direto à conta, sem terminal, use o servidor MCP. Os dois chamam os mesmos recursos.
Próximos passos
- Instalação: Homebrew, binários prontos, Nix e build a partir do código-fonte.
- Autenticação: login OAuth, token e ambientes.
- Uso: sintaxe, recursos e exemplos.
- Introspecção de schema: parâmetros e formato de requisição e resposta.
- Flags globais: as flags que todo comando aceita.
- Helpers: atalhos
+verbopara emitir boleto, cobrar Pix e cancelar em lote. - Variáveis de ambiente: autenticação, configuração e logs.
- Códigos de saída: para scripts.