Opções globais

Quatro opções são reconhecidas em uip invocação, independentemente da ferramenta ou subcomando. Eles controlam o formato de saída, o filtro de saída e o fluxo de logs. Todos os outros sinalizadores são definidos por comando.

Opção	Short	Valor	Padrão	Finalidade
--output	—	table, json, yaml, plain	json	Formato da saída principal gravada em stdout.
--output-filter	—	Expressão JmesPath	—	Pós-filtro aplicado à carga JSON antes da formatação.
--log-level	—	debug, info, warn, error	info	Verificação de mensagens de log gravadas no stderr (e --log-file , se definido).
--log-file	—	Path	—	Se definido, os logs serão duplicados para este arquivo no formato Linhas JSON.

--version (-v) e --help (-h) também são reconhecidos em uip e em cada subcomando, mas são convenções padrão da CLI em vez de sinalizadores globais no sentido acima.

--saída

Escolha o formato de saída. Ambos --output json e --output=json funcionam; os valores diferenciam maiúsculas de minúsculas.

uip or folders list                  # default: json
uip or folders list --output table   # human-friendly table
uip or folders list --output yaml    # yaml
uip or folders list --output plain   # key=value lines, no structure

• json padrão) — um documento JSON no stdout. Analisado por jq, --output-filter e por qualquer consumidor JSON. Esse é o padrão para cada invocação, independentemente de o terminal ser um TTY.
• table tabela com bordas e colorida adequada para leitura em um terminal. Não estável entre versões — não a analise.
• yaml — Serialização YAML da mesma estrutura que json.
• plain — linhas key=value simples. Útil para canalizar para o shell read, grep, e cut sem instalar jq.

Observação:

O padrão é json, não table. Quando um humano executa uip or folders list em um terminal, ele vê um documento JSON no stdout. Passe --output table explicitamente (ou adicione-o a um alias de shell) para a visualização amigável de leitura. Essa escolha mantém a mesma forma de stdout em um terminal e em um pipeline — os scripts não precisam se preocupar se estão sendo executados interativamente.

Separação de stream

--output controles stdout apenas. Logs, indicadores de progresso e erros voltados para humanos vão para stderr, independentemente do formato. Isso significa que um pipeline pode capturar JSON limpo com:

uip or folders list > folders.json 2> uip.log

...e ainda veem a saída de log separadamente.

--output-filter

Aplique uma expressão JmesPath à carga do JSON antes da formatação. O filtro é executado no envelope de resposta completo, então Data[*].Name escolhe nomes da matriz Data , length(Data) retorna uma contagem e assim por diante.

# just the Data field
uip or folders list --output-filter "Data"

# folder names only
uip or folders list --output-filter "Data[*].Name"

# count
uip or folders list --output-filter "length(Data)"

# first folder's key and name
uip or folders list --output-filter "Data[0] | {key: Key, name: Name}"

Combinando com --output:

# names as YAML
uip or folders list --output-filter "Data[*].Name" --output yaml

# names as one-per-line plain text
uip or folders list --output-filter "Data[*].Name" --output plain

Uma expressão de filtro malformada falha rapidamente com um ValidationError e código de saída 3 antes que o comando subjacente seja executado — para que um erro de digitação não desperdiça uma chamada de API.

Dica:

--output-filter é a versão da CLI do --query do Azure CLI, do --query do AWS CLI e do --filter/--format do gcloud. Se você já conhecer o JmesPath dessas ferramentas, a sintaxe será idêntica.

--nível de log

Defina a verbosidade das mensagens de log (escritas como stderr e como --log-file se fornecida).

uip or folders list --log-level debug   # verbose — HTTP calls, auth refresh, tool loading
uip or folders list --log-level info    # default
uip or folders list --log-level warn
uip or folders list --log-level error   # only failures

Os valores não diferenciam maiúsculas de minúsculas. Valores desconhecidos são ignorados silenciosamente (o padrão é mantido) em vez de gerar erros — de propósito, para que um erro de digitação em um script de wrapper não interrompa um pipeline.

A variável de ambiente UIPATH_LOG_LEVEL não é honrada; transmita o sinalizador ou defina-o em um script de perfil.

--log-file

Grave uma duplicata do fluxo de log para o arquivo especificado, no formato JSON Lines (um objeto JSON por linha). O arquivo é anexado — use um caminho específico de compilação se precisar de logs separados por execução.

uip or folders list --log-file ./uip.log
uip or folders list --log-file /var/log/uip/$(date +%F).log --log-level debug

Cada linha no arquivo se parece com:

{"time":"2026-04-24T18:42:00.123Z","level":"info","message":"CLI v1.0.0 starting — output=json, logLevel=info, logFile=./uip.log"}

Esse formato é projetado para remetentes de log (Fluent Bit, Loji, Splunk) e para análise post-mé fornecer.

Onde as opções globais se aplicam

As opções globais são removidas da linha de comando antes que os sinalizadores por comando sejam analisados, para que possam aparecer em qualquer lugar na linha de comando:

uip --output table or folders list
uip or --output table folders list
uip or folders list --output table
uip or folders list --output=table

Todas as quatro invocações são equivalentes.

Os subcomandos da ferramenta não definem seu próprio --output ou --log-level. Uma ferramenta que definiu inadvertidamente um seguiria o sinalizador global — as verificações de lint da CLI proíbem isso.

Códigos de saída

As opções globais controlam apenas a saída e o registro em log; eles não afetam códigos de saída. Consulte Códigos de saída.

Veja também

• Formatos de saída (tabela, JSON, YAML) — cobertura mais profunda com exemplos completos de cada formato.
• Padrões de script — códigos de saída, separação de stream, novas tentativas, pesquisas.
• referência de login uip e outras páginas de comando — documentam seus sinalizadores por comando além desses globais.