UiPath Documentation
uipath-cli
latest
false
Importante :
Este contenido se ha traducido mediante traducción automática. La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

Guía del usuario de UiPath CLI

Configuración

UiPath CLI se configura a través de variables de entorno y marcadores por comando. No hay un archivo de configuración de propósito general: establece variables de entorno en el entorno del ejecutor y pasa marcadores en los comandos.

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

VariableLeído porPropósito
UIPATH_URLuip login, cada comando autenticadoAnula la URL base de la autoridad de identidad. El valor predeterminado es https://cloud.uipath.com.
UIPATH_CLI_ENABLE_ENV_AUTHCada comando autenticadoEstablécelo en el literal true para cambiar la CLI del flujo de credenciales basado en archivo a la autenticación de variable de entorno. Con esta puerta activada, CLI lee el token de acceso + tenant + organización de las siguientes variables y omite la carpeta de credenciales ~/.uipath/ por completo. Consulta Autenticación: flujo 3.
UIPATH_CLI_AUTH_TOKENsolo flujo de autenticación env-varToken de acceso JWT. La URL del servidor se deriva de la reclamación iss del token.
UIPATH_CLI_ORGANIZATION_NAMEsolo flujo de autenticación env-varSlug de la organización.
UIPATH_CLI_ORGANIZATION_IDsolo flujo de autenticación env-varUUID de la organización.
UIPATH_CLI_TENANT_NAMEsolo flujo de autenticación env-varSlug del tenant.
UIPATH_CLI_TENANT_IDsolo flujo de autenticación env-varUUID del tenant.
UIPATH_TELEMETRY_DISABLEDIniciación de telemetríaEstablece en 1 o true para deshabilitar la telemetría de uso anónimo.
UIPATH_AI_CONNECTION_STRINGIniciación de telemetríaAnula la cadena de conexión de Application Insights.
HTTP_PROXY / http_proxyCapa de redProxy HTTP para solicitudes salientes (host y herramientas).
HTTPS_PROXY / https_proxyCapa de redProxy HTTPS.
NO_PROXY / no_proxyCapa de redLista de omisión de proxy.

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"
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

Configurar UIPATH_CLIENT_ID y UIPATH_CLIENT_SECRET en el entorno por sí solo no autentica la CLI. Las versiones anteriores a la 1.0 los leen implícitamente; ese comportamiento fue eliminado. Pásalos explícitamente utilizando el prefijo env.VAR_NAME en --client-id / --client-secret, o utiliza el flujo de autenticación env-var anterior para la autenticación basada en token. Consulta Autenticación.

Dónde puede residir cada configuración

ConfiguraciónMarcaVariable de entornoPredeterminado
Autoridad/URL base--authority <url>UIPATH_URLhttps://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 comandoninguno
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íaUIPATH_TELEMETRY_DISABLED=1enabled

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 @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
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 @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
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 tres 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.

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte

¿Quiere aprender? UiPath Academy

¿Tiene alguna pregunta? Foro de UiPath

Manténgase actualizado