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.

Note:

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:

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.

Note: UiPath CLI does not support SSO connection.

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

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

Controlling the NuGet feeds used by the CLI

Disabling the built-in NuGet feeds

By default, uipcli searches for dependencies in the following built-in feeds:

• https://pkgs.dev.azure.com/uipath/Public.Feeds/_packaging/UiPath-Official/nuget/v3/index.json

• https://gallery.uipath.com/api/v2

• https://api.nuget.org/v3/index.json

• C:\Program Files\Microsoft SDKs\NuGetPackages(if this path is on the current agent)
• C:\Program Files (x86)\Microsoft SDKs\NuGetPackages (if this path is on the current agent)

You can specify uipcli to not use the built-in feeds by setting the --disableBuiltInNugetFeeds parameter. This parameter can be passed to the following tasks: analyze, pack, and test run.

When you run uipcli with a configuration file, set "disableBuiltInNugetFeeds": true.

Using custom NuGet feeds

You can use custom feeds when packing an automation. To do this, you need to:

1. Create a custom nuget.config file with the following format:

   <?xml version="1.0" encoding="utf-8"?>
   <configuration>
     <packageSources>
       <add key="test custom feed" value="custom_feed_url" />
     </packageSources>
   </configuration>

2. Place the custom nuget.config file in the folder where uipcli is cached:

   

Using custom nuget.config in Azure DevOps

You need to update the configuration and copy nuget.config to $(Agent.ToolsDirectory)/uipcli, after the InstallPlatform step, as shown in the following example:

trigger:
- main

pool:
  vmImage: ubuntu-latest

stages:
- stage: Demo
  jobs:
    - job: Demo
      steps:
        - task: UiPathInstallPlatform@4
          inputs:
            cliVersion: 'X_23.6.8581.19168'
        
        - task: CopyFiles@2
          inputs:
            SourceFolder: '$(Build.SourcesDirectory)'
            Contents: 'nuget.config'
            TargetFolder: '$(Agent.ToolsDirectory)/uipcli'

        - task: UiPathPack@4
          inputs:
            versionType: 'AutoVersion'
            projectJsonPath: '$(Build.SourcesDirectory)/AutomationProjects/CrossPlatform/VB/ProjectWithCustomLibraryFromOrchestrator_CrossPlatform_VB/project.json'
            outputPath: '$(Build.ArtifactStagingDirectory)/Output'
            traceLevel: 'Information'

Using custom nuget.config in Jenkins

You need to update the configuration and copy nuget.config to ${WORKSPACE}/CLI, after the InstallPlatform step, as shown in the following example:

pipeline {
    agent {
        label 'plugins-jenkins-lts-agent-01'
    }

    stages {
        stage('Clone') {
            steps {
                git (
                    branch: 'main',
                    url: 'https://github.com/al3xandru-uipath-qa/CI-Plugins-Customer-Support.git'
                )
            }
        }
        
        stage('Install Platform') {
            steps {
                UiPathInstallPlatform (
                    traceLevel: 'Information'
                )
            }
        }
        
        stage('Copy nuget.config') {
            steps {
                bat 'copy nuget.config CLI\\nuget.config'
            }
        }
        
        stage('Pack') {
            steps {
                UiPathPack (
                    outputPath: '${WORKSPACE}/Output',
                    projectJsonPath: '${WORKSPACE}/AutomationProjects/CrossPlatform/VB/ProjectWithCustomLibraryFromOrchestrator_CrossPlatform_VB/project.json',
                    traceLevel: 'Information',
                    version: AutoVersion()
                )
            }
        }
    }
}