Uso

Sintaxis

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

• <producto> — banking, finance, billing, inbox, dunning o dashboards.
• <recurso> — puede ser anidado: entities, entities records, builder tools create-page.
• <metodo> — la acción: list, get, create, update, delete, o una acción específica del recurso (sync, rotate, verify...).

La versión de la API nunca entra en el comando — el CLI resuelve la URL a partir de la spec OpenAPI embebida.

Los parámetros de ruta, de query y de encabezado (como X-Workspace-Id) van en --params; el cuerpo de la solicitud va en --json.

Toda la superficie se descubre con --help, en cualquier nivel:

kobana --help                       # productos
kobana dashboards --help            # recursos de Dashboard Mágico
kobana dashboards entities --help   # métodos de un recurso

Recursos de dashboards

Recurso	Descripción
data-sources	Fuentes de datos
entities	Entidades
workspaces	Workspaces
builder	Constructor del portal
portal-settings	Configuración del portal
portal-custom-domains	Dominios propios
portal-oauth-providers	Proveedores OIDC
portal-users	Usuarios del portal
portal-user-mappings	Mapeo de usuarios del portal
checklists	Checklists
comments	Comentarios
assets	Archivos
asset-types	Tipos de archivo
email-templates	Plantillas de correo
email-layouts	Diseños de correo
notifications	Notificaciones
webhooks	Webhooks
webhook-deliveries	Entregas de webhook
events	Eventos
api-keys	Claves de API
dashboard-users	Miembros
team-roles	Roles
permissions	Permisos
organization	Organización
settings	Configuración
me	Identidad del token
usage	Consumo
ai-usage	Uso de IA
rate-limits	Límites de solicitudes
audit-logs	Auditoría
exports	Exportaciones
imports	Importaciones
backups	Copias de seguridad
data-purges	Limpieza de datos
maintenance	Mantenimiento

Cada recurso tiene su propia página, con la tabla completa de comandos y ejemplos — mira el catálogo.

Ejemplos

# Fuentes de datos y el estado de cada una
kobana dashboards data-sources list --fields "id,name,kind,status,last_synced_at"

# Sincronizar una fuente ahora
kobana dashboards data-sources sync --dry-run --params '{"id": "DATA_SOURCE_ID"}'

# Registros de una entidad, del vencimiento más reciente al más antiguo
kobana dashboards entities records list \
  --params '{"id": "ENTITY_ID", "limit": 100, "sort": "due_date:desc"}'

# Usuarios del portal de otro workspace
kobana dashboards portal-users list \
  --params '{"X-Workspace-Id": "WORKSPACE_ID"}' \
  --fields "id,email,tenant_id,status"

# Listar con paginación automática (NDJSON)
kobana dashboards portal-users list --page-all --fields "id,email,tenant_id"

# Salida en tabla
kobana dashboards workspaces list --output-format table

# Guardar la respuesta en un archivo
kobana dashboards workspaces export --params '{"id": "WORKSPACE_ID"}' --output workspace.json

Próximos pasos

• Introspección de schema — inspecciona parámetros y cuerpo de cualquier endpoint.
• Flags globales — todas las flags que acepta un comando.
• Helpers — atajos +verbo para flujos comunes.
• Recursos — el catálogo completo, recurso por recurso.