Flags globais
| Flag | Descrição |
|---|---|
--params '<JSON>' | Parâmetros de query, de caminho e de cabeçalho (id, página, filtros, X-Workspace-Id) |
--json '<JSON>' | Corpo da requisição (POST/PUT/PATCH) |
--fields '<CAMPOS>' | Limita os campos que voltam na resposta |
--dry-run | Mostra a requisição (URL, query, cabeçalhos e corpo) sem executá-la |
--page-all | Paginação automática, com saída em NDJSON |
--page-limit <N> | Máximo de páginas (padrão: 10) |
--page-delay <MS> | Intervalo entre páginas (padrão: 100ms) |
--env <ENV> | Ambiente. O Dashboard Mágico só tem production (padrão) |
--verbose | Detalhes da requisição no stderr |
--output <PATH> | Salva a resposta em arquivo |
--output-format <FMT> | Formato: json, table, csv |
--idempotency-key <KEY> | Chave de idempotência customizada |
--lang <IDIOMA> | Idioma das mensagens: pt, en ou es (padrão: o do sistema) |
Cabeçalhos em --params
Uma chave de --params que o endpoint declara como cabeçalho vai no cabeçalho, não na URL. É assim que se troca de workspace numa chamada só — --params '{"X-Workspace-Id": "WORKSPACE_ID"}' —, com precedência sobre KOBANA_WORKSPACE_ID. kobana schema lista esses cabeçalhos em header_params.
Paginação
As listagens do Dashboard Mágico paginam por page/per_page, e é com elas que --page-all funciona. As exceções paginam por conta própria — passe os parâmetros em --params: entities records list usa limit/offset, e portal-users activity timeline list usa limit e o cursor before.
Idioma
O CLI fala português, inglês ou espanhol: ajuda, mensagens, erros e as descrições dos comandos. O idioma vem, nesta ordem, de --lang, da variável KOBANA_LANG, das variáveis de idioma do terminal (LC_ALL, LC_MESSAGES, LANG) e, por fim, do idioma do sistema.
kobana --lang en dashboards --help
export KOBANA_LANG=es
Nomes de comandos e flags, chaves do JSON e códigos de saída não mudam com o idioma. Disponível a partir da versão 0.6.0.
Próximos passos
- Uso — sintaxe, recursos, exemplos.
- Introspecção de schema — parâmetros, campos obrigatórios, tipos e respostas.