# Robot Command Line Interface > 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, stop, or monitor attended and unattended automations directly from the command line. You can also get details on installed packages, create logs, or update configurations. 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, stop, or monitor attended and unattended automations directly from the command line. You can also get details on installed packages, create logs, or update configurations. ## How it works To use the CLI, make sure of the following aspects: * The Robot service is running * You are in the directory in which the Robot is installed. Then type in instructions or commands that refer to the `UiRobot.exe` program along with the necessary parameters, depending on what you want your automation to achieve. For example, to start a process from the command line, you would use the following command: ``` UiRobot.exe -file "C:\UiPath\Projects\YourProject\Main.xaml". ``` ## Common UiRobot.exe commands ### Execute Use this command to start the execution of a project file of the following types: * JSON * XAML * NUPKG :::note With Robot version 2023.4 and onwards, UiPath refreshes the process list at the same time a process executes. If a process update is available at the job start, the job uses the older version of the process. Subsequent runs apply the updated process. ::: The execute command uses the following arguments: ``` UiRobot.exe execute [--process | --file ] [--folder ] [--input ] ``` * `-p--process ` (mandatory) - Starts the execution of a local or Orchestrator process. Examples: ``` UiRobot.exe execute --process UiPathDemoProcess ``` ``` UiRobot.exe execute -p UiPathDemoProcess ``` * `-f--file ` (mandatory) - Starts the execution of a local project file. The target file can be JSON, XAML, or NUPKG. Examples: ``` UiRobot.exe execute --file "C:\UiPath\Automation\Project.json" ``` ``` UiRobot.exe execute --file "C:\UiPath\Automation\Project.json" ``` ``` UiRobot.exe execute --file "C:\UiPath\Automation\Project.json" ``` * `--folder ` (optional) - Allows you to specify the Orchestrator folder from which to install and execute the target process. It can only be used together with the `--process` argument. Example: ``` UiRobot.exe -Execute --process UiPathDemoProcess --folder OrchFolder1 ``` * **`--input `** (optional) - Allows you to specify input arguments for execution. It can be used with the `--process` or `--file` arguments. Examples: ``` 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}" ``` * `--entry ` (optional) - Allows you to select the entry point of a process when starting it via the command line. Example: ``` UiRobot execute --file "C:\UiPath\Project\project.1.0.3.nupkg" --input "{'inArg':'value','integer':3}" --entry "OtherEntryPoint.xaml" ``` :::important * The following commands are not supported for Windows or cross-platform projects: ``` UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml" ``` ``` UiRobot.exe execute --file "C:\UiPath\Automation\Project.json" ``` * You cannot use the `--process (-p)` and `--file (-f)` arguments simultaneously in the execute command. ::: ### Install process Use this command to install a process. If the robot is connected to Orchestrator, it searches for the process in the Orchestrator feed. Without an Orchestrator connection, the robot uses the local feed. The install process command uses the following arguments: ``` UiRobot.exe installprocess [--process-name ] [--folder ] ``` * **`--process-name `** (mandatory) - The name of the process you want to install. Example: ``` UiRobot installprocess --process-name MyProcess ``` * **`--folder `** (optional) - The name of the Orchestrator folder containing the process you want to install. This argument applies only when the connection to Orchestrator is active. If only one folder contains the process for installation, skip this parameter. Example: ``` UiRobot installprocess -p MyProcess --folder MyOrchestratorFolder ``` ### Connect Use this command to connect your Robot to an Orchestrator instance. If your robot is already connected to Orchestrator and you run this command, it returns the "Orchestrator already connected" message. The connect command uses the following arguments: ``` UiRobot.exe connect [--url --key ] | [--connectionString ] ``` * `connect` - Establishes the connection to Orchestrator. Must be used together the `--url`, `--key`, or `--clientID --clientSecret` arguments. If you do not specify these arguments, the command uses the [Orchestrator Settings](https://docs.uipath.com/orchestrator/automation-cloud/latest/user-guide/configuring-tenant-settings) configuration. Examples: ``` // no arguments UiRobot.exe connect ``` ``` //using the machine key UiRobot.exe connect --url https://demo.uipath.com/ --key 1122AAB3C-DD44-ABCD-1234-7788GG99HH00 ``` ``` //using the client ID and secret UiRobot.exe connect --url https://demo.uipath.com/ --clientID 696CCA0C-1234-ABCD-1234-F65BBC2F15DE --clientSecret QJX!jv12345A4q4N ``` ### Disconnect Use this command to disconnect the Robot from the current Orchestrator instance. The disconnect command uses the following arguments: ``` UiRobot.exe disconnect --force | --wait ``` * **`disconnect`** - Disconnects the Robot from Orchestrator only when there are no running jobs on the robot machine. Example: ``` UiRobot.exe disconnect ``` * **`--force`** - Kills all running jobs on the machine and then disconnects the Robot from Orchestrator. Example: ``` UiRobot.exe disconnect --force ``` * **`--wait`** - Waits for running jobs to complete before disconnecting the Robot from Orchestrator. Example: ``` UiRobot.exe disconnect --wait ``` ### Trace Use this command to enable or disable low-level tracing for the Robot. The trace command uses the following arguments: ``` UiRobot.exe trace --enableLowLevel | --disableLowLevel ``` * **`--enableLowLevel`** - Enables verbose tracing for the Robot Executor and Service in the Event Viewer. It generates an ETL file that you can open with the Event Viewer for assistance in troubleshooting crashes and errors. Example: ``` UiRobot.exe trace --enableLowLevel ``` * `--disableLowLevel` - Disables verbose tracing for the Robot Executor and Service. It generates an ETL file that you can open with the Event Viewer for assistance in troubleshooting crashes and errors. Example: ``` UiRobot.exe trace --disableLowLevel ``` ### PiP Use this command to enable or disable the Robot session or picture-in-picture capability on the machine. This setting modifies existing installations and applies to all users on the local machine. Requires administrator privileges. The PiP command uses the following arguments: ``` UiRobot.exe pip --enable | --disable ``` * **`--enable`** - Enables the Robot session (PiP functionality ) of the machine. Example: ``` UiRobot.exe pip --enable ``` * `--disable` - Disables the Robot session (PiP functionality ) of the machine. Example: ``` UiRobot.exe pip --disable ``` ### Clean NuGet cache Use this command to clean the NuGet caches: the global-packages cache (where restored `.nupkg` contents live) and the HTTP cache (NuGet feed response cache). Jobs should not be running during this operation. The clean NuGet cache command uses the following arguments: ``` UiRobot.exe cleannugetcache [--period ] [--timeout ] [--allow-unsafe] ``` * **`-p`, `--period `** (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 always removed. The HTTP cache is wiped in full regardless of this value. Must be greater than `0`. Example: ``` UiRobot.exe cleannugetcache --period 60 ``` * **`-t`, `--timeout `** (optional, default `10`) - Maximum time, in minutes, the cleanup is allowed to run. When the timeout expires, the operation is canceled and a partial summary is printed. Example: ``` UiRobot.exe cleannugetcache --timeout 20 ``` * **`--allow-unsafe`** (optional, default `false`) - By default, the command refuses to run if the Robot is configured to use a custom NuGet `globalPackagesFolder` (a folder that may be shared with other users). Use this flag to force cleanup of that custom folder. :::important Cleaning a shared global-packages folder may break running jobs or apps belonging to other users sharing the folder. ::: Example: ``` UiRobot.exe cleannugetcache --period 30 --allow-unsafe ``` The command prints a summary of the cleanup, broken down by `global-packages` and `http-cache`, including how many entries were deleted out of the total that matched. ### Set proxy basic authentication credentials Use this command to set proxy basic authentication credentials for the current user. The credentials are persisted locally and used by the Robot when communicating through a proxy that requires basic authentication. The set proxy command uses the following arguments: ``` UiRobot.exe setproxy --username --password [--domain ] ``` * **`--username `** (mandatory) - The username for proxy basic authentication. * **`--password `** (mandatory) - The password for proxy basic authentication. Example: ``` UiRobot.exe setproxy --username myuser --password mypassword ``` * **`--domain `** (optional) - The domain for proxy basic authentication. Use this when the proxy requires domain-qualified credentials. Example: ``` UiRobot.exe setproxy --username myuser --password mypassword --domain MYDOMAIN ``` :::important Running the command overwrites any previously stored proxy credentials. ::: ### Other arguments The following arguments are purely informative and have no impact on your automation projects: * `--version` - Displays information about the Robot version. * `--help` - Displays the list of supported commands, as well as corresponding information and examples. * `flushlogs [--timeout ]` - Sends all pending logs to Orchestrator.