Configuração

Referência de configuração para o UiPath CLI, abrangendo variáveis de ambiente, sinalizadores de linha de comando e regras de precedência.

A UiPath CLI é configurada por meio de sinalizadores de linha de comando, variáveis de ambiente e um arquivo de configuração local. Os sinalizadores são para uma única invocação; variáveis de ambiente adequadas para runtimes e contêineres de CI; o arquivo de configuração contém padrões que persistem entre invocações em uma máquina (formato de saída, nível de log e a política de versão/canal de atualização).

Origens de configuração

Em ordem de precedência, da mais específica para a mais geral:

1. Sinalizador de linha de comando — --tenant, --authority, --client-id, --output, --log-level, etc. Os sinalizadores têm precedência sobre todas as outras origens.
2. Variável de ambiente — variáveis lidas pela CLI no runtime (consulte Variáveis de ambiente). A CLI lê cada variável apenas nos pontos documentados; não há regra implícita "cada sinalizador tem uma contraparte de env-var".
3. Arquivo de configuração — .uipath/config.json, descoberto ao caminho do diretório atual para $HOME, recai para ~/.uipath/config.json. Gerenciado via uip config get|set|clear; contém output, logLevel, interactive, updateChannel e version. Consulte uip config para obter a referência de chave completa.
4. Padrões codificados — https://cloud.uipath.com para a autoridade, json para o formato de saída, info para o nível de log, tamanho da página de 50 nos verbos de lista.

Variáveis de Ambiente

As variáveis de ambiente são o principal mecanismo para configurar a CLI em executores de CI, contêineres e configurações de desenvolvedor por shell. Defina-os no ambiente do executor (ou em um arquivo .env consumido por seu executor), e a CLI os lerá nos pontos documentados abaixo.

Variável	Lido por	Finalidade
UIPATH_URL	uip login, cada comando autenticado	Substitua o URL base da autoridade de identidade. O padrão é https://cloud.uipath.com.
UIPATH_CLI_ENABLE_ENV_AUTH	Cada comando autenticado	Set to literal true to switch the CLI from the file-based credentials flow to environment-variable auth. With this gate on, the CLI reads the access token + tenant + organization from the variables below and bypasses the ~/.uipath/ credentials folder entirely. Refer to Authentication — Flow 4.
UIPATH_CLI_AUTH_TOKEN	somente fluxo de autenticação do env-var	Access token: a JWT, or a Personal Access Token. For a JWT, the server URL is derived from the token's iss claim. For a Personal Access Token, which is not a JWT, set UIPATH_URL to the UiPath base URL.
UIPATH_CLI_ORGANIZATION_NAME	somente fluxo de autenticação do env-var	Campo de dados dinâmico da organização.
UIPATH_CLI_ORGANIZATION_ID	somente fluxo de autenticação do env-var	UUID da organização.
UIPATH_CLI_TENANT_NAME	somente fluxo de autenticação do env-var	Campo de dados dinâmico do tenant.
UIPATH_CLI_TENANT_ID	somente fluxo de autenticação do env-var	UUID do tenant.
UIPATH_TELEMETRY_DISABLED	Inicialização da telemetria	Defina como 1 ou true para desativar a telemetria de uso anônimo.
UIPATH_AI_CONNECTION_STRING	Inicialização da telemetria	Substitua a string de conexão do Application Insights.
HTTP_PROXY / http_proxy	Camada de rede	Proxy HTTP para solicitações de saída (host e ferramentas).
UIPATH_PROXY_INTEGRATED_AUTH	Camada de rede	Set to literal true to authenticate the proxy CONNECT tunnel with Windows Integrated Authentication — Kerberos/Negotiate or NTLM single sign-on. Without the opt-in the CLI supports no-auth and Basic proxies only.
UIPATH_PROXY_USER / UIPATH_PROXY_PASSWORD / UIPATH_PROXY_DOMAIN	Camada de rede	Authenticate the proxy as a specific account rather than the logged-in user. Credentials may also be supplied as user:pass@ in the proxy URL. Supplying them excludes ambient SSO, so a wrong password fails rather than silently falling back.
HTTPS_PROXY / https_proxy	Camada de rede	Proxy HTTPS.
NO_PROXY / no_proxy	Camada de rede	Lista de proxy ignorado.
UIP_DEFAULT_OUTPUT	Formatação de saída	Substitui o padrão integrado json quando --output não é passado. Aceita table, json, yaml, plain ou markdown; um --output explícito na linha de comando sempre prevalece.
UIP_TIMINGS	instrumentação de tempo	Set to 1 or true to print a per-invocation timing line to stderr (total, startup, command, http/httpCalls, flush). Refer to Global options — Command timings.
UIP_TIMINGS_FILE	instrumentação de tempo	Path of a file to append the timing line to instead of stderr. Read only when UIP_TIMINGS is on.
UIPATH_CLI_TOOLS_DIRS	Tool discovery and install	For a host application that embeds the CLI: a list of node_modules/@uipath directories, separated by ; on Windows and : on macOS/Linux. When set, only these directories are searched for tools, the first entry is where uip tools install writes, and the CLI does not update itself.
NO_COLOR	Saída do terminal	Qualquer valor força a cor desabilitada em --output table, substituindo a detecção automática do TTY.
FORCE_COLOR	Saída do terminal	Força a cor mesmo quando stdout não é um TTY (por exemplo saída tabulada que você ainda deseja colorida). Verificado antes da detecção do TTY, ao lado de NO_COLOR.

Para valores não secretos que variam entre implantações (tenant, organização, nome da pasta), passe-os como variáveis em seu executor de CI e faça referência a eles em comandos uip :

env:
  UIPATH_TENANT: Production
  UIPATH_FOLDER: Shared
script:
  - uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant "$UIPATH_TENANT"
  - uip or folders list --all --path "$UIPATH_FOLDER"

AVISO:

Nenhuma leitura implícita de UIPATH_CLIENT_ID / UIPATH_CLIENT_SECRET

Setting UIPATH_CLIENT_ID and UIPATH_CLIENT_SECRET in the environment alone does not authenticate the CLI. Pass them explicitly using the env.VAR_NAME prefix on --client-id / --client-secret, or use the env-var auth flow above for token-based authentication. Refer to Authentication.

Onde cada configuração pode ficar

Configuração	Bandeira	Env var	Padrão
Autoridade / URL de base	--authority <url>	UIPATH_URL	https://cloud.uipath.com
ID do cliente do aplicativo externo	--client-id <id>	— (definido via sinalizador com prefixo env.var_NAME)	nenhum
Segredo do cliente do aplicativo externo	--client-secret <secret>	— (definido via sinalizador com prefixo env.var_NAME)	nenhum
Tenant	--tenant <name> (ou sessão)	—	da sessão
Folder	--folder-path / --folder-key por comando	—	nenhum
Formato de saída	--output <format>	—	json
Filtro de saída	--output-filter <jmespath>	—	nenhum
Nível de log	--log-level <level>	—	info
arquivo de log	--log-file <path>	—	nenhum
registro npm para ferramentas	—	—	.npmrc @uipath:registry (se definido), caso contrário, padrão npm
Telemetria	—	UIPATH_TELEMETRY_DISABLED=1	enabled

As configurações sem uma coluna env-var só podem ser definidas por comando por meio de sinalizadores.

Exemplos de configurações

Executor de CI mínimo (tudo via env)

env:
  UIPATH_URL: https://cloud.uipath.com
  UIPATH_CLIENT_ID: ${{ secrets.UIPATH_CLIENT_ID }}
  UIPATH_CLIENT_SECRET: ${{ secrets.UIPATH_CLIENT_SECRET }}
  UIPATH_TENANT: Production
  UIPATH_TELEMETRY_DISABLED: "1"

steps:
  - run: npm install -g @uipath/cli
  - run: uip tools install @uipath/orchestrator-tool
  - run: uip tools install @uipath/solution-tool
  - run: |
      uip login \
        --client-id env.UIPATH_CLIENT_ID \
        --client-secret env.UIPATH_CLIENT_SECRET \
        --tenant "$UIPATH_TENANT"
  - run: uip or folders list

Contêiner com um token pré-emitido (fluxo de autenticação env-var)

export UIPATH_CLI_ENABLE_ENV_AUTH=true
export UIPATH_CLI_AUTH_TOKEN="$BUILD_TOKEN"
export UIPATH_CLI_ORGANIZATION_NAME=contoso
export UIPATH_CLI_ORGANIZATION_ID="$ORG_UUID"
export UIPATH_CLI_TENANT_NAME=Default
export UIPATH_CLI_TENANT_ID="$TENANT_UUID"

uip or folders list

Nenhuma etapa uip login , nenhum arquivo escrito. Cada comando autentica a partir do env vars.

Veja também

• Autenticação — os fluxos de autenticação e quais variáveis de ambiente cada um lê.
• Instalação do UiPath CLI — variáveis de proxy, recusa de telemetria e padrões de instalação do CI.
• Sessões e credenciais — a pasta de credenciais .uipath/ escrita por uip login.
• Opções globais — sinalizadores que substituem variáveis de ambiente por invocação.
• uip config — o arquivo .uipath/config.json , sua referência de chave completa e os comandos get/set/clear que o gerenciam.