UiPath Robot

Arguments Description

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 (x86)\UiPath\Studio.

All the examples displayed here are constructed from the assumption that you first executed the command above.

Note:

All commands can be used with projects created with Studio v2019.4.x and lower.

The Execute Command

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

This command is used to start the execution of a process or a file (.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:

  • UiRobot.exe execute --process UiPathDemoProcess
  • UiRobot.exe execute -p UiPathDemoProcess

-f
--file <File_Path>

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\Main.xaml"
  • UiRobot.exe execute --file "C:\UiPath\Automation\Notepad.1.0.6682.21636.nupkg"

--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:

  • UiRobot.exe -Execute --process UiPathDemoProcess --folder OrchFolder1

--input <Input_Parameters>

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}"

The Pack Command

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

This command is used to pack a Project.json file into a .nupkg file. It supports the following arguments:

Argument
Description

-o
--output <Destination_Folder>

Mandatory. Allows you to specify where the .nupkg file is created.
Example:

  • UiRobot.exe pack "C:\UiPath\Automation\Project.json" --output "C:\UiPath\Automation\Packages"

-v <Project_Version>

Optional. Allows you to specify a version for the .nupkg file.
Example:

  • UiRobot.exe pack "C:\UiPath\Automation\Project.json" --output "C:\UiPath\Automation\Packages" -v 1.0.6820.22047

The Connect Command

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

This command is used to connect the Robot to an Orchestrator instance. It supports the following arguments:

Argument
Description

connect

Mandatory. If the --url, --key, or --connectionString arguments are not specified, the Orchestrator Settings configuration is used to establish the connection.
Example:

  • UiRobot.exe connect

--url <Orchestrator_Server_URL>

Optional. Must be used with the --key argument. Allows you to specify the target Orchestrator instance.
Example:

  • UiRobot.exe connect --url https://demo.uipath.com/ --key 1122AAB3C-DD44-EE55-FF66-7788GG99HH00

--key <Machine_Key>

Optional. Must be used with the --url argument. Allows you to specify the Machine Key used to connect to Orchestrator.
Example:

  • UiRobot.exe connect --url https://demo.uipath.com/ --key 1122AAB3C-DD44-EE55-FF66-7788GG99HH00

--connectionString

Optional. Allows you to connect to Orchestrator via the connection string.
Example:

  • UiRobot.exe connect --connectionString https://demo.uipath.com/api/robotsservice/GetConnectionData?tenantId=1

The Disconnect Command

  • UiRobot.exe disconnect

This command is used to disconnect the Robot from the current Orchestrator instance.

The Trace Command

  • 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

--enableLowLevel

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:

  • UiRobot.exe trace --enableLowLevel

--disableLowLevel

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:

  • UiRobot.exe trace --disableLowLevel

Miscellaneous Commands

The following commands are purely informative and have no impact on your automation projects whatsoever:

Argument
Description

-version

Displays information about the Robot version.

-help

Displays the list of supported commands, as well as corresponding information and examples.



Arguments Description


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.