Interfaz de línea de comandos

La interfaz de línea de comandos del robot (UiRobot.exe) es una aplicación de consola que puede solicitar el inicio de trabajos y esperar a su salida. Es un cliente directo del mantenimiento de robot de UiPath, y la comunicación se realiza mediante un canal WCF.

Para usar los argumentos de línea de comandos admitidos por UiPath Robots, comprueba que el servicio UiPath Robot se está ejecutando. De lo contrario, inícialo desde el complemento de Consola de administración de servicios de Microsoft.

Para hacerte más sencillo trabajar con argumentos de línea de comandos, navega hasta el directorio en el que se instaló el robot usando el comando cambiar de directorio. Por ejemplo, si no has cambiado la ubicación predeterminada del robot, puedes usar lo siguiente: cd C:\Program Files (x86)\UiPath\Studio.

Todos los ejemplos que se muestran en el capítulo Descripción de argumentos se construyen desde la asunción de que has realizado esta acción.

Descripción de argumentos

cd C:\Program Files (x86)\UiPath\Studio.

Todos los ejemplos mostrados aquí se han construido desde la asunción de que has ejecutado primero el comando anterior.

Los robots atendidos deben ejecutarse solo bajo supervisión humana.

El comando Ejecutar

UiRobot.exe execute [--process <Package_ID> | --file <File_Path>] [--folder <Orchestrator_Folder_ID>] [--input <Input_Parameters>]

Este comando se usa para iniciar la ejecución de un proceso o un archivo (.json, .xaml o .nupkg). Ten en cuenta que los argumentos --process (-p) y --file (-f) no se pueden usar simultáneamente con el comando execute. Es compatible con los siguientes argumentos:

Argumento	Descripción
`-p` `--process <Package_ID>`	Obligatorio. Inicia la ejecución de un proceso local o de Orchestrator. Ejemplos: `UiRobot.exe execute --process UiPathDemoProcess` `UiRobot.exe execute -p UiPathDemoProcess`
`-f` `--file <File_Path>`	Obligatorio. Inicia la ejecución de un archivo de proyecto local. El archivo de destino puede ser `.json`, `.xaml` o `.nupkg`. Ejemplos: `UiRobot.exe execute --file "C:\UiPath\Automation\Project.json"` `UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml"` `UiRobot.exe execute --file "C:\UiPath\Automation\Notepad.1.0.6682.21636.nupkg"`
`--folder <Orchestrator_Folder_ID>`	Opcional. Te permite especificar la carpeta de Orchestrator desde la que instalar y ejecutar el proceso de destino. Solo se puede utilizar junto con el argumento `--process`. Ejemplo: `UiRobot.exe -Execute --process UiPathDemoProcess --folder OrchFolder1`
`--input <Input_Parameters>`	Opcional. Te permite especificar argumentos de entrada para la ejecución. Se puede utilizar con los argumentos `--process`o `--file`. Ejemplos: `UiRobot.exe execute --process UiPathDemoProcess --input "{'inArg' : 'value' , 'Integer' : 3}"` `UiRobot.exe execute --process UiPathDemoProcess --folder OrchFolder1 --input "{'inArg' : 'value' , 'Integer' : 3}"` `UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml" --input "{'inArg' : 'value' , 'Integer' : 3}"`

El comando Empaquetar

Nota: para Studio v2018.4.4 y versiones posteriores recomendamos publicar usando el comando en UiPath.Studio.CommandLine.exe publishlugar de UiRobot.exe pack. Para obtener más información, consulta Parámetros de línea de comandos de actualización masiva en la guía de Studio.

UiRobot.exe pack <Project_Path> --output <Destination_Folder> [-v <Project_Version>]

Este comando se usa para empaquetar un archivo Project.json en un archivo .nupkg. Es compatible con los siguientes argumentos:

Argumento	Descripción
`-o` `--output <Destination_Folder>`	Obligatorio. Te permite especificar dónde se crea el archivo `.nupkg`. Ejemplo: `UiRobot.exe pack "C:\UiPath\Automation\Project.json" --output "C:\UiPath\Automation\Packages"`
`-v <Project_Version>`	Opcional. Te permite especificar una versión para el archivo `.nupkg`. Ejemplo: `UiRobot.exe pack "C:\UiPath\Automation\Project.json" --output "C:\UiPath\Automation\Packages" -v 1.0.6820.22047`

El comando Conectar

UiRobot.exe connect [--url <Orchestrator_Server_URL> --key <Machine_Key>] | [--connectionString <Connection_String>]

Este comando se usa para conectar el robot a una instancia de Orchestrator. Es compatible con los siguientes argumentos:

Argumento	Descripción
`connect`	Obligatorio. Si no se especifican los argumentos `--url`, `--key` o `--connectionString`, se utilizará la configuración de Orchestrator para establecer la conexión. Ejemplo: `UiRobot.exe connect`
`--url <Orchestrator_Server_URL>`	Opcional. Debe usarse con el argumento `--key`. Te permite especificar la instancia de Orchestrator de destino. Ejemplo: `UiRobot.exe connect --url https://demo.uipath.com/ --key 1122AAB3C-DD44-EE55-FF66-7788GG99HH00`
`--key <Machine_Key>`	Opcional. Debe usarse con el argumento `--url`. Te permite especificar la clave de máquina utilizada para conectarte a Orchestrator. Ejemplo: `UiRobot.exe connect --url https://demo.uipath.com/ --key 1122AAB3C-DD44-EE55-FF66-7788GG99HH00`
`--connectionString`	Opcional. Te permite conectarte a Orchestrator mediante la cadena de conexión. Ejemplo: `UiRobot.exe connect --connectionString https://demo.uipath.com/api/robotsservice/GetConnectionData?tenantId=1`

El comando Desconectar

UiRobot.exe disconnect

Este comando se usa para desconectar el robot de la instancia actual de Orchestrator.

El comando Rastrear

UiRobot.exe trace --enableLowLevel | --disableLowLevel

Este comando se usa para habilitar o deshabilitar el seguimiento de bajo nivel (verboso) para el robot. Es compatible con los siguientes argumentos:

Argumento	Descripción
`--enableLowLevel`	Habilita el seguimiento de bajo nivel. Se genera un archivo `.etl`, que puede abrirse con el Visor de eventos, para ayudarte a solucionar problemas de bloqueos y errores. Esto permite el seguimiento verboso para el ejecutor de robot y el servicio en el Visor de eventos. Ejemplo: `UiRobot.exe trace --enableLowLevel`
`--disableLowLevel`	Deshabilita el seguimiento de bajo nivel. Se genera un archivo `.etl` en el escritorio después de detenerlo. Este archivo puede abrirse en el Visor de eventos, para ayudarte a resolver problemas de bloqueos y errores. Ejemplo: `UiRobot.exe trace --disableLowLevel`

El comando PiP

Te permite habilitar o deshabilitar la funcionalidad de Imagen en imagen en la máquina. Este ajuste se aplica en la máquina local y afecta a todos los usuarios. Se usa para modificar instalaciones existentes.

Se necesitan derechos de administrador para ejecutar estos comandos.

Comando	Descripción
`PiP --enable`	Habilita la funcionalidad Imagen en imagen de la máquina.
`PiP --disable`	Deshabilita la funcionalidad Imagen en imagen de la máquina.

El comando ENABLE_PIP

Te permite habilitar la funcionalidad Imagen en imagen de la máquina durante la instalación de línea de comandos de UiPath.

Comando	Descripción
`ENABLE_PIP=1`	Habilita la funcionalidad Imagen en imagen de la máquina.
`ENABLE_PIP=0`	No habilita la funcionalidad Imagen en imagen de la máquina.

Comandos variados

Los siguientes comandos son puramente informativos y no tienen influencia en tus proyectos de automatización:

Argumento	Descripción
`--version`	Muestra información sobre la versión de Robot.
`--help`	Muestra la lista de comandos admitidos, además de información y ejemplos pertinentes.