Interfaz de la línea de comandos de Robot

Robot Command Line Interface (UiRobot.exe) for starting automations, connecting to Orchestrator, and managing the Robot from a terminal.

The UiPath Robot Command Line Interface is a tool that allows you to interact with the Robot from a command line terminal. It uses the UiRobot.exe file to start automations, install processes, connect and disconnect the Robot from Orchestrator, and manage logs, tracing, the Robot session (PiP), proxy credentials, and the NuGet cache directly from the command line.

Cómo funciona

Para utilizar la CLI, asegúrate de lo siguiente:

• El mantenimiento de robot de UiPath se está ejecutando
• Estás en el directorio en el que está instalado el robot.

Then enter instructions or commands that refer to the UiRobot.exe program along with the necessary parameters, depending on what you want your automation to achieve.

UiRobot.exe is in the Robot installation folder: %ProgramFiles%\UiPathPlatform\Robot\<version> for a per-machine installation, or %LocalAppData%\Programs\UiPathPlatform\Robot\<version> for a per-user installation.

Command and option names aren't case-sensitive.

When the Robot runs in service mode, the connect, disconnect, and flushlogs commands require an elevated command prompt (run as administrator).

Por ejemplo, para iniciar un proceso desde la línea de comandos, se utilizaría el siguiente comando:

UiRobot.exe execute --file "C:\UiPath\Projects\YourProject\project.1.0.0.nupkg"

Comandos comunes de UiRobot.exe

Ejecutar

Utiliza este comando para iniciar la ejecución de un archivo de proyecto de los siguientes tipos:

• NUPKG
• JSON (legacy projects only)
• XAML (legacy projects only)

Nota:

A partir de la versión 2023.4 de Robot, UiPath actualiza la lista de procesos al mismo tiempo que se ejecuta un proceso. Si hay una actualización de proceso disponible al inicio del trabajo, el trabajo utiliza la versión anterior del proceso. Las ejecuciones posteriores aplican el proceso actualizado.

El comando de ejecución utiliza los siguientes argumentos:

UiRobot.exe execute (--package-id <Package_ID> | --process-name <Process_Name> | --file <File_Path>) [--input <Input_Parameters>] [--folder <Orchestrator_Folder_Path>] [--entry <Entry_Point_Path>]

Use exactly one of --package-id, --process-name, and --file.

• -p, --package-id <Package_ID> - Starts the process with this package ID, from the Orchestrator feed or the local feed. The Robot uses the available version of the package.

  Ejemplos:

  UiRobot.exe execute --package-id UiPathDemo
  

  UiRobot.exe execute -p UiPathDemo
  

• -r, --process-name <Process_Name> - Starts the process with this name, as defined in Orchestrator.

  Ejemplo:

  UiRobot.exe execute --process-name UiPathDemoProcess
  

• -f, --file <File_Path> - Starts the execution of a local project file. The target file can be NUPKG, or JSON or XAML for legacy projects only.

  Ejemplo:

  UiRobot.exe execute --file "C:\UiPath\Automation\project.1.0.0.nupkg"
  

• --folder <Orchestrator_Folder_Path> (optional) - The path of the Orchestrator folder from which to install and execute the target process, such as Product/Development/QA. Required when the process is deployed in more than one folder.

  Ejemplo:

  UiRobot.exe execute --package-id UiPathDemo --folder "Product/Development/QA"
  

• -i, --input <Input_Parameters> (optional) - Input arguments for the execution, in JSON format.

  Ejemplos:

  UiRobot.exe execute --package-id UiPathDemo --input "{\"intArg\" : 3, \"strArg\" : \"hello\"}"
  

  UiRobot.exe execute --file "C:\UiPath\Automation\project.1.0.0.nupkg" --input "{\"intArg\" : 3, \"strArg\" : \"hello\"}"
  

  In PowerShell, enclose the JSON in single quotes: --input '{\"intArg\" : 3, \"strArg\" : \"hello\"}'.

• --entry <Entry_Point_Path> (optional) - Selects the entry point of the process. It applies to .nupkg files and --package-id. It is ignored when --file points to a .xaml or .json file, and you can't use it with --process-name.

  Ejemplo:

  UiRobot.exe execute --file "C:\UiPath\Project\project.1.0.3.nupkg" --entry "OtherEntryPoint.xaml"
  

  Importante:

  • Los siguientes comandos no son compatibles con proyectos de Windows o multiplataforma:

    UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml"
    

    UiRobot.exe execute --file "C:\UiPath\Automation\Project.json"
    

  • The --process argument of earlier versions still works as an alias of --package-id.

Proceso de instalación

Utiliza este comando para instalar un proceso. Si el robot está conectado a Orchestrator, busca el proceso en la fuente de Orchestrator. Sin una conexión de Orchestrator, el robot utiliza la fuente local.

El comando del proceso de instalación utiliza los siguientes argumentos:

UiRobot.exe installprocess --process-name <process_name> [--folder <orchestrator_folder_path>]

• -p, --process-name <process_name> (mandatory) - The name of the process you want to install. The -p short form means process name here, but package ID in the execute command.

  Ejemplo:

  UiRobot.exe installprocess --process-name MyProcess
  

• --folder <orchestrator_folder_path> (optional) - The full path of the Orchestrator folder containing the process you want to install, such as Product/Development/QA. This argument applies only when the connection to Orchestrator is active. If only one folder contains the process for installation, skip this parameter.

  Ejemplo:

  UiRobot.exe installprocess --process-name MyProcess --folder "Product/Development/QA"
  

Conectar

Use this command to connect your Robot to an Orchestrator instance. If your Robot is already connected to a different Orchestrator instance or with different credentials, the command returns the "Orchestrator already connected" message. Run disconnect first to switch. Running it again with the same URL and credentials succeeds and changes nothing.

El comando de conexión utiliza los siguientes argumentos:

UiRobot.exe connect --url <Orchestrator_Server_URL> --clientId <Client_ID> --clientSecret <Client_Secret>

• connect - Establishes the connection to Orchestrator. Must be used together with the --url, --clientId, and --clientSecret arguments.

  Ejemplo:

  UiRobot.exe connect --url https://cloud.uipath.com/<Organization_Name>/<Tenant_Name>/orchestrator_ --clientId <Client_ID> --clientSecret <your-client-secret>
  

  The command also accepts --url with --key <Machine_Key> for a machine key connection. Robots connected with a machine key don't run agents, functions, or API workflows by default, and the command prints a message that calls machine key connections deprecated. For the differences, refer to Connecting the Robot to Orchestrator.

Desconectar

Utiliza este comando para desconectar el Robot de la instancia actual de Orchestrator.

El comando desconectar utiliza los siguientes argumentos:

UiRobot.exe disconnect [--force | --wait]

• disconnect: desconecta el Robot de Orchestrator solo cuando no hay trabajos en ejecución en la máquina del robot.

  Ejemplo:

  UiRobot.exe disconnect
  

• --force: elimina todos los trabajos en ejecución en la máquina y luego desconecta el robot de Orchestrator.

  Ejemplo:

  UiRobot.exe disconnect --force
  

• --wait: espera a que se completen los trabajos en ejecución antes de desconectar el robot de Orchestrator.

  Ejemplo:

  UiRobot.exe disconnect --wait
  

You can't use --force and --wait together. The disconnectandsignout command takes the same arguments, and also signs out the current user.

Trace

Use this command to enable or disable low-level tracing of the UiPath drivers and the browser extension. Tracing of the Robot Executor and Service is always on, and the command prints a warning about it.

El comando de seguimiento utiliza los siguientes argumentos:

UiRobot.exe trace --enableLowLevel | --disableLowLevel

• --enableLowLevel - Starts low-level tracing of the UiPath drivers and the browser extension. Requires administrator rights.

  Ejemplo:

  UiRobot.exe trace --enableLowLevel
  

• --disableLowLevel - Stops it and saves the trace as UiPathTrace-<id>.etl on the Desktop of the user who runs the command. Requires administrator rights. Without them, the command shows an error but still returns exit code 0.

  Ejemplo:

  UiRobot.exe trace --disableLowLevel
  

PiP

Utiliza este comando para habilitar o deshabilitar la sesión del robot o la capacidad Picture in Picture en la máquina. Este ajuste modifica las instalaciones existentes y se aplica a todos los usuarios en la máquina local. Requiere privilegios de administrador.

El comando PiP utiliza los siguientes argumentos:

UiRobot.exe pip --enable | --disable

• --enable - Enables the Robot session (PiP functionality) of the machine.

  Ejemplo:

  UiRobot.exe pip --enable
  

• --disable - Disables the Robot session (PiP functionality) of the machine.

  Ejemplo:

  UiRobot.exe pip --disable
  

Limpiar caché de NuGet

Usa este comando para limpiar las cachés de NuGet: la caché de paquetes globales (donde se encuentran los contenidos .nupkg restaurados) y la caché HTTP (caché de respuesta de la fuente de NuGet). No se deben ejecutar trabajos durante esta operación.

El comando para limpiar la caché de NuGet utiliza los siguientes argumentos:

UiRobot.exe cleannugetcache [--period <period_in_days>] [--timeout <timeout_in_minutes>] [--allow-unsafe]

• -p, --period <period_in_days> (optional, default 30) - Deletes global-packages entries whose .nupkg.metadata file has not been accessed in the last X days. Stale or corrupt package folders (missing .nupkg.metadata) are removed regardless of this value, unless they are listed in nugetclean.ignore. The HTTP cache is wiped in full regardless of this value. Must be greater than 0.

  Ejemplo:

  UiRobot.exe cleannugetcache --period 60
  

• -t, --timeout <timeout_in_minutes> (optional, default 10) - Maximum time, in minutes, to wait for the cleanup. Press Ctrl+C to cancel the cleanup; the command then prints a partial summary.

  Ejemplo:

  UiRobot.exe cleannugetcache --timeout 20
  

• --allow-unsafe (optional, default false) - By default, the command refuses to run if the Robot packages folder (PackagesInstallationFolder in UiPath.config) differs from the default NuGet global-packages folder (a folder that may be shared with other users). Use this flag to force cleanup of the Robot packages folder.

  Importante:

  Cleaning a shared packages folder may break running jobs or apps belonging to other users sharing the folder.

  Ejemplo:

  UiRobot.exe cleannugetcache --period 30 --allow-unsafe
  

El comando imprime un resumen de la limpieza, desglosado por global-packages y http-cache, que incluye cuántas entradas se eliminaron del total que coincidía.

To protect package folders from the cleanup, list them in a nugetclean.ignore file in the global-packages folder. Write one package folder per line, as an absolute path or a path relative to the global-packages folder. A line with only a package ID keeps every version of that package. Blank lines and lines that start with # are ignored.

Establecer credenciales de autenticación básicas del proxy

Usa este comando para establecer las credenciales de autenticación básicas del proxy para el usuario actual. Las credenciales se conservan localmente y el robot las utiliza cuando se comunica a través de un proxy que requiere autenticación básica.

El comando establecer proxy utiliza los siguientes argumentos:

UiRobot.exe setproxy --username <user> --password <password> [--domain <domain>]

• --username <user> (obligatorio): el nombre de usuario para la autenticación básica del proxy.

• --password <password> (obligatorio): la contraseña para la autenticación básica del proxy.

  Ejemplo:

  UiRobot.exe setproxy --username myuser --password <your-password>
  

• --domain <domain> (opcional): el dominio para la autenticación básica del proxy. Úsalo cuando el proxy requiera credenciales cualificadas para el dominio.

  Ejemplo:

  UiRobot.exe setproxy --username myuser --password <your-password> --domain MYDOMAIN
  

Importante:

Al ejecutar el comando, se sobrescribe cualquier credencial de proxy almacenada previamente.

Otros argumentos

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

• version - Displays information about the Robot version. The --version form also works.
• --help: muestra la lista de comandos compatibles, así como la información y ejemplos correspondientes.
• flushlogs [--timeout <timeout_in_seconds>] - Sends all pending logs to Orchestrator. The default timeout is 30 seconds.

Códigos de salida

UiRobot.exe returns the following exit codes:

Código de salida	Significado
0	The command succeeded. For execute, the job completed successfully.
1	For execute, the job failed. For cleannugetcache, the cleanup didn't complete successfully.
2	For execute, the job suspended. The command prints the resumeId of the suspended job.
-1	The command was used incorrectly (invalid or missing arguments), or it failed with an error.