Command Line Arguments Descriptions
It is possible to install or update Studio or Robot using the command line, provided you have the UiPathStudio.msi
installer. The table below lists all the available parameters you can use, paired with some examples.
Important!
Changes to your existing instance of the UiPath Platform cannot be made from the Command Prompt, in silent mode. However, changes to what is installed when performing an update are fully supported.
Setup command-line arguments do not work on
UiPathPlatformInstaller.exe
.Administrator rights are required to execute these commands.
Command | Description |
---|---|
| Helps you install the specified UiPath features silently, without displaying the user interface. |
| Generates an installer log file at the specified path. Starting with v2018.4.2, this file can also include licensing information if you license Studio or Robot at install time. You can send the file further to our support team if, for any reason, you encounter difficulties during the installation process. |
| Enables you to select what features to install. If It supports the following options:
|
| Enables you to install Studio and Robot in a custom location. |
| This parameter is recommended if you are working in an offline environment. If set to Please note that the URL feeds are not deleted from the configuration files, just ignored. It can be used for both installations and upgrades. |
| Enables you to change the download location of your workflows and their dependencies for Studio and/or Robot. This folder can be user specific or accessible by all users from a machine. This parameter can be used either if the Robot is installed as a service or in user mode. For the Service Mode Robot, packages are concurrently installed on all users. Please note that, for multiple User Mode Robots installed on a machine, the packages folder cannot be the same (such as If you do not provide this parameter the default folder is For installations on Windows Server machines (that enable concurrent execution - HD Robots), you must provide paths that are specific to each user. Using the same shared folder for all users in HD environments is not supported. It is possible to use environment variables such as In batch scripts - use In PowerShell console or scripts - no escaping is needed. If your user is an Active Directory domain account, it is recommended that you specify the domain name in the folder structure too, such as |
| Enables you to add custom NuGet activities feeds for Studio and/or Robot. This command only adds or updates the existing list of feeds. It must be populated with key-value pairs of type string. Valid locations include online feeds, folder paths, and shared network drives. Make sure that the provided feeds are reachable by all users from a given machine. Separate feeds with semicolons (;). Example: |
| Optional. Enables you to enforce your Robots to execute only signed packages. It can be used at clean installs or updates of your instances. If this parameter is not specified at deploy-time, package signing is not enabled. It supports the following options: |
| Licenses your Studio instance. |
| Automatically connects the Robot to Orchestrator using the connection string while also installing it. Please note that the following are required: |
| Automatically installs the Chrome Extension via policy. It supports the following options: |
| Allows you to disable security of It supports the following options: Note: This parameter can only be used during a clean install or upgrade. |
| Allows you to define the URL of the Orchestrator instance users will connect to using Interactive Sign-In. |
| Allows you to disable the usage data collection and can be done at install time for Studio and Robot. Telemetry is enabled by default for Studio and Robot, to disable it during install, use the following value for the parameter: Note: This disables telemetry for both Studio and Robot. If you want to re-enable telemetry, use the following value: For more information about usage data collection and how to change telemetry settings, see the Opting Out of Telemetry document. |
Examples
These examples have been written considering that you are already in the directory in which the UiPathStudio.msi
installer is located. You can do this with the following command, for example: cd D:\UiPathInstaller
.
- Install Studio, a Robot as a Windows service and the activities packages -
UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages
- Install Studio and a Robot in user mode -
UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot
- Silently install the entire Desktop suite -
UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages,StartupLauncher,JavaBridge /Q
- Silently install the entire Desktop suite and the Chrome Extension via policy -
UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages,ChromeExtension CHROME_INSTALL_TYPE=STORE /Q
- Silently install Studio, the Robot as a Windows service and the activities packages, all in the
D:\UiPath
folder -UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages APPLICATIONFOLDER=D:\UiPath /Q
- Silently install the Robot as a Windows service and connect it to Orchestrator -
UiPathStudio.msi ADDLOCAL=DesktopFeature,Robot,RegisterService CONNECTIONSTRING=https://platform.uipath.com/api/robotsservice/GetConnectionData?tenantId=1 /Q
- Silently install Studio, the Robot as a Windows service, and add two custom activity feeds -
UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService CUSTOM_NUGET_FEEDS="Feed Name1, https://my.custom.nuget.feed; FeedName2, D:\RPA\Activities\Packages\" /Q
- Silently install and license Studio, a Robot registered as a Windows service and the local activity feed -
UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages CODE=1234567890 /Q
- Install Robot as a Windows service, and disable the official online feeds -
UiPathStudio.msi ADDLOCAL=DesktopFeature,Robot,RegisterService NUGET_OPTIONS=DisableOnlineFeeds
Updated 2 days ago