Flags globais
Todo comando aceita estas flags:
| Flag | Descrição |
|---|---|
--params '<JSON>' | Parâmetros de caminho e de query (id, uid, página, filtros), como objeto JSON |
--json '<JSON>' | Corpo da requisição (POST, PUT, PATCH) |
--fields '<CAMPOS>' | Campos a manter na resposta, separados por vírgula |
--dry-run | Mostra a requisição, sem executá-la |
--page-all | Pagina automaticamente e emite NDJSON, um registro por linha |
--page-limit <N> | Máximo de páginas com --page-all (padrão: 10) |
--page-delay <MS> | Intervalo entre páginas com --page-all (padrão: 100 ms) |
--env <ENV> | Ambiente: production (padrão), sandbox ou development |
--verbose | Detalhes da requisição e da resposta no stderr |
--output <PATH> | Salva a resposta num arquivo |
--output-format <FMT> | json (padrão), table ou csv |
--idempotency-key <KEY> | Chave de idempotência para POST, PUT e PATCH. Sem ela, o CLI gera uma para cada POST |
Paginação automática
--page-all vale para listagens (GET). Ele pede page=1, 2, 3… com per_page (50, se você não informar outro em --params) até receber uma página vazia ou com menos itens que per_page, ou até chegar a --page-limit. Com --output-format json, cada registro sai numa linha, em JSON, para ser processado em fluxo; com table ou csv, sai uma tabela por página. A saída vai sempre para o stdout, e --output não se aplica. Com --dry-run, --page-all é ignorado.
:::caution per_page acima de 50
A API devolve no máximo 50 itens por página. Com per_page maior, a primeira página volta com 50, menos do que o pedido, e a paginação para ali.
:::
kobana banking bank-billets list --page-all --page-limit 50 \
--params '{"status": "paid"}' | jq -r '.our_number'
--dry-run antes de escrever
--dry-run mostra o método, a URL, os parâmetros de query, o corpo e a chave de idempotência, sem enviar nada. Use antes de qualquer comando que emite, cancela, paga ou transfere, e sempre que um agente de IA montar o comando.
kobana banking transfer pix create --dry-run \
--json '{"amount": 150.0, "financial_account_uid": "FINANCIAL_ACCOUNT_UID"}'
Próximos passos
- Uso: sintaxe, recursos e exemplos.
- Introspecção de schema: parâmetros, campos obrigatórios, tipos e respostas.