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

Primeros comandos (inicio rápido)

Esta guía de inicio rápido recorre cinco comandos que te llevan desde una nueva instalación a un trabajo que se ejecuta en Orchestrator. Espere cinco minutos.

Antes de empezar

  • Instala UiPath CLI. Consulta Instalar UiPath CLI.
  • Tener una cuenta de UiPath Automation Cloud o Automation Suite con acceso a al menos un tenant.
  • Conocer el nombre (o ruta) de una carpeta en Orchestrator que contenga al menos un proceso. La carpeta predeterminada Shared funciona para la mayoría de las pruebas.

Abre un terminal. Todos los comandos a continuación se escriben allí.

Paso 1. Iniciar sesión

Inicia el inicio de sesión interactivo:

uip login
uip login

uip tu navegador predeterminado, te solicita que inicies sesión en UiPath y, después de autenticarte, te pide que elijas un tenant. Cuando la pestaña del navegador informe de éxito, vuelva al terminal: la sesión está activa. La sesión persiste dentro de ~/.uipath/ (o una carpeta local del proyecto .uipath/ si existe una en la carpeta actual o un antecesor).

Consejo:

Si ya conoces al tenant y quieres omitir el selector, ejecuta uip login --tenant DefaultTenant. Si estás en un entorno de CI, consulta Autenticación para los flujos no interactivos.

Paso 2. Confirmar la sesión

uip login status --output table
uip login status --output table

Salida esperada:

Status         Organization   Tenant          Expiration Date
Logged in      my-org         DefaultTenant   2026-04-24T18:42:00Z
Status         Organization   Tenant          Expiration Date
Logged in      my-org         DefaultTenant   2026-04-24T18:42:00Z
Nota:

Cada comando uip emite JSON de forma predeterminada. Pase --output table para la vista de lectura fácil. Consulta Opciones globales para los cuatro formatos de salida (table, json, yaml, plain) y el marcador JMESPath --output-filter .

Si el comando informa Not logged in, vuelve a ejecutar uip login.

Paso 3. Enumerar carpetas

Tu primera consulta real llega a Orchestrator:

uip or folders list
uip or folders list

Esto devuelve las primeras 50 carpetas del tenant. La salida incluye el Key (GUID) de cada carpeta, Name, Path y Type.

Para filtrar o profundizar, pasa --all para desbloquear filtros:

uip or folders list --all --name Shared
uip or folders list --all --top-level
uip or folders list --all --name Shared
uip or folders list --all --top-level
Nota:

--all es necesario antes de que los marcadores de filtro (--name, --path, --type, --top-level, --order-by) tengan algún efecto. Esta es una red de seguridad deliberada: un error tipográfico en un filtro en un tenant grande devolvería silenciosamente la primera página sin filtrar.

Paso 4. Encuentra un proceso para ejecutar

Elige una carpeta del Paso 3 (aquí se utiliza Shared como ejemplo) y enumera sus procesos:

uip or processes list --folder-path Shared
uip or processes list --folder-path Shared

La salida muestra Key (GUID) de cada proceso, Name, Version y Type. Copia el Key de un proceso que quieras ejecutar. Reemplaza <process-key> en el siguiente paso con ese GUID.

Paso 5. Iniciar un trabajo

uip or jobs start <process-key>
uip or jobs start <process-key>

uip vuelve inmediatamente después de que Orchestrator acepte la solicitud. La respuesta muestra el nuevo trabajo Key, State (generalmente Pending al principio) y el resuelto ProcessName.

Para bloquear hasta que el trabajo finalice y ver su salida, añade --wait-for-completion:

uip or jobs start <process-key> --wait-for-completion --timeout 600
uip or jobs start <process-key> --wait-for-completion --timeout 600

Con --wait-for-completion el comando sondea cada cinco segundos (de forma predeterminada) y sale cuando el trabajo alcanza un estado terminal (Successful, Faulted, Stopped). El código de salida es distinto de cero en Faulted. --timeout está en segundos y el valor predeterminado es 300.

Pasa los argumentos de entrada con --input-arguments (cadena JSON) o --input-file (ruta a un archivo JSON):

uip or jobs start <process-key> \
  --input-arguments '{"invoiceNumber":"INV-001","customer":"Contoso"}'
uip or jobs start <process-key> \
  --input-arguments '{"invoiceNumber":"INV-001","customer":"Contoso"}'

Lo que acabas de hacer

En cinco comandos te autenticaste, consultaste dos recursos de Orchestrator e iniciaste un trabajo. Cada comando uip sigue la misma forma ( uip <tool> <resource> <verb> para herramientas con varios recursos, o uip <tool> <verb> para herramientas de flujo de trabajo único) y cada uno admite los mismos marcadores globales para formato de salida, filtrado y registro. Consulta Opciones globales.

Próximos pasos

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte

¿Quiere aprender? UiPath Academy

¿Tiene alguna pregunta? Foro de UiPath

Manténgase actualizado