studio
2021.10
false
Studio User Guide
Last updated Sep 23, 2024

Command Line Parameters

You can install and update Studio and the Robot, or change an existing installation by running the UiPathStudio.msi or UiPathStudioCloud.msi installer from the command line.

See the following sections for descriptions of the available parameters and a few usage examples.

Note:
  • Administrator rights are required to execute these commands.
  • Changing an existing installation by running the installer from the command line in silent mode is not supported. However, you can run the installer in silent mode to update from an older version.
  • Using the /passive option of msiexec.exe to run an unattended installation is not supported.

Command Line Arguments Descriptions

The following table lists all available command line parameters.

All parameters can be used for clean installations, but only the following are supported when updating from an older version or changing an existing installation:

  • Enabling / disabling features using ADDLOCAL. Please note that the Robot cannot be disabled.
  • SERVICE_URL - available when switching the Robot from service mode to user mode by not including the RegisterService argument.
  • NUGET_OPTIONS, ENFORCE_SIGNED_EXECUTION, DISABLE_SECURE_XAML, and TELEMETRY_ENABLED - not available for changing existing installations.

    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 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 to install. If ADDLOCAL is used, only the features specified in it are installed. If ADDLOCAL is not used, the following features are installed: Studio, the Robot in service mode, the activities packages, and the JavaScript add-on.

    It supports the following options:

    DesktopFeature - indicates that you want to install Robot and Studio features.
    Studio - Installs Studio.
    ExcelAddin - Installs the StudioX Excel Add-in. It cannot be used without Studio.
    Robot - Installs the Robot in user mode or service mode, as well as the Assistant.
    • To install the Robot in service mode, also add the RegisterService option. This is the recommended choice for unattended Robots.
    • To install the Robot in user mode, do not add the RegisterService option. This is the recommended choice for attended and development Robots.
    Note: If you convert the Robot from service mode to user mode, the Robot might not be able to access the .xaml files from the original NuGet Packages folder. For details on how to resolve this, see the NuGet packages not accessible after migration troubleshooting article.
    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.
    EdgeExtension - Installs the UiPath Microsoft Edge Chromium-based Extension. It cannot be used without the Robot argument.
    CitrixClient - Installs the UiPath Citrix Client Extension. It cannot be used without the DesktopFeature and Robot arguments.
    JavaScriptAddOn - Installs the Robot JavaScript add-on to support the Robot JavaScript SDK.
    SapPlugin - Installs the SAP Solution Manager plugin. Requires the SAP Connector for Microsoft to be installed on your machine. On clean installs, you must also provide an address for the instance using the SAP_SOL_MAN_HOST parameter. It cannot be used without Studio.

    MSIINSTALLPERUSER
    Enables you to install Studio and Robot only for the current user. To install per user, add MSIINSTALLPERUSER=1. To install per machine, do not include this parameter.

    SAP_SOL_MAN_HOST
    Hostname or IP address for your SAP Solution Manager instance. Required for clean installs if the SapPlugin argument was provided for the ADDLOCAL option.
    For example UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,SapPlugin SAP_SOL_MAN_HOST=ip_address

    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.
    Note: The NUGET_OPTIONS parameter does not disable the online UiPath official and Community feeds for Studio.

    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 for both service mode and user mode robots. If you do not provide this parameter, the default folder is %userProfile%\.nuget\packages.
    Note: When changing the packages folder, make sure that all the users that need to execute processes have read access to this folder.
    Note: When using the PACKAGES_FOLDER parameter, there are some limitations. For more information, see Custom Package Folders and Network Paths.
    If you need 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.
    • When using Active Directory domain accounts, it is recommended to specify the domain name in the folder structure too, such as C:\packages\^%UserDomain^%.^%Username^%.
    • For installations on Windows Server machines (that enable concurrent execution - HD Robots), you must provide paths that are specific to each user. Read more about using the same path for multiple robots.
    Note: When using the PACKAGES_FOLDER parameter, there are some limitations. Find out more in the custom package folders and network paths documentation.

    For information on how to change the download folder for packages after installation, see Managing Activities Packages.

    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. Separate feeds with semicolons (;).

    Example: CUSTOM_NUGET_FEEDS="FeedName1,https://my.custom.nuget.feed; FeedName2,D:\Custom\Activities\Packages\".

    ENFORCE_SIGNED_EXECUTION

    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:

    • 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 .

    CODE

    Licenses your Studio instance.

    CONNECTIONSTRING

    Automatically connects the Robot to Orchestrator on-premises using the connection string while also installing it. Please note that the following are required:

    • the WindowsAuth.Enabled parameter from the UiPath.Orchestrator.dll.config file has to be set to true
    • the WindowsAuth.Domain parameter has to be set to a valid domain
    • the Service Mode Robot
    • a Standard Machine configuration has to be in place.
    Note: Automatic enrollment with standard machines using the CONNECTIONSTRING can only be used with Orchestrator v2020.10.

    CHROME_INSTALL_TYPE

    Automatically 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_XAML
    Allows you to disable security of XAML files for Robots installed as a Windows service. 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 Windows service Robots.
    • 1 - Disables security for XAML files for Windows service Robots.
    Note: This parameter can only be used during a clean install or an update.

    SERVICE_URL

    Allows you to define the URL of the Orchestrator instance users will connect to using Interactive Sign-In.

    The provided URL is saved in the uipath.config file, and it's only saved for user-mode Robots. For service-mode installations, the argument is ignored.
    When running the installer to update from an older version or change your existing installation, this parameter is supported if you are switching the Robot from service mode to user mode (the RegisterService option is not included).

    ORCHESTRATOR_URL
    In a clean installation, you can specify the main Orchestrator URL, used for retrieving auto-update information (e.g. https://orchestrator.local/organizationName/tenantName).

    TELEMETRY_ENABLED

    Allows you to disable the usage data collection and can be done at install time for Studio and Robot.

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

    Telemetry is enabled by default for Studio and Robot. To disable it, use the following value for the parameter whenever you perform a clean installation or an update:

    • TELEMETRY_ENABLED=0
    Note: This disables telemetry for both Studio and Robot.

    If you want to enable telemetry, do not include the parameter, or include it with the following value:

    • TELEMETRY_ENABLED=1

    For more information about usage data collection and how to change telemetry settings, see the Opting Out of Telemetry document.

    ENABLE_PIP

    Allows you to enable the Picture in Picture functionality of the machine during the UiPath command-line installation.

    To enable it, use the following parameter:

    • ENABLE_PIP=1

    Example:

    UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages ENABLE_PIP=1

    ORCHESTRATOR_AUTO_SIGNIN

    		If you install the attended robot in user mode and your environment is configured to use SSO with Azure Active Directory, this enables automatic sign-in to your account. This parameter must be used together with ORCHESTRATOR_URL.
    To enable this option, use ORCHESTRATOR_AUTO_SIGNIN=1.

    ENFORCE_DEFAULT_SERVICE_URL

    For user-mode installations, this parameter enforces the default service URL.

    To enable this option, use ENFORCE_DEFAULT_SERVICE_URL=1.
    ORCHESTRATOR_URL must also be enabled.

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 only for the current user - UiPathStudio.msi MSIINSTALLPERUSER=1 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://demo.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
  • Command Line Arguments Descriptions
  • Examples

Was this page helpful?

Support and Services
Get The Help You Need
UiPath Academy
Learning RPA - Automation Courses
UiPath Forum
UiPath Community Forum
Uipath Logo White
Trust and Security
Terms of Use
Privacy Policy
Cookies Policy
© 2005-2024 UiPath. All rights reserved.