Interface de ligne de commande UiPath

UiPath propose une interface de ligne de commande (CLI) qui vous permet d'exécuter certaines tâches prédéfinies pour la gestion et le test des packages RPA. L’objectif de l’interface de ligne de commande UiPath est d’intégrer facilement ces fonctionnalités à des outils tiers tels que GitLab, Jenkins et bien d’autres, sans plug-in.

Remarque :

UiPath CLI peut être utilisé avec Orchestrator déployé via Automation Cloud, Automation Suite ou version autonome.

Les cas d'utilisation courants de l'interface de ligne de commande UiPath impliquent :

• Emballage de projets Studio dans des packages NuGet.
• Déployer des packages NuGet sur Orchestrator.
• Exécution de tâches dans Orchestrator.
• Exécution d'ensembles de tests dans Orchestrator.

La CLI UiPath se compose de deux types :

1. UiPath.CLI.Windows

   • Fonctionne uniquement sur les appareils Windows.
   • Génère des projets Windows - Legacy,Windowset multiplateformes .

2. CheminUi.CLI

   • Fonctionne uniquement sur les appareils Linux.
   • Génère uniquement des projets multiplateformes .

Note: UiPath CLI does not support SSO connection.

Prérequis

• Pour UiPath.CLI, installez .NET 6.0.7, fourni avec le SDK 6.0.302 ou toute version ultérieure.
• Pour UiPath.CLI.Windows, installez .NET 6.0.7 ou supérieur. Vous devez également installer .NET Desktop Runtime, qui est également fourni avec le SDK .NET.

Téléchargement de la CLI

Vous pouvez télécharger n’importe quelle version de la CLI UiPath à partir du flux public officiel UiPath. Pour trouver la bonne version pour votre projet, consultez la matrice de compatibilité ci-dessous.

1. Accédez au flux public officiel de UiPath.
2. Dans la barre de recherche Filtrer par mots clés (Filtrer par mots clés), saisissez uipath.cli .
3. Sélectionnez l'une des options ci-dessous :
   • CheminUi.CLI
   • UiPath.CLI.Windows
4. Accédez à l'onglet Versions (Versions) et sélectionnez une version de la CLI que vous souhaitez télécharger.
5. Sélectionnez Télécharger.
6. Ouvrez le dossier dans lequel le fichier NUPKG est téléchargé, cliquez dessus avec le bouton droit et extrayez le fichier dans un dossier.

Résultats: un dossier portant le même nom que le fichier NUPKG est créé. Ce dossier contient le contenu de l'interface de ligne de commande UiPath. Le point d'entrée de toutes les opérations est uipcli.exe (pour UiPath.CLI.Windows) ou uipcli.dll (pour UiPath.CLI), situé dans le dossier tools .

Matrice de compatibilité UiPath.CLI.Windows

La version d'UiPath Studio que vous utilisez pour créer vos projets doit correspondre à la version de UiPath.CLI.Windows.

Légende: compatibles ; - non compatible.

Orchestrator	Type de projet	UiPath.CLI.Windows 23.10	UiPath.CLI.Windows 23.6	UiPath.CLI.Windows 22.10
2023.10.x PaaS	Windows - Héritage
2023.10.x PaaS	Windows
2023.10.x PaaS	Multiplateforme
2021.10.x On-Premises	Windows - Héritage
2021.10.x On-Premises	Windows
2021.10.x On-Premises	Multiplateforme
2021.10.x PaaS	Windows - Héritage
2021.10.x PaaS	Windows
2021.10.x PaaS	Multiplateforme
2022.4.x	Windows - Héritage
2022.4.x	Windows
2022.4.x	Multiplateforme
2022.10.x	Windows - Héritage
2022.10.x	Windows
2022.10.x	Multiplateforme
2023.4.x	Windows-héritage
2023.4.x	Windows
2023.4.x	Multiplateforme
Cloud	Windows - Héritage
Cloud	Windows
Cloud	Multiplateforme

Matrice de compatibilité UiPath.CLI

La version de UiPath Studio que vous utilisez pour créer vos projets doit correspondre à la version de UiPath.CLI. Par exemple, si vous créez des projets à l'aide d'UiPath Studio 2021.10, vous devez utiliser la version 21.10 de UiPath.CLI.

Légende: compatibles ; - non compatible.

Orchestrator	Type de projet	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 - Héritage
2023.10.x PaaS	Windows
2023.10.x PaaS	Multiplateforme
2021.10.x On-Premises	Windows - Héritage
2021.10.x On-Premises	Windows
2021.10.x On-Premises	Multiplateforme
2021.10.x PaaS	Windows - Héritage
2021.10.x PaaS	Windows
2021.10.x PaaS	Multiplateforme
2022.4.x	Windows - Héritage
2022.4.x	Windows
2022.4.x	Multiplateforme
2022.10.x	Windows - Héritage
2022.10.x	Windows
2022.10.x	Multiplateforme
2023.4.x	Windows-héritage
2023.4.x	Windows
2023.4.x	Multiplateforme
Cloud	Windows - Héritage
Cloud	Windows
Cloud	Multiplateforme

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()
                )
            }
        }
    }
}