Flags globais
| Flag | Descrição |
|---|---|
--params '<JSON>' | Parâmetros de query e de URL (id, página, filtros) |
--json '<JSON>' | Corpo da requisição (POST/PUT/PATCH) |
--fields '<CAMPOS>' | Limita os campos que voltam na resposta |
--dry-run | Mostra a requisição 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: production (padrão) ou development |
--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 |
--dry-run mostra o método, a URL, a query e o corpo da requisição sem enviá-la. Use-o antes de toda ação que altera dados, dispara o agente ou apaga. Ele não valida o corpo contra a especificação: campo obrigatório faltando só aparece na resposta da API (400 VALIDATION_ERROR).
Paginação. As listagens são por cursor. Com --page-all, o CLI segue o meta.next_cursor até a última página e imprime um item por linha (NDJSON). limit em --params define o tamanho de cada página (até 100). As regras são as da Paginação da API.
Idempotência. Todo POST, PUT e PATCH leva um X-Idempotency-Key; o CLI gera uma chave nova a cada comando. Para repetir com segurança uma chamada que falhou no meio (o disparo de uma tarefa, por exemplo), passe a mesma chave nas duas vezes com --idempotency-key. As regras estão em Idempotência.
Próximos passos
- Uso — sintaxe, recursos, exemplos.
- Introspecção de schema — parâmetros, campos obrigatórios, tipos e respostas.