UiPath CLI Setup Action

A GitHub Action for setting up the UiPath CLI on GitHub Actions runners.

Note on compatibility: This action is compatible with both Windows and Ubuntu runners. UiPath offers two separate command line tools for the different operating systems, UiPath.CLI and UiPath.CLI.Windows installed on Ubuntu and Windows respectively. These have different capabilities in terms of project compatibility, noted in the Compatiblity Matrix sections of this documentation page

How to use

Copy one of the example usage snippets from the sections below into your GitHub Actions workflow.

In further steps of your workflow, you can now use the UiPath CLI (uipcli):

• Packing Studio projects into NuGet packages.
• Deploying NuGet packages to Orchestrator.
• Running jobs in Orchestrator.
• Running Test Sets in Orchestrator.

See the UiPath documentation for reference on tasks that can be performed with the command line tool

Example usage, with default CLI version

Copy the snippet below for using the setup-uipath action, with the UiPath.CLI based on default inputs, see action.yml and Inputs section below for more details.

      # Set up the UiPath CLI (uipcli) and add it to PATH on your runner
      - name: Setup UiPath (uipcli) command line tool
        uses: Mikael-RnD/setup-uipath@v2

Example usage, with specific UiPath CLI version

Copy the snippet below for using the setup-uipath action, with a UiPath CLI version of your choosing. In the example below, version 24.12.9111.31003 is used.

      # Set up the UiPath CLI (uipcli) and add it to PATH on your runner
      - name: Setup UiPath (uipcli) command line tool
        uses: Mikael-RnD/setup-uipath@v2
        with:
          version: 24.12.9111.31003

Example usage, with specific UiPath Platform version

Copy the snippet below for using the setup-uipath action, with a UiPath CLI version selected based on the version of UiPath used in your environment (Studio and/or Robot versions based on their Major/Minor version). In the example below, version 24.10 is used.

      # Set up the UiPath CLI (uipcli) and add it to PATH on your runner
      - name: Setup UiPath (uipcli) command line tool
        uses: Mikael-RnD/setup-uipath@v2
        with:
          platform-version: '24.10'

Inputs

See action.yml for default values on inputs.

Name	Description	Required	Example value
version	Specific version of the UiPath CLI to download from the UiPath-Official Feed	False	23.10.8753.32995
platform-version	Version of the UiPath platform used (e.g. version of robots and Studio used) in major and minor version, such as "24.10" or "23.10". If version is provided, this input will be ignored.	False	23.10