- Getting Started
- Studio
- Orchestrator
- Testing robots
- Test Manager
- CI/CD Integrations
UiPath CLI
UiPath® offers a command-line interface (CLI) that allows you to execute certain pre-defined tasks for RPA package management and testing. The purpose of the UiPath CLI is to easily integrate those capabilities with third-party tools like GitLab, Jenkins, and many others, without a plugin.
UiPath CLI can be used with Orchestrator deployed via Automation Cloud™ , Automation Suite, or standalone.
Common use cases for the UiPath CLI involve:
- Packing Studio projects into NuGet packages.
- Deploying NuGet packages to Orchestrator.
- Running jobs in Orchestrator.
- Running Test Sets in Orchestrator.
UiPath CLI consists of two types:
-
UiPath.CLI.Windows
- Runs on Windows devices only.
- Builds Windows - Legacy,Windows, and Cross-platform projects.
-
UiPath.CLI
- Runs on Linux devices only.
- Builds only Cross-platform projects.
-
UiPath CLI does not support SSO connection.
-
UiPath CLI cannot be used to build projects that use Local Triggers.
-
UiPath CLI lacks the functionality to sign a package, a feature that is available when you publish the package from Studio. In this case, the only option is to sign the package after it is built using UiPath CLI. For details, see the sign command. This signing option works also for Azure DevOps and Jenkins.
- For UiPath.CLI, install .NET 6.0.7, that comes with the 6.0.302 SDK, or higher.
- For UiPath.CLI.Windows, install .NET 6.0.7or higher. You must also install .NET Desktop Runtime, that comes with the .NET SDK as well.
You can download any version of the UiPath CLI from the UiPath Official Public Feed, to find the right version for your project, review the compatibility matrix below.
uipcli.exe (for UiPath.CLI.Windows), or uipcli.dll (for UiPath.CLI), located in the tools folder.
The version of the UiPath Studio you are using to create your projects needs to match the version of the UiPath.CLI.Windows.
Legend: - compatible;
- not compatible.
|
Orchestrator |
Project Type |
UiPath.CLI.Windows 23.10 |
UiPath.CLI.Windows 23.6 |
UiPath.CLI.Windows 22.10 |
|---|---|---|---|---|
|
2023.10.x PaaS | Windows - Legacy |
|
|
|
|
2023.10.x PaaS | Windows |
|
|
|
|
2023.10.x PaaS | Cross-platform |
|
|
|
|
2021.10.x On-premises |
Windows - Legacy |
|
|
|
|
2021.10.x On-premises |
Windows |
|
|
|
|
2021.10.x On-premises |
Cross-platform |
|
|
|
|
2021.10.x PaaS |
Windows - Legacy |
|
|
|
|
2021.10.x PaaS |
Windows |
|
|
|
|
2021.10.x PaaS |
Cross-platform |
|
|
|
|
2022.4.x |
Windows - Legacy |
|
|
|
|
2022.4.x |
Windows |
|
|
|
|
2022.4.x |
Cross-platform |
|
|
|
|
2022.10.x |
Windows - Legacy |
|
|
|
|
2022.10.x |
Windows |
|
|
|
|
2022.10.x |
Cross-platform |
|
|
|
| 2023.4.x | Windows-Legacy |
|
|
|
| 2023.4.x | Windows |
|
|
|
| 2023.4.x | Cross-platform |
|
|
|
|
Cloud |
Windows - Legacy |
|
|
|
|
Cloud |
Windows |
|
|
|
|
Cloud |
Cross-platform |
|
|
|
The version of the UiPath Studio you are using to create your projects needs to match the version of the UiPath.CLI. For example, if you create projects using UiPath Studio 2021.10, you need to use the 21.10 version of the UiPath.CLI.
Legend: - compatible;
- not compatible.
| Orchestrator | Project Type | UiPath.CLI 23.10 | UiPath.CLI 23.6 | UiPath.CLI 22.10 | UiPath.CLI 22.4 | UiPath.CLI 21.10 |
|---|---|---|---|---|---|---|
|
2023.10.x PaaS | Windows - Legacy |
|
|
|
|
|
|
2023.10.x PaaS | Windows |
|
|
|
|
|
|
2023.10.x PaaS | Cross-platform |
|
|
|
|
|
|
2021.10.x On-premises |
Windows - Legacy |
|
|
|
|
|
|
2021.10.x On-premises |
Windows |
|
|
|
|
|
|
2021.10.x On-premises |
Cross-platform |
|
|
|
|
|
|
2021.10.x PaaS |
Windows - Legacy |
|
|
|
|
|
|
2021.10.x PaaS |
Windows |
|
|
|
|
|
|
2021.10.x PaaS |
Cross-platform |
|
|
|
|
|
|
2022.4.x |
Windows - Legacy |
|
|
|
|
|
|
2022.4.x |
Windows |
|
|
|
|
|
|
2022.4.x |
Cross-platform |
|
|
|
|
|
|
2022.10.x |
Windows - Legacy |
|
|
|
|
|
|
2022.10.x |
Windows |
|
|
|
|
|
|
2022.10.x |
Cross-platform |
|
|
|
|
|
| 2023.4.x | Windows-Legacy |
|
|
|
|
|
| 2023.4.x | Windows |
|
|
|
|
|
| 2023.4.x | Cross-platform |
|
|
|
|
|
|
Cloud |
Windows - Legacy |
|
|
|
|
|
|
Cloud |
Windows |
|
|
|
|
|
|
Cloud |
Cross-platform |
|
|
|
|
|
