Flags globales
| Flag | Descripción |
|---|---|
--params '<JSON>' | Parámetros de query y de URL (id, página, filtros) |
--json '<JSON>' | Cuerpo de la solicitud (POST/PUT/PATCH) |
--fields '<CAMPOS>' | Limita los campos que vuelven en la respuesta |
--dry-run | Muestra la solicitud 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> | Entorno: production (por defecto) o development |
--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 |
--dry-run muestra el método, la URL, la query y el cuerpo de la solicitud sin enviarla. Úselo antes de toda acción que modifica datos, dispara el agente o elimina. No valida el cuerpo contra la especificación: un campo obligatorio faltante solo aparece en la respuesta de la API (400 VALIDATION_ERROR).
Paginación. Los listados son por cursor. Con --page-all, la CLI sigue meta.next_cursor hasta la última página e imprime un ítem por línea (NDJSON). limit en --params define el tamaño de cada página (hasta 100). Las reglas son las de la Paginación de la API.
Idempotencia. Todo POST, PUT y PATCH lleva un X-Idempotency-Key; la CLI genera una clave nueva en cada comando. Para repetir con seguridad una llamada que falló a mitad de camino (el disparo de una tarea, por ejemplo), pase la misma clave las dos veces con --idempotency-key. Las reglas están en Idempotencia.
Próximos pasos
- Uso — sintaxis, recursos, ejemplos.
- Introspección de schema — parámetros, campos obligatorios, tipos y respuestas.