Interface de ligne de commande du 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.

Mode de fonctionnement

Pour utiliser la CLI, veillez à ce que les conditions suivantes soient remplies :

• Le service de robot UiPath est en cours d’exécution
• Vous vous trouvez dans le répertoire dans lequel le Robot est installé.

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).

Par exemple, pour démarrer un processus à partir de la ligne de commande, vous allez utiliser la commande suivante :

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

Commandes UiRobot.exe courantes

Exécuter

Utilisez cette commande pour démarrer l’exécution d’un fichier de projet s’il appartient aux types suivants :

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

Remarque :

À partir de la version 2023.4 de Robot, UiPath actualise la liste des processus en même temps qu’un processus s’exécute. Si une mise à jour de processus est disponible au moment du démarrage de la tâche, celle-ci utilise l’ancienne version du processus. Les exécutions suivantes appliqueront le processus mis à jour.

La commande d’exécution utilise les arguments suivants :

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.

  Exemples :

  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.

  Exemple :

  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.

  Exemple :

  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.

  Exemple :

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

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

  Exemples :

  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.

  Exemple :

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

  Important :

  • Les commandes suivantes ne sont pas disponibles pour les projets Windows ou multiplateformes :

    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.

Installer un processus

Utilisez cette commande pour installer un processus. Si le robot est connecté à Orchestrator, il va rechercher le processus dans le flux Orchestrator. En l’absence de connexion à Orchestrator, le Robot utilise le flux local.

La commande d’installation de processus utilise les arguments suivants :

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.

  Exemple :

  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.

  Exemple :

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

Connecter

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.

La commande de connexion utilise les arguments suivants :

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.

  Exemple :

  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.

Se déconnecter (Disconnect)

Utilisez cette commande pour déconnecter le Robot de l’instance d’Orchestrator actuelle.

La commande de déconnexion utilise les arguments suivants :

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

• disconnect : déconnecte le Robot d’Orchestrator uniquement lorsqu’il n’y a pas de tâche en cours d’exécution sur la machine robot.

  Exemple :

  UiRobot.exe disconnect
  

• --force : interrompt toutes les tâches en cours d’exécution sur la machine, puis déconnecte le Robot d’Orchestrator.

  Exemple :

  UiRobot.exe disconnect --force
  

• --wait : attend la fin des tâches en cours d’exécution avant de déconnecter le Robot d’Orchestrator.

  Exemple :

  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.

Traçage (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.

La commande de traçage utilise les arguments suivants :

UiRobot.exe trace --enableLowLevel | --disableLowLevel

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

  Exemple :

  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.

  Exemple :

  UiRobot.exe trace --disableLowLevel
  

PiP

Utilisez cette commande pour activer ou désactiver la session Robot ou la fonctionnalité d’incrustation d’image sur la machine. Ce paramètre modifie les installations existantes et s’applique à tous les utilisateurs de la machine locale. Il nécessite des privilèges administrateurs.

La commande PiP utilise les arguments suivants :

UiRobot.exe pip --enable | --disable

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

  Exemple :

  UiRobot.exe pip --enable
  

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

  Exemple :

  UiRobot.exe pip --disable
  

Nettoyer le cache NuGet

Utilisez cette commande pour nettoyer les caches NuGet : le cache des packages globaux (où se trouve le contenu .nupkg restauré) et le cache HTTP (cache de réponse de flux NuGet). Les tâches ne doivent pas être en cours d'exécution pendant cette opération.

La commande Nettoyer le cache NuGet utilise les arguments suivants :

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.

  Exemple :

  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.

  Exemple :

  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.

  Important :

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

  Exemple :

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

La commande imprime un résumé du nettoyage, réparti par global-packages et http-cache, y compris le nombre d'entrées supprimées du total qui correspondait.

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.

Définir les identifiants d'authentification de base du proxy

Utilisez cette commande pour définir les identifiants d'authentification de base du proxy pour l'utilisateur actuel. Les identifiants sont conservés localement et utilisés par le robot lors de la communication via un proxy qui nécessite une authentification de base.

La commande de proxy défini utilise les arguments suivants :

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

• --username <user> (obligatoire) : nom d'utilisateur pour l'authentification de base du proxy.

• --password <password> (obligatoire) - Le mot de passe pour l'authentification de base du proxy.

  Exemple :

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

• --domain <domain> (facultatif) - Le domaine pour l'authentification de base du proxy. Utilisez cela lorsque le proxy nécessite des identifiants qualifiés pour le domaine.

  Exemple :

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

Important :

L'exécution de la commande écrase tous les identifiants de proxy précédemment stockés.

Autres arguments

Les arguments suivants sont purement informatifs et n’ont aucun impact sur vos projets d’automatisation :

• version - Displays information about the Robot version. The --version form also works.
• --help : affiche la liste des commandes prises en charge, ainsi que des informations et des exemples correspondants.
• flushlogs [--timeout <timeout_in_seconds>] - Sends all pending logs to Orchestrator. The default timeout is 30 seconds.

Codes de sortie

UiRobot.exe returns the following exit codes:

Code de sortie	Signification
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.