Uso

Sintaxe

kobana <produto> <recurso> <metodo> [flags]

• <produto> — banking, finance, billing, inbox, dunning ou dashboards.
• <recurso> — pode ser aninhado: entities, entities records, builder tools create-page.
• <metodo> — a ação: list, get, create, update, delete, ou uma ação específica do recurso (sync, rotate, verify...).

A versão da API nunca entra no comando — o CLI resolve a URL a partir da spec OpenAPI embutida.

Parâmetros de caminho, de query e de cabeçalho (como X-Workspace-Id) vão em --params; o corpo da requisição vai em --json.

Toda a superfície é descoberta pelo --help, em qualquer nível:

kobana --help                       # produtos
kobana dashboards --help            # recursos do Dashboard Mágico
kobana dashboards entities --help   # métodos de um recurso

Recursos de dashboards

Recurso	Descrição
data-sources	Fontes de dados
entities	Entidades
workspaces	Workspaces
builder	Construtor do portal
portal-settings	Configurações do portal
portal-custom-domains	Domínios próprios
portal-oauth-providers	Provedores OIDC
portal-users	Usuários do portal
portal-user-mappings	Mapeamento de usuários do portal
checklists	Checklists
comments	Comentários
assets	Arquivos
asset-types	Tipos de arquivo
email-templates	Modelos de e-mail
email-layouts	Layouts de e-mail
notifications	Notificações
webhooks	Webhooks
webhook-deliveries	Entregas de webhook
events	Eventos
api-keys	Chaves de API
dashboard-users	Membros
team-roles	Funções
permissions	Permissões
organization	Organização
settings	Configurações
me	Identidade do token
usage	Consumo
ai-usage	Uso de IA
rate-limits	Limites de requisição
audit-logs	Auditoria
exports	Exportações
imports	Importações
backups	Backups
data-purges	Limpeza de dados
maintenance	Manutenção

Cada recurso tem a sua própria página, com a tabela completa de comandos e exemplos — veja o catálogo.

Exemplos

# Fontes de dados e o estado de cada uma
kobana dashboards data-sources list --fields "id,name,kind,status,last_synced_at"

# Sincronizar uma fonte agora
kobana dashboards data-sources sync --dry-run --params '{"id": "DATA_SOURCE_ID"}'

# Registros de uma entidade, do vencimento mais recente ao mais antigo
kobana dashboards entities records list \
  --params '{"id": "ENTITY_ID", "limit": 100, "sort": "due_date:desc"}'

# Usuários do portal de outro workspace
kobana dashboards portal-users list \
  --params '{"X-Workspace-Id": "WORKSPACE_ID"}' \
  --fields "id,email,tenant_id,status"

# Listar com paginação automática (NDJSON)
kobana dashboards portal-users list --page-all --fields "id,email,tenant_id"

# Saída em tabela
kobana dashboards workspaces list --output-format table

# Salvar a resposta em arquivo
kobana dashboards workspaces export --params '{"id": "WORKSPACE_ID"}' --output workspace.json

Próximos passos

• Introspecção de schema — inspecione parâmetros e corpo de qualquer endpoint.
• Flags globais — todas as flags que um comando aceita.
• Helpers — atalhos +verbo para fluxos comuns.
• Recursos — o catálogo completo, recurso a recurso.