Test Suite
2023.4
false
UiPath CLI - Standalone 2023.4
Banner background image
logo
Test Suite
Last updated Feb 8, 2024

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.

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:

  1. UiPath.CLI.Windows

    • Runs on Windows devices only.
    • Builds Windows - Legacy,Windows, and Cross-platform projects.
  2. UiPath.CLI

    • Runs on Linux devices only.
    • Builds only Cross-platform projects.

Prerequisites

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

Downloading the CLI

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.

  1. Go to the UiPath Official Public Feed.
  2. In the Filter by keywords search bar, type uipath.cli.
  3. Select either one of the options below:
    • UiPath.CLI
    • UiPath.CLI.Windows
  4. Go to the Versions tab, and select a version of the CLI that you want to download.
  5. Select Download.
  6. Open the folder where the NUPKG file is downloaded, right-click it, and extract the file into a folder.
Results: A folder with the same name as the NUPKG file is created. This folder holds the contents of the UiPath CLI. The entrypoint for all operations is uipcli.exe (for UiPath.CLI.Windows), or uipcli.dll (for UiPath.CLI), located in the tools folder.

UiPath.CLI.Windows Compatibility Matrix

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 23.6

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.xWindows-Legacydocs image
2023.4.xWindowsdocs image
2023.4.xCross-platformdocs image

Cloud

Windows - Legacy

Cloud

Windows

Cloud

Cross-platform

UiPath.CLI Compatibility Matrix

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

UiPath.CLI 22.10

UiPath.CLI 22.4

UiPath.CLI 21.10

2021.10.x On-premises

Windows - Legacy

docs image

docs imagedocs image

2021.10.x On-premises

Windows

docs image

2021.10.x On-premises

Cross-platform

docs image

docs image

2021.10.x PaaS

Windows - Legacy

docs image

2021.10.x PaaS

Windows

docs image

2021.10.x PaaS

Cross-platform

docs image

docs image

2022.4.x

Windows - Legacy

docs image

docs imagedocs image

2022.4.x

Windows

docs image

2022.4.x

Cross-platform

docs image

docs image

2022.10.x

Windows - Legacy

docs image

2022.10.x

Windows

docs image

2022.10.x

Cross-platform

docs image

2023.4.xWindows-Legacydocs imagedocs imagedocs imagedocs image
2023.4.xWindowsdocs imagedocs imagedocs imagedocs image
2023.4.xCross-platformdocs imagedocs imagedocs imagedocs image

Cloud

Windows - Legacy

docs image

Cloud

Windows

docs image

Cloud

Cross-platform

docs image

docs image

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