- Información general
- Comience ya
- Conceptos
- Uso de UiPath CLI
- Información general
- Autenticación
- Configuración (uipath.config.json)
- Formatos de salida (tabla, JSON, YAML)
- Patrones de scripting
- Gestionar herramientas y habilidades
- UiPath para agentes de codificación
- Guías prácticas
- Recetas de CI/CD
- Referencia de los comandos
- Información general
- Códigos de salida
- Opciones globales
- agente de código UIP
- UIP Docsai
- añadir-entidad-de-datos-de-prueba
- añadir-cola-de-datos-de-prueba
- añadir-variación-de-datos-de-prueba
- Analizar
- Crear
- Crear proyecto
- Diferencia
- Buscar actividades
- obtener-reglas-del-analizador
- obtener-predeterminado-actividad-xaml
- obtener-errores
- obtener-casos-de-prueba-manual
- obtener-pasos-de-prueba-manual
- obtener versiones
- get-workflow-example
- indicar-aplicación
- indicar-elemento
- inspeccionar-paquete
- install-data-fabric-entities
- instalar-o-actualizar-paquetes
- enumerar-data-fabric-entities
- ejemplos-de-flujo-de-trabajo-de-lista
- Paquete
- restore
- archivo de ejecución
- plantillas-de-búsqueda
- iniciar-studio
- detener la ejecución
- UIA
- Seguimientos de UIP
- Migración
- Referencia y soporte
Guía del usuario de UiPath CLI
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:
- Indicador de línea de comandos :
--tenant,--authority,--client-id,--output,--log-level, etc. Los marcadores tienen prioridad sobre cualquier otro origen. - 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".
- Valores predeterminados codificados de forma rígida :
https://cloud.uipath.compara la autoridad,jsonpara el formato de salida,infopara el nivel de registro, tamaño de página de50en 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 | Establé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_TOKEN | solo flujo de autenticación env-var | Token de acceso JWT. La URL del servidor se deriva de la reclamación iss del token. |
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). |
HTTPS_PROXY / https_proxy | Capa de red | Proxy HTTPS. |
NO_PROXY / no_proxy | Capa de red | Lista 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"
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ó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 @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 poruip login. - Opciones globales : marcadores que anulan las variables de entorno por invocación.