Opções globais

Opções globais aceitas por toda invocação do "uip", abrangendo o formato de saída, o filtro de saída, o nível de log e o arquivo de log.

Cada invocação de uip é pré-verificada para um conjunto fixo de opções globais antes que qualquer ferramenta ou subcomando veja seus argumentos — eles podem aparecer em qualquer lugar na linha de comando, funcionar de forma idêntica em todas as ferramentas e são removidos antes da análise dos sinalizadores por comando execuções.

Opção	Short	Valor	Padrão	Finalidade
--output	—	table, json, yaml, plain, markdown	json	Formato da saída principal gravada em stdout.
--json	—	Bandeira	—	Alias de compatibilidade oculto de --output json. Passar ele junto com um --output <value> explícito é um conflito — veja abaixo.
--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.
--profile	—	name	—	Seleciona um perfil de login nomeado e salvo em vez do local padrão das credenciais. mutuamente exclusivo com o próprio -f, --file <folder> de um comando (por exemplo em uip login, uip login tenant list/set, uip logout) — passar ambos é um ValidationError. Consulte Sessões e credenciais.
--interactive / --no-interactive	—	Bandeira	automático (solicitações apenas em um TTY)	Forçar a ativação ou desativação do prompt, substituindo o padrão "prompt apenas quando conectado a um TTY" comportamento. Não específico de nenhum comando — ele governa todos os lugares em que um comando uip faria uma pergunta (por exemplo, seleção de tenant durante uip login ou o seletor de agente/destino em uip skills install).

--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
uip or folders list --output markdown   # GitHub-flavored markdown, for agents/chat surfaces

• 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.
• markdown uma tabela GVM para uma lista ou linhas **key:** value para um único registro. Destinado a um agente ou superfície de chat lendo a saída de uip, não uma sessão de terminal. Consulte Formatos de saída — markdown para o comportamento completo.

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.

--json (alias oculto)

--json é um alias de compatibilidade oculto para --output json — ele não aparece em --help, mas é totalmente funcional:

uip or folders list --json   # identical to --output json

Passar --json junto com um --output <value> explícito (qualquer valor, incluindo json) é sinalizado como um conflito internamente; evite combiná-los — passe um ou outro.

--perfil

Selecione um perfil de login nomeado e salvo em vez do local padrão das credenciais:

uip login --profile ci-runner --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant Production
uip or folders list --profile ci-runner

--profile <name> e o próprio de um comando -f, --file <folder> são mutuamente exclusivos — a passagem de ambos falha ValidationError: option '--profile' cannot be used with option '--file' com. Os nomes dos perfis são normalizados (as regras de maiúsculas e minúsculas e separadores são aplicadas); um nome inválido é rejeitado antes de qualquer chamada de rede. Consulte Sessões e credenciais — perfis nomeados.

--interative / --no-interative

Substitua o prompt padrão "prompt apenas quando stdout for um TTY" Comportamento:

uip login --interactive        # force the tenant-selection prompt even when not on a TTY
uip skills install --no-interactive --agent claude   # never prompt, fail instead if a required choice is missing

--interactive define--no-interactive o prompt para sempre ativo; força-o a desconectar. Nenhum dos sinalizadores é específico para uip login — apesar de aparecer em exemplos de login em todo esse conjunto de documentação, a interatividade é uma opção global cruzada sem formulário curto específico de comando (não há --it ou alias semelhante em qualquer lugar da CLI).

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.

Substituições de variável de ambiente

Duas variáveis de ambiente alteram o comportamento da opção global sem um sinalizador:

Variável	Efeito
UIP_DEFAULT_OUTPUT	Substitui o padrão integrado json para --output quando o sinalizador não é passado. Aceita table, json, yaml, plain ou markdown; valores inválidos são ignorados. Um --output explícito na linha de comando sempre vence.
UIP_TIMINGS	Defina como 1 ou true para imprimir uma linha de tempo por invocação para stderr em cada comando uip. Consulte Tempos de comando abaixo.

Tempos de comando

Defina UIP_TIMINGS=1 (ou true) e cada invocação imprime uma linha no stderr:

[timing] 'uip or assets list' exit=0 total=1250ms startup=380ms command=863ms http=691ms httpCalls=3 flush=7ms

Campo	Significado
(o comando entre aspas)	O comando conforme digitado.
exit	O código de saída que a invocação retornava.
total	Tempo de disparo total, medido a partir do início do processo.
startup	Tudo antes da execução do manipulador de comandos — inicialização do processo, configuração, carregamento de ferramentas.
command	O próprio gerenciador de comandos.
http	Duração resumida das chamadas HTTP de saída da execução — uma soma, não um relógio de ponto de ponto. Ele se sobrepõe a command em vez de adicionar a ele, então as chamadas paralelas podem torná-lo maior que command.
httpCalls	Quantas chamadas HTTP de saída essa soma abrange.
flush	Tudo após o retorno do manipulador — contabilidade de telemetria e o fluxo final.

startup + command + flush sempre é igual a total. Os campos são omitidos quando não se aplicam: uma execução que nunca atinge um manipulador (uip --version, um comando desconhecido) imprime apenas total e exit; um comando que não faz nenhuma chamada HTTP não tem nem http nem httpCalls.

O relatório tem seu próprio botão — não depende de --log-level, então você obtém durações sem ativar a saída de depuração, e o stdout nunca é alterado.

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.