- Release Notes
- Getting Started
- UiPath® Assistant
- Installation and Upgrade
- Robot Types
- Robot Components
- Robot Service
- Robot Executor
- Command Line Interface
- Licensing
- Connecting Robots to Orchestrator
- Processes and Activities
- Logging
- Robot JavaScript SDK
- Specific Scenarios
- Restarting Robot Components
- Windows Sessions
- Login Using Thales Luna Credential System
- Login Using NShield Key Storage Provider
- Redirecting Robots Through a Proxy Server
- Executing Tasks in a Minimized RDP Window
- Using Mapped Network Drives
- Stopping a Process
- Disable Stop Button
- Custom Package Folders and Network Paths
- CrowdStrike Integration
- Robot Citrix Apps Virtualization
- Troubleshooting
- Common Connection Errors
- Unresponsive Robot Over RDP
- Duplicate Execution Logs
- Frequently Encountered Robot Errors
- Increased Process Execution Duration
- Enforced Package Signature Verification
- Message Too Large to Process
- Errors When Running as Administrator
- NuGet Packages Not Accessible After Migration
- User Access Control Prompt and UI Automation Activities
- .NET required during installation
- Assembly Cannot Be Loaded From Network Or Azure File Share
- Activities cannot find .NET Runtime
Command Line Interface
The Robot Command Line Interface (UiRobot.exe) is a console application which can request to start jobs, and waits for their output. It is a direct client of the Robot service, and communication is done through a WCF channel.
To make use of the command line arguments supported by Robots, make sure that the UiPath® Robot service is running. If not, start it from the Services Microsoft Management Console snap-in.
cd C:\Program Files\UiPath\Studio
.
All the examples displayed in the Arguments Description chapter are constructed from the assumption that you performed this action.
To make it easier for you to work with command line arguments, navigate to the directory in which the Robot is installed using the change directory command. For example, if you did not change the default location of the Robot, you can use the following command:
cd C:\Program Files\UiPath\Studio
.
All the examples displayed here are constructed from the assumption that you first executed the command above.
Attended Robots should only run under human supervision.
UiRobot.exe execute [--process <Package_ID> | --file <File_Path>] [--folder <Orchestrator_Folder_ID>] [--input <Input_Parameters>]
.json
, .xaml
, or .nupkg
). Please note that the --process
(-p
) and --file
(-f
) arguments can not be simultaneously used with the execute
command. It supports the following arguments:
Argument |
Description |
---|---|
-p--process <Package_ID> |
Mandatory. Starts the execution of a local or Orchestrator process. Examples:
|
-f--file <File_Path> |
Mandatory. Starts the execution of a local project file. The target file can be .json, .xaml, or .nupkg. Examples:
|
--folder <Orchestrator_Folder_ID> |
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:
|
--input <Input_Parameters> |
Optional. Allows you to specify input arguments for execution. It can be used with the --process or --file arguments. Examples:
|
--entry <entrypoint> |
Allows you to select the entry point of a process when starting it via the command line. Example:
|
UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml"
UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml"UiRobot.exe execute --file "C:\UiPath\Automation\Project.json"
UiRobot.exe execute --file "C:\UiPath\Automation\Project.json"
UiRobot.exe installprocess [--process-name <process_name>] [--folder <orchestrator_folder>]
installprocess
command is used to install a process. When the robot is connected to Orchestrator, the robot only looks for the process in
the Orchestrator feed. When the robot is not connected to Orchestrator, the local feed is used.
The following arguments are supported:
Argument | Description |
---|---|
--process-name <process_name> | Mandatory. The name of the process to be installed.
Example:
|
--folder <orchestrator_folder> | Optional. The name of the Orchestrator folder in which the process to be installed is found. This argument can only be used when the
robot is connected to Orchestrator. If the process to be installed is found in only one folder, the parameter is not needed.
Example:
|
UiPath.Studio.CommandLine.exe publish
instead of UiRobot.exe pack
. For more information, see Mass Update Command Line Parameters in the Studio guide.
UiRobot.exe pack <Project_Path> --output <Destination_Folder> [-v <Project_Version>]
Project.json
file into a .nupkg
file. It supports the following arguments:
Argument | Description |
---|---|
|
Mandatory. Allows you to specify where the
.nupkg file is created.
Example:
|
|
Optional. Allows you to specify a version for the
.nupkg file.
Example:
|
-
UiRobot.exe connect [--url <Orchestrator_Server_URL> --key <Machine_Key>] | [--connectionString <Connection_String>]
Note: If the Robot is already connected, running theconnect
command returns the following message:Orchestrator already connected!
.
This command is used to connect the Robot to an Orchestrator instance. It supports the following arguments:
Argument |
Description |
---|---|
|
Used to connect the robot to Orchestrator, must be used with the
--url , --key , or --clientID --clientSecret arguments. If the arguments are not specified, the Orchestrator configuration in Assistant is used to establish the connection.
Example:
Machine Key example:
Client ID and Client Secret example:
|
This command is used to disconnect the Robot from the current Orchestrator instance.
Argument | Description |
---|---|
UiRobot.exe disconnect |
Disconnect the Robot from Orchestrator. This command only works if there are no running jobs on the robot machine. |
UiRobot.exe disconnect --force | Disconnect the Robot from Orchestrator. If there is a job runnig on the machine, the job gets killed and only afterwards the robot is disconnected |
UiRobot.exe disconnect --wait | Disconnect the Robot from Orchestrator. If there is a job runnig on the machine, the robot is disconnected only after the job completes. |
UiRobot.exe trace --enableLowLevel | --disableLowLevel
This command is used to enable or disable low-level (verbose) tracing for the Robot. It supports the following arguments:
Argument |
Description |
---|---|
|
Enables low-level tracing. An
.etl file is generated, which can be opened with the Event Viewer, to help you with troubleshooting crashes and errors.This enables
verbose tracing for the Robot Executor and Service in the Event Viewer.
Example:
|
|
Disables low-level tracing. An
.etl file is generated to the Desktop after you stop it. This file can be opened in the Event Viewer, to help you with troubleshooting
crashes and errors.
Example:
|
Allows you to enable or disable the Picture in Picture functionality on the machine. This setting is applied on the local machine and affects all users and is used for modifying existing installations.
Administrator rights are required to execute these commands.
Command |
Description |
---|---|
|
Enables the Picture in Picture functionality of the machine. |
|
Disables the Picture in Picture functionality of the machine. |
Allows you to enable the Picture in Picture functionality of the machine during the UiPath® command-line installation.
Command |
Description |
---|---|
|
Enables the Picture in Picture functionality of the machine. |
|
Does not enable the Picture in Picture functionality of the machine. |
The following commands are purely informative and have no impact on your automation projects whatsoever:
Argument |
Description |
---|---|
|
Displays information about the Robot version. |
|
Displays the list of supported commands, as well as corresponding information and examples. |
|
Sends all pending logs to Orchestrator. |