Instalar UiPath CLI

UiPath CLI se distribuye en npm como @uipath/cli e instala el comando uip globalmente. Se ejecuta en cualquier plataforma compatible con Node.js 18 o posterior: Windows, macOS y Linux, tanto en x64 como en ARM64.

Requisitos previos

• Node.js 18 o posterior. Node.js se envía con npm, que es suficiente para instalar y ejecutar uip.
• Cualquier plataforma: Windows (x64, ARM64), macOS (x64, ARM64), Linux (x64, ARM64).

Comprueba tu versión de nodo:

node --version

Si Node.js es anterior a 18 o no está instalado, descárgalo de nodejs.org o utiliza un gestor de versiones como nvm (macOS/Linux) o nvm-windows.

Instalar

NPM

npm install -g @uipath/cli

pnpm

pnpm add -g @uipath/cli

Nota:

Ambos gestores de paquetes instalan el mismo paquete @uipath/cli desde el registro público de npm. Utilice el que ya tenga su equipo.

La instalación coloca el ejecutable uip en tu PATH. En Windows, el lanzador uip.cmd / uip.ps1 se encuentra en %APPDATA%\npm\; en macOS y Linux, el lanzador uip (una pequeña corrección alrededor de node ./dist/index.js) vive bajo el prefijo informado por npm config get prefix (comúnmente /usr/local/bin o ~/.npm-global/bin).

Verifica la instalación

uip --version

Deberías ver el número de versión instalada (por ejemplo, 1.0.0).

uip --help

Debería ver una lista de comandos básicos: login (con los subcomandos status, tenant list, tenant set ), logout, tools, skills, mcp, completion : seguidos por las herramientas que se han instalado o registrado en tu máquina.

Para confirmar dónde se encuentran el lanzador uip y sus herramientas:

npm root -g              # directory holding @uipath/cli and installed tools
npm config get prefix    # parent directory whose bin/ folder holds the uip launcher

Primer comando

UiPath CLI se envía solo con el host y un pequeño conjunto de comandos básicos. No hay herramientas preinstaladas. La primera vez que invocas un comando cuyo prefijo coincide con una herramienta en la lista blanca de instalación automática, el host descarga e instala esa herramienta desde npm automáticamente.

Por ejemplo, la primera vez que ejecutas un comando de Orchestrator, uip instala @uipath/orchestrator-tool:

uip or folders list

Installing @uipath/orchestrator-tool...
✓ Installed @uipath/orchestrator-tool
...

Las invocaciones posteriores de uip or ... utilizan la herramienta instalada directamente. También puedes instalar herramientas de forma explícita (útil en ejecutores de CI y redes restringidas) con uip tools install:

uip tools install @uipath/orchestrator-tool
uip tools install @uipath/solution-tool

Consulta Herramientas (complementos) para ver la lista blanca completa y Gestionar herramientas y habilidades para la gestión diaria de herramientas.

Instalación automática de la herramienta de control

La instalación automática se ejecuta siempre que el verbo invocado esté en la lista blanca y la herramienta aún no esté instalada. No hay indicador de exclusión ni variable de entorno; en particular, CI=true no deshabilita la instalación automática. En los ejecutores de CI sin estado, esto significa que el primer comando en una compilación descarga su herramienta, y los comandos posteriores en el mismo trabajo reutilizan la copia ya instalada. Eso hace que el primer comando sea más lento que los siguientes, a menos que lo preinstales.

Para mantener los tiempos de compilación de CI deterministas, preinstala las herramientas que utilizas como un paso independiente, de modo que cada llamada posterior uip las encuentre ya presentes:

uip tools install @uipath/orchestrator-tool @uipath/solution-tool

La instalación automática no es operativa cuando la herramienta ya está instalada, por lo que el paso de preinstalación es el único cambio de comportamiento que necesitas.

Habilitar finalización de shell

UiPath CLI incluye la finalización de pestañas para bash, zsh, fish y pwsh. La finalización se instala desde la propia CLI:

uip completion

En un terminal, uip completion detecta tu shell desde $SHELL / $PSModulePath /plataforma, imprime el archivo rc de destino que modificará y pide confirmación. Acepta la solicitud y vuelve a abrir tu shell: uip <TAB> ahora completa subcomandos y opciones.

Para la configuración con script, canaliza el script de finalización directamente a tu archivo rc:

# zsh
uip completion zsh >> ~/.zshrc

# bash
uip completion bash >> ~/.bashrc

# fish
uip completion fish > ~/.config/fish/completions/uip.fish

# PowerShell
uip completion pwsh >> $PROFILE

Otras opciones:

• uip completion --print — vista previa de la ruta de destino y el bloque que se escribiría, sin modificar el sistema de archivos.
• uip completion --uninstall : elimina el bloqueo de finalización gestionado.

Nota:

La finalización de valor de marcador dinámico (por ejemplo, uip or packages upload --package-name <TAB>) es solo zsh y requiere la utilidad jq en tu PATH. Sin jq, se suprimen los candidatos dinámicos; el subcomando estático y la finalización del nombre de la opción siguen funcionando en los cuatro shells.

ADVERTENCIA:

Vuelva a ejecutar la finalización después de cada actualización de CLI o herramienta

El script de finalización es una instantánea estática de los subcomandos y nombres de opciones conocidos en el momento en que se ejecutó uip completion . Después de npm install -g @uipath/cli@<new-version>, uip tools install <new-tool> o uip tools update, vuelve a ejecutar uip completion para que se indexen los comandos y marcadores recién añadidos:

uip completion              # interactive — refreshes the existing block
uip completion zsh >> ~/.zshrc   # or pipe into the rc file directly

Sin una actualización, los verbos nuevos (por ejemplo, un verbo añadido en una versión MENOR de una herramienta) no se autocompletarán aunque funcionen en la línea de comandos.

Notas de la plataforma

Ventanas

Ejecuta comandos desde PowerShell, Windows Terminal o cmd. Si uip no se reconoce después de la instalación, abre una nueva ventana de terminal para que la actualización de PATH surta efecto, o ejecuta:

npm config get prefix

y confirma que el directorio devuelto está en tu PATH.

macOS y Linux

La mayoría de los gestores de paquetes colocan el ejecutable uip en el PATH predeterminado. Si instalas npm globales en un directorio local de usuario (como se recomienda, evita sudo), asegúrate de que ese directorio esté en tu PATH. Por ejemplo, con un prefijo ~/.npm-global :

export PATH="$HOME/.npm-global/bin:$PATH"

Añade la línea a tu perfil de shell (~/.zshrc, ~/.bashrc, etc.) para persistir.

Detrás de un proxy corporativo

UiPath CLI respeta las variables de entorno del proxy HTTP estándar tanto para la propia CLI como para la autoinstalación de la herramienta:

Variable	Propósito
HTTP_PROXY / http_proxy	Proxy para solicitudes HTTP
HTTPS_PROXY / https_proxy	Proxy para solicitudes HTTPS
NO_PROXY / no_proxy	Lista separada por comas de hosts que omiten el proxy

Ejemplos:

# macOS / Linux
export HTTPS_PROXY=http://proxy.example.com:8080
export NO_PROXY=localhost,127.0.0.1,.internal.corp
uip login

# Windows PowerShell
$env:HTTPS_PROXY = "http://proxy.example.com:8080"
$env:NO_PROXY = "localhost,127.0.0.1,.internal.corp"
uip login

:: Windows cmd
set HTTPS_PROXY=http://proxy.example.com:8080
set NO_PROXY=localhost,127.0.0.1,.internal.corp
uip login

Los proxies con autenticación básica son compatibles si se incluyen las credenciales en la URL: http://user:[e-mail]:8080.

Consejo:

La CLI incluye una implementación fetch con reconocimiento de proxy, por lo que HTTPS_PROXY / HTTP_PROXY se respetan sin configuración adicional en Node.js.

Telemetría

UiPath CLI envía telemetría de uso anónimo a UiPath para ayudar a mejorar el producto. No se transmiten argumentos de comando, contenidos de archivo o credenciales.

Variable	Comportamiento
UIPATH_TELEMETRY_DISABLED	Establezca en 1 o true para excluirse.
UIPATH_AI_CONNECTION_STRING	Anula la cadena de conexión de Application Insights, por ejemplo, para enrutar la telemetría a tu propia instancia.

# Opt out for the current shell
export UIPATH_TELEMETRY_DISABLED=1

# Or just for one command
UIPATH_TELEMETRY_DISABLED=1 uip login

Instalar en CI/CD

Instala la CLI como un paso en tu proceso. Como uip no tiene herramientas preinstaladas, deja que las herramientas se instalen automáticamente en el primer uso o preinstalalas explícitamente. Esto último es más rápido en ejecutores sin estado porque la descarga de la herramienta se produce una vez por paso en lugar de en cada comando.

Acciones de GitHub

steps:
  - uses: actions/setup-node@v4
    with:
      node-version: '20'

  - name: Install UiPath CLI
    run: npm install -g @uipath/cli

  - name: Pre-install tools
    run: uip tools install @uipath/orchestrator-tool @uipath/solution-tool

  - name: Authenticate
    run: uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET
    env:
      UIPATH_CLIENT_ID: ${{ secrets.UIPATH_CLIENT_ID }}
      UIPATH_CLIENT_SECRET: ${{ secrets.UIPATH_CLIENT_SECRET }}

  - name: Run CLI commands
    run: uip or folders list --output json

Azure DevOps

steps:
  - task: NodeTool@0
    inputs:
      versionSpec: '20.x'
    displayName: 'Use Node.js 20'

  - script: npm install -g @uipath/cli
    displayName: 'Install UiPath CLI'

  - script: uip tools install @uipath/orchestrator-tool @uipath/solution-tool
    displayName: 'Pre-install UiPath CLI tools'

  - script: uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET
    displayName: 'Authenticate'
    env:
      UIPATH_CLIENT_ID: $(UIPATH_CLIENT_ID)
      UIPATH_CLIENT_SECRET: $(UIPATH_CLIENT_SECRET)

Jenkins (canalización declarativa)

stage('Install UiPath CLI') {
  steps {
    sh 'npm install -g @uipath/cli'
    sh 'uip tools install @uipath/orchestrator-tool @uipath/solution-tool'
  }
}

stage('Authenticate') {
  steps {
    withCredentials([
      string(credentialsId: 'UIPATH_CLIENT_ID', variable: 'UIPATH_CLIENT_ID'),
      string(credentialsId: 'UIPATH_CLIENT_SECRET', variable: 'UIPATH_CLIENT_SECRET')
    ]) {
      sh 'uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET'
    }
  }
}

Consulta Recetas de CI/CD para ver ejemplos de procesos completos, incluidas las etapas de empaquetado, publicación y prueba.

Consejo:

Almacena en caché el directorio global npm entre compilaciones para evitar reinstalar @uipath/cli y sus herramientas en cada ejecución. En Acciones de GitHub, utiliza la clave actions/cache en la versión de CLI que anclas.

Instalar desde el registro npm de GitHub

Un subconjunto de @uipath/* paquetes de herramientas, actualmente @uipath/rpa-tool y @uipath/flow-tool , se publican en el registro npm de GitHub (https://npm.pkg.github.com) en lugar de en el registro público npm. Antes de que uip tools install pueda resolverlos, configura npm para enrutar el ámbito @uipath a través del registro de GitHub.

Crea (o actualiza) ~/.npmrc (en el nivel de usuario) o ./.npmrc (en el nivel de proyecto) con:

@uipath:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}

GITHUB_TOKEN necesita al menos el ámbito read:packages ; para una extracción no autenticada de un paquete público de GitHub, se puede omitir la línea del token (el comportamiento varía según el paquete; comprueba la visibilidad del repositorio).

export GITHUB_TOKEN=<your-pat>
npm install -g @uipath/cli
uip tools install @uipath/rpa-tool

Una vez configurados, uip tools install y uip tools update recogen los paquetes registrados en GitHub de la misma manera que recogen los públicos.

Nota:

El propio paquete de host @uipath/cli está en el registro público de npm. Solo las herramientas marcadas en Notas de la versión como registradas en GitHub necesitan .npmrc adicional.

Ejecutar sin una instalación global

Para uso ad-hoc o procesos que prefieren no instalarse globalmente, puedes ejecutar la CLI a través de npx:

npx -y @uipath/cli <command>

Por ejemplo:

npx -y @uipath/cli login
npx -y @uipath/cli or folders list

La primera invocación descarga el paquete; las invocaciones posteriores reutilizan la caché de npm.

Actualización

Vuelve a instalar el paquete con el mismo comando que utilizaste para instalarlo, eligiendo la última versión o una versión anclada:

# latest release
npm install -g @uipath/cli@latest

# pinned version
npm install -g @uipath/cli@1.0.0

El comando pnpm equivalente es pnpm add -g @uipath/cli@latest.

Consejo:

Anclar una versión exacta en CI. @uipath/cli sigue el versionado semántico, pero la forma de Data en la salida JSON es específica del comando y puede cambiar entre versiones MENOR (consulta Versiones y estabilidad). La fijación evita sorpresas en el momento de la compilación en procesos que analizan JSON. Al aumentar, vuelve a validar los scripts que dependen de nombres de campo específicos.

Consulta las notas de la versión para ver qué ha cambiado entre versiones.

La actualización del host no actualiza automáticamente las herramientas instaladas. Para actualizar herramientas:

uip tools update                        # update all installed tools
uip tools update --name <package>       # update a single tool
uip tools update --name <package> --version <version>   # pin to a specific version

De forma predeterminada, cada versión de la herramienta realiza un seguimiento de la línea MAYOR.MINOR de CLI, por lo que ejecutar uip tools update después de una actualización de CLI pone en marcha todas las herramientas instaladas. Consulta Herramientas (complementos) para el contrato de fijación.

Desinstalando

Elimina la CLI con el gestor de paquetes que utilizaste para instalarla:

npm uninstall -g @uipath/cli
# or
pnpm remove -g @uipath/cli

Esto elimina el ejecutable uip y las herramientas instaladas.

Eliminar credenciales y datos

Desinstalar el paquete deja varias partes del estado en disco. Límpialos manualmente cuando quieras empezar de nuevo o necesites dar de baja una máquina.

Credenciales de sesión

uip login persiste la sesión dentro de ~/.uipath/ en tu directorio de inicio de forma predeterminada. Cuando el CLI se inicia, sube desde el directorio actual buscando primero una carpeta .uipath/ , para que una carpeta de proyecto pueda llevar su propia sesión sin modificar el directorio de inicio del usuario. Comprueba ambas ubicaciones al limpiar:

# macOS / Linux
rm -rf ~/.uipath

# Windows PowerShell
Remove-Item -Recurse -Force "$env:USERPROFILE\.uipath"

Comprueba también cada proyecto en el que has trabajado para un .uipath/ local. Consulta Sesiones y credenciales para ver el diseño completo.

Finalización del shell

Si uip completion, el bloque de finalización seguirá estando en tu archivo rc de shell después de la desinstalación. Elimínalo antes de desinstalar @uipath/cli, o límpialo manualmente desde ~/.zshrc, ~/.bashrc o $PROFILE:

# Before uninstalling, while uip is still available:
uip completion --uninstall

Caché global de npm

npm mantiene una caché local de archivos tar descargados en la ruta informada por npm config get cache. Esto no necesita ser limpiado para la mayoría de los usuarios; límpialo solo para recuperar espacio en disco o para solucionar problemas de una descarga corrupta:

npm cache clean --force

Solución de problemas

uip: comando no encontrado después de la instalación

El directorio global npm no está en su PATH. Ejecuta npm config get prefix para ver dónde npm colocó el iniciador uip , luego añade la subcarpeta bin de ese directorio a tu PATH y abre un nuevo terminal.

EACCES o errores de permiso en la instalación

En macOS y Linux, evita sudo npm install. Configura npm para utilizar un prefijo local de usuario una vez:

mkdir -p ~/.npm-global
npm config set prefix ~/.npm-global
export PATH="$HOME/.npm-global/bin:$PATH"

A continuación, reinstala: npm install -g @uipath/cli.

La instalación automática de la herramienta se bloquea o agota el tiempo de espera

Es posible que estés detrás de un proxy que bloquea npm. Configura HTTPS_PROXY como se describe en Detrás de un proxy corporativo o preinstala las herramientas en una máquina con acceso a Internet y copia el node_modules global en la máquina de destino.

La versión del nodo es demasiado antigua

uip requiere Node.js 18 o posterior. Actualiza Node.js o cambia de versión con nvm use 20.

Consulta Solución de problemas para obtener más errores y sus resoluciones.

Próximos pasos

• Inicio rápido : inicia sesión, enumera las carpetas de Orchestrator y ejecuta un trabajo en cinco minutos.
• Su primer proceso : empaquete un proyecto e impleméntelo desde CI.
• Autenticación : inicio de sesión interactivo, credenciales de cliente de aplicación externa y autenticación de variable de entorno para CI.
• Uso de UiPath CLI con agentes de codificación : instala habilidades en Claude Code, Cursor, GitHub Copilot o Gemini CLI.