- Release Notes
- Getting Started
- Setup and Configuration
- Automation Projects
- Dependencies
- Types of Workflows
- File Comparison
- Automation Best Practices
- Source Control Integration
- Debugging
- The Diagnostic Tool
- Workflow Analyzer
- About Workflow Analyzer
- ST-NMG-001 - Variables Naming Convention
- ST-NMG-002 - Arguments Naming Convention
- ST-NMG-004 - Display Name Duplication
- ST-NMG-005 - Variable Overrides Variable
- ST-NMG-006 - Variable Overrides Argument
- ST-NMG-008 - Variable Length Exceeded
- ST-NMG-009 - Prefix Datatable Variables
- ST-NMG-011 - Prefix Datatable Arguments
- ST-NMG-012 - Argument Default Values
- ST-NMG-016 - Argument Length Exceeded
- ST-DBP-002 - High Arguments Count
- ST-DBP-003 - Empty Catch Block
- ST-DBP-007 - Multiple Flowchart Layers
- ST-DBP-020 - Undefined Output Properties
- ST-DBP-023 - Empty Workflow
- ST-DBP-024 - Persistence Activity Check
- ST-DBP-025 - Variables Serialization Prerequisite
- ST-DBP-026 - Delay Activity Usage
- ST-DBP-027 - Persistence Best Practice
- ST-DBP-028 - Arguments Serialization Prerequisite
- Variables
- Arguments
- Imported Namespaces
- Recording
- UI Elements
- Control Flow
- Selectors
- Object Repository
- Data Scraping
- Image and Text Automation
- Automating Citrix Technologies
- RDP Automation
- SAP Automation
- VMware Horizon Automation
- Logging
- The ScaleCoordinates Migration Tool
- The ScreenScrapeJavaSupport Tool
- The WebDriver Protocol
- StudioPro
- Extensions
- Troubleshooting
Command Line Parameters
UiPathStudio.msi
installer. The table below lists all the available parameters you can use, paired with some examples.
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.
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
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. It cannot be used without DesktopFeature .
ExcelAddin - Installs the StudioX Excel Add-in. It cannot be used without Studio.
Robot - Installs the Robot in user mode or service mode. It cannot be used without DesktopFeature .
UseLegacyTray - Installs the legacy robot tray instead of UiPath Assistant.
Note: To switch to Assistant after install, run
REMOVE=UseLegacyTray .
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 DesktopFeature and 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 Browser Embedding add-on for robot.
|
|
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
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. |
|
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
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.
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. Read more about using the same path for multiple robots It is possible to use environment variables such as
%USERNAME% or %USERPROFILE% . The % special character needs to be escaped as follows:
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^% .
For information on how to change the download folder for packages after installation, see Managing Activities Packages. |
|
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\" .
|
|
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:
For information on how to enforce signed execution after installation, see Signing Packages . |
|
Licenses your Studio instance. |
|
Automatically connects the Robot to Orchestrator on-premises using the connection string while also installing it. Please note that the following are required:
Note: Automatic enrollment with standard machines using the
connectionstring can only be used with Orchestrator v2020.10.
|
|
Automatically installs the Chrome Extension via policy. It supports the following options:
|
|
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:
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. 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).
|
|
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. |
|
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:
Example:
|
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://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