Subscribe

UiPath Studio

The UiPath Studio Guide

Command Line Parameters

Command Line Arguments Descriptions

It is possible to install or update Studio or Robot using the command line, provided you have the UiPath Studio Windows installer (UiPathStudio.msi). The table below lists all the available parameters you can use, paired with some examples.

For the command line arguments that can be used with Orchestrator, please click here.

📘

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.

CommandDescription
/qHelps you install the specified UiPath features silently, without displaying the user interface.
/l*vx <LogFile>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.
ADDLOCALEnables you to select what features to install. If ADDLOCAL is used, only the features specified in it are installed. If ADDLOCAL is not used, the features enabled by default in the UI version are installed (Studio, the Robot in service mode, and the local activities feed).

It supports the following options:

DesktopFeature - indicates that you want to install Robot and Studio features.

Studio - Installs Studio. It cannot be used without DesktopFeature.

Robot - Installs the Robot. Add the RegisterService parameter to install the Service Mode Robot or the RegisterUserModeService to install the User Mode Robot. It cannot be used without DesktopFeature.

RegisterService - Installs the Service Mode Robot. Can only be used with the Robot and the DesktopFeature arguments.

RegisterUserModeService - Installs the User Mode Robot. Can only be used with the Robot and the DesktopFeature arguments.

UseAgentDesktop - Installs Agent Desktop. Can only be used with the Robot and the DesktopFeature arguments.

UseRobotTray - Installs the Robot Tray. Can only be used with the Robot and the DesktopFeature arguments.

Packages - Installs the activities packages. It cannot be used without the DesktopFeature and Robot arguments.

StartupLauncher - Runs the Robot at Windows startup. It cannot be used without the DesktopFeatureand Robot arguments.

JavaBridge - Installs the UiPath Java Bridge for a better integration and automation in regards to Java applications. Please note that installing the Java Bridge may cause the installation to last longer than usual. It cannot be used without the DesktopFeature and Robot arguments.

ChromeExtension - Installs the UiPath Google Chrome Extension. It cannot be used without the DesktopFeature and Robot arguments.

CitrixClient - Installs the UiPath Citrix Client Extension. It cannot be used without the DesktopFeature and Robot arguments.
APPLICATIONFOLDEREnables you to install Studio and Robot in a custom location.
NUGET_OPTIONSThis parameter is recommended if you are working in an offline environment. If set to DisableOnlineFeeds, this parameter helps you disable the online UiPath official and Community feeds for the Robot - only the Orchestrator and local feeds are taken into consideration.

Please note that the URL feeds are not deleted from the configuration files, just ignored.

It can be used for both installations and upgrades.
PACKAGES_FOLDEREnables 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 Service Mode or User Mode Robot is installed.

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 C:\Packages). This is because the first User Mode Robot which download and installs a package restricts the .XAML file access only to that user, making other User Mode Robots on that machine unable to use the corresponding folder, or package because of insufficient privileges.

Please note that if you set the same package folder (such as C:\Packages) for User Mode Robots on a machine packages are not installed, because of privilege restrictions. Only Service Mode Robots share the same package folder, since it is installed per system.

If you do not provide this parameter the default folder is %userProfile%\.nuget\packages.

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 %USERNAME% or %USERPROFILE%. The % special character needs to be escaped as follows:
When the setup is invoked from Command Prompt - use `-UiPathStudio.msi PACKAGES_FOLDER=C:\Some\Path^%USERNAME%; :fa-caret-right: In batch scripts - use %-UiPathStudio.msi PACKAGES_FOLDER=C:\Some\Path%%USERNAME%%; :fa-caret-right: 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 C:\packages^%UserDomain^%.%Username%`.
CUSTOM_NUGET_FEEDSEnables 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: CUSTOM_NUGET_FEEDS="FeedName1,https://my.custom.nuget.feed; FeedName2,D:\Custom\Activities\Packages\".
ENFORCE_SIGNED_EXECUTIONOptional. 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:
1 - The Robot is able to download, install, or execute only packages author or repository signed by UiPath. If you want to add your own certificate as a trusted source, you have to do so by modifying the nuget.config file. To learn how to do this, please see this page.
0 - No package signing rule is enforced on your Robot deployment.

For information on how to enforce signed execution after installation, see Signing Packages.
CODELicenses your Studio instance.
CONNECTIONSTRINGAutomatically connects the Robot to Orchestrator using the connection string while also installing it. Please note that the following are required:
the WindowsAuth.Enabled parameter from the web.config file has to be set to true
the WindowsAuth.Domain parameter has to be set to a valid domain
the Service Mode Robot
CHROME_INSTALL_TYPEAutomatically installs the Chrome Extension via policy.

It supports the following options:

GLOBAL - The Chrome Extension is automatically installed per system, the equivalent of calling the /ChromeGlobal command using the SetupExtenstions tool.

STORE - The Chrome Extension is automatically installed per system via policy, the equivalent of calling the /ChromePolicyGlobal command using the SetupExtenstions tool.
DISABLE_SECURE_XAMLAllows you to disable security of XAML files for Service Mode Robots. Unsecured XAML files allow users to read and modify the process files and logic.

It supports the following options:
0 - The default option. When used, it enables security for XAML files for Service Mode Robots.
1 - Disables security for XAML files for Service Mode Robots.

Note: This parameter can only be used during a clean install or upgrade.

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 Service Mode Robot and the activities packages - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages
  • Install Studio and a User Mode Robot - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterUserModeService
  • 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
  • Install Studio, a Service Mode Robot, Agent Desktop, and the local activity feed - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages,UseAgentDesktop
  • Silently install Studio, the Service Mode Robot 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 Service Mode Robot 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 Service Mode Robot, 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 Service Mode Robot and the local activity feed - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages CODE=1234567890 /Q
  • Install a Service Mode Robot, and disable the official online feeds - UiPathStudio.msi ADDLOCAL=DesktopFeature,Robot,RegisterService NUGET_OPTIONS=DisableOnlineFeeds

Updated 7 months ago

Command Line Parameters

Suggested Edits are limited on API Reference Pages

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