Flags globales
| Flag | Descripción |
|---|---|
--params '<JSON>' | Parámetros de query, de ruta y de encabezado (id, página, filtros, X-Workspace-Id) |
--json '<JSON>' | Cuerpo de la solicitud (POST/PUT/PATCH) |
--fields '<CAMPOS>' | Limita los campos que vuelven en la respuesta |
--dry-run | Muestra la solicitud (URL, query, encabezados y cuerpo) sin ejecutarla |
--page-all | Paginación automática, con salida en NDJSON |
--page-limit <N> | Máximo de páginas (por defecto: 10) |
--page-delay <MS> | Intervalo entre páginas (por defecto: 100ms) |
--env <ENV> | Ambiente. Dashboard Mágico solo tiene production (por defecto) |
--verbose | Detalles de la solicitud en stderr |
--output <PATH> | Guarda la respuesta en un archivo |
--output-format <FMT> | Formato: json, table, csv |
--idempotency-key <KEY> | Clave de idempotencia personalizada |
--lang <IDIOMA> | Idioma de los mensajes: pt, en o es (predeterminado: el del sistema) |
Encabezados en --params
Una clave de --params que el endpoint declara como encabezado se envía como encabezado, no en la URL. Así se cambia de workspace en una sola llamada — --params '{"X-Workspace-Id": "WORKSPACE_ID"}' —, con precedencia sobre KOBANA_WORKSPACE_ID. kobana schema lista esos encabezados en header_params.
Paginación
Los listados de Dashboard Mágico paginan con page/per_page, y es con ellos que funciona --page-all. Las excepciones paginan por su cuenta — pasa los parámetros en --params: entities records list usa limit/offset, y portal-users activity timeline list usa limit y el cursor before.
Idioma
El CLI habla portugués, inglés o español: ayuda, mensajes, errores y las descripciones de los comandos. El idioma viene, en este orden, de --lang, de la variable KOBANA_LANG, de las variables de idioma de la terminal (LC_ALL, LC_MESSAGES, LANG) y, por último, del idioma del sistema.
kobana --lang en dashboards --help
export KOBANA_LANG=pt
Los nombres de comandos y flags, las claves del JSON y los códigos de salida no cambian con el idioma. Disponible desde la versión 0.6.0.
Próximos pasos
- Uso — sintaxis, recursos, ejemplos.
- Introspección de schema — parámetros, campos obligatorios, tipos y respuestas.