Configuración

Referencia de configuración para UiPath CLI, que cubre variables de entorno, marcadores de línea de comandos y reglas de precedencia.

UiPath CLI se configura a través de indicadores de línea de comandos, variables de entorno y un archivo de configuración local. Los marcadores son para una sola invocación; las variables de entorno se adaptan a los ejecutores y contenedores de CI; el archivo de configuración contiene valores predeterminados que persisten en las invocaciones en una máquina (formato de salida, nivel de registro y política de versión/canal de actualización).

Orígenes de configuración

En orden de precedencia, del más específico al más general:

1. Indicador de línea de comandos : --tenant, --authority, --client-id, --output, --log-level, etc. Los marcadores tienen prioridad sobre cualquier otro origen.
2. Variable de entorno : variables leídas por CLI en tiempo de ejecución (consulta Variables de entorno). CLI lee cada variable solo en los puntos documentados; no hay una regla implícita "cada marca tiene una contrapartida env-var".
3. Archivo de configuración : .uipath/config.json, descubierto al subir desde el directorio actual a $HOME, retrocediendo a ~/.uipath/config.json. Gestionado a través de uip config get|set|clear; contiene output, logLevel, interactive, updateChannel y version. Consulta la configuración de uip para obtener la referencia de clave completa.
4. Valores predeterminados codificados de forma rígida : https://cloud.uipath.com para la autoridad, json para el formato de salida, info para el nivel de registro, tamaño de página de 50 en verbos de lista.

Variables de entorno

Las variables de entorno son el mecanismo principal para configurar la CLI en ejecutores de CI, contenedores y configuraciones de desarrollador por shell. Establécelos en el entorno del ejecutor (o en un archivo .env consumido por tu ejecutor), y la CLI los lee en los puntos documentados a continuación.

Variable	Leído por	Propósito
UIPATH_URL	uip login, cada comando autenticado	Anula la URL base de la autoridad de identidad. El valor predeterminado es 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	solo flujo de autenticación 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	solo flujo de autenticación env-var	Slug de la organización.
UIPATH_CLI_ORGANIZATION_ID	solo flujo de autenticación env-var	UUID de la organización.
UIPATH_CLI_TENANT_NAME	solo flujo de autenticación env-var	Slug del tenant.
UIPATH_CLI_TENANT_ID	solo flujo de autenticación env-var	UUID del tenant.
UIPATH_TELEMETRY_DISABLED	Iniciación de telemetría	Establece en 1 o true para deshabilitar la telemetría de uso anónimo.
UIPATH_AI_CONNECTION_STRING	Iniciación de telemetría	Anula la cadena de conexión de Application Insights.
HTTP_PROXY / http_proxy	Capa de red	Proxy HTTP para solicitudes salientes (host y herramientas).
UIPATH_PROXY_INTEGRATED_AUTH	Capa de red	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	Capa de red	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	Capa de red	Proxy HTTPS.
NO_PROXY / no_proxy	Capa de red	Lista de omisión de proxy.
UIP_DEFAULT_OUTPUT	Formato de salida	Anula el valor predeterminado integrado json cuando no se pasa --output. Acepta table, json, yaml, plain o markdown; un --output explícito en la línea de comandos siempre gana.
UIP_TIMINGS	Instrumentación de tiempo	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	Instrumentación de tiempo	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	Salida de terminal	Cualquier valor fuerza la desactivación del color en --output table, anulando la detección automática de TTY.
FORCE_COLOR	Salida de terminal	Fuerza el color, incluso cuando la salida estándar no es un TTY (por ejemplo salida canalizada que aún desea colorear). Comprobado antes de la detección de TTY, junto con NO_COLOR.

Para valores no secretos que varían entre implementaciones (tenant, organización, nombre de carpeta), pásalos como variables en tu ejecutor de CI y haz referencia a ellos en los 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"

ADVERTENCIA:

Sin lectura 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.

Dónde puede residir cada configuración

Configuración	Marca	Variable de entorno	Predeterminado
Autoridad/URL base	--authority <url>	UIPATH_URL	https://cloud.uipath.com
ID de cliente de aplicación externa	--client-id <id>	— (establecido a través del marcador con el prefijo env.VAR_NAME)	ninguno
Secreto de cliente de aplicación externa	--client-secret <secret>	— (establecido a través del marcador con el prefijo env.VAR_NAME)	ninguno
Tenant	--tenant <name> (o sesión)	—	de la sesión
Carpeta	--folder-path / --folder-key por comando	—	ninguno
Formato de salida	--output <format>	—	json
Filtro de salida	--output-filter <jmespath>	—	ninguno
Nivel de registro	--log-level <level>	—	info
archivo de registro .etl	--log-file <path>	—	ninguno
Registro npm para herramientas	—	—	.npmrc @uipath:registry (si se establece), de lo contrario npm predeterminado
Telemetría	—	UIPATH_TELEMETRY_DISABLED=1	enabled

La configuración sin una columna env-var solo se puede establecer por comando a través de marcadores.

Configuraciones de ejemplo

Ejecutor de CI mínimo (todo a través de 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

Contenedor con un token preemitido (flujo de autenticación 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

Sin paso uip login , no se ha escrito ningún archivo. Cada comando se autentica desde las variables de entorno.

Ver también

• Autenticación : los flujos de autenticación y qué variables de entorno lee cada uno.
• Instalar UiPath CLI : variables de proxy, deshabilitación de telemetría y patrones de instalación de CI.
• Sesiones y credenciales : la carpeta de credenciales .uipath/ escrita por uip login.
• Opciones globales : marcadores que anulan las variables de entorno por invocación.
• uip config : el archivo .uipath/config.json , su referencia de clave completa y los comandos get/set/clear que lo gestionan.