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 the UiPathPlatformInstaller.exe.

Administrator rights are required to execute these commands.

Command
Description

/q

Helps 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 (regutil.exe) 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.

ADDLOCAL

Enables you to select what features you want to install. 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 in user mode. Add the RegisterService parameter if you want to register the Robot as a service. It cannot be used without DesktopFeature.

  • RegisterService - Registers the Robot as a Windows service. 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 - Install 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.

APPLICATIONFOLDER

Enables you to install Studio and Robot in a custom location.

NUGET_OPTIONS

This 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_FOLDER

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 even if the Robot is installed as a service or in user mode.

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^%;
  • In batch scripts - use % - UiPathStudio.msi PACKAGES_FOLDER=C:\Some\Path\%%USERNAME%%
  • In PowerShell console or scripts - no escaping is needed.

If your user is part of an active directory, it is recommended that you use the domain in the folder structure too, such as c:\packages\^%UserDomain^%.^%Username^%.

CUSTOM_NUGET_FEEDS

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. If the value parameter contains blank spaces, please add the entire string between quotation marks. Separate feeds with semicolons (;).
Example: CUSTOM_NUGET_FEEDS="Feed Name 1, https://my.custom.nuget.feed; FeedName2, D:\Custom\Activities\Packages\".

CODE

Licenses your Studio instance.

CONNECTIONSTRING

Automatically connects the Robot to Orchestrator while also installing it.

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 a user mode - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot
  • Silently install Studio, the Robot as a service, the local activities feed, and the Java extension - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages,StartupLauncher,JavaBridge /Q
  • Silently installs Studio, the Robot as a service, the local activities feed, and the Citrix extension - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages,CitrixClient /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 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
  • Silently installs Studio, installs the Robot as a Windows service, disables the official online activity feeds, and adds two custom ones - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService NUGET_OPTIONS=DisableOnlineFeeds CUSTOM_NUGET_FEEDS="Feed Name1, https://my.custom.nuget.feed; FeedName2, D:\RPA\Activities\Packages\" /Q
  • Installs Robot as a Windows service, and disables the official online feeds - UiPathStudio.msi ADDLOCAL=DesktopFeature,Robot,RegisterService NUGET_OPTIONS=DisableOnlineFeeds

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.