--output-format para controlar como os resultados são exibidos no stdout:
| Formato | Flag | Quando usar |
|---|---|---|
| Pretty | --output-format pretty (padrão) | Para ler a saída em um terminal. Pares chave-valor alinhados com cor e indentação aninhada. |
| JSON | --output-format json | Para scripts, uso com jq, salvar em arquivo. Mantém a ordem original dos campos e precisão numérica quando a resposta já é JSON. |
| YAML | --output-format yaml | Saída semelhante a configuração, fácil de comparar visualmente. |
| Table | --output-format table | Respostas em array onde cada item tem o mesmo formato — ex: llm models list. |
| TOON | --output-format toon | Token-Oriented Object Notation. Compacto, orientado a linhas, 30–60% menos tokens que JSON — ideal para uso em prompts de LLM. |
Filtrar e transformar com jq
Use--jq para filtrar ou remodelar respostas inline com uma expressão jq. Isso sempre gera JSON e sobrescreve --output-format:
--jq imprime JSON puro, ele se integra bem com shells e outras chamadas de CLI:
Paginação e streaming
Algumas operações retornam muitos itens ou eventos enviados pelo servidor. A saída é escrita incrementalmente conforme cada item chega:| Formato | Comportamento de streaming |
|---|---|
json | Um objeto JSON compacto por linha (NDJSON) |
yaml | Documentos YAML separados por --- |
toon | Um objeto codificado em TOON por bloco, separados por linhas em branco |
pretty (padrão) | Itens formatados separados por linhas em branco |
Paginar por uma coleção
Passe--all em comandos de listagem para seguir automaticamente o cursor next e emitir cada página conforme ela chega:
Fazer streaming de eventos enviados pelo servidor
Operações de streaming (por exemplo,llm responses create --stream) emitem um evento por linha:
Ctrl+C para parar de consumir um stream antes do fim.
Cor
--color controla as cores do terminal para o formato pretty:
| Valor | Comportamento |
|---|---|
auto (padrão) | Usa cor quando stdout é um TTY, texto puro caso contrário. |
always | Sempre usa cor. |
never | Nunca usa cor. |
NO_COLOR e FORCE_COLOR.
Incluir cabeçalhos da resposta
Use--include-headers quando precisar dos cabeçalhos HTTP da resposta junto com o corpo — por exemplo, para ler um ID de requisição para suporte ou inspecionar um cabeçalho de limite de taxa:
Escrever respostas binárias em um arquivo
Comandos que retornam dados binários (comollm speech speak) suportam --output-file para escrever o corpo em um caminho sem poluir o stdout:
--output-b64 quando precisar embutir o payload binário em um pipeline de JSON ou texto.
Códigos de saída
| Código de saída | Significado |
|---|---|
0 | Sucesso. Resposta escrita no stdout. |
1 | Erro. Detalhes escritos no stderr. |
if simples em scripts:
--dry-run e --debug, que oferecem mais visibilidade sobre por que um comando falhou.