About UiPath CLI

UiPath® propose une interface de ligne de commande (CLI) qui vous permet d'exécuter certaines tâches prédéfinies dans le cadre de la gestion et du test des packages RPA. Le but de la CLI 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 .

Remarque :

• CLI UiPath ne prend pas en charge la connexion via authentification unique.

• CLI UiPath ne peut pas être utilisée pour créer des projets utilisant des déclencheurs locaux.

• UiPath CLI ne dispose pas de la fonctionnalité permettant de signer un package, une fonctionnalité qui est disponible lorsque vous publiez le package à partir de Studio. Dans ce cas, la seule option consiste à signer le package après sa création à l'aide de la CLI UiPath. Pour plus de détails, consultez la commande sign. Cette option de signature fonctionne également pour Azure DevOps et Jenkins.

Prérequis

Here you can verify the compatibility between the CLI version, the required .NET version, and the target Robot version.

CLI version	Version .NET requise	Version cible du robot pour les automatisations intégrées
24.10	.NET 8	24.10+
23.10	.NET 6	23.10+
23.4	.NET 6	23.4+

For UiPath.CLI.Windows, you must also install .NET Desktop Runtime, that comes with the .NET SDK as well.

Downloading UiPath CLI

You can download any version of the UiPath CLI from the UiPath Official Public Feed.

1. Accédez au flux public officiel 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 :
   • UiPath.CLI - UiPath CLI designed for Linux devices
   • UiPath.CLI.Windows - UiPath CLI designed for Windows devices
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

Managing NuGet feeds

This section describes how you can manage the build-in NuGet feeds. Moreover, it provides information on how you can use custom NuGet feeds according to your specific project requirements.

Désactivation des flux NuGet intégrés

Par défaut, uipcli recherche les dépendances dans les flux intégrés suivants :

• 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(si ce chemin se trouve sur l'agent actuel)
• C:\Program Files (x86)\Microsoft SDKs\NuGetPackages (si ce chemin se trouve sur l'agent actuel)

You can specify uipcli to not use the built-in feeds by setting the --disableBuiltInNugetFeeds parameter. This parameter can be used to the following tasks: analyze, pack, and test run.When you run uipcli with a configuration file, set "disableBuiltInNugetFeeds": true.

Utilisation de flux NuGet personnalisés

You can use custom feeds when packing an automation.

Using custom nuget.config in UiPath CLI

To use custom feed, take the following steps:

1. Créez un fichier nuget.config personnalisé avec le format suivant :

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

2. Placez le fichier nuget.config personnalisé dans le dossier où uipcli est mis en cache :

   

Utilisation de nuget.config personnalisé dans Azure DevOps

Vous devez mettre à jour la configuration et copier nuget.config vers $(Agent.ToolsDirectory)/uipcli, après l’étape InstallPlatform , comme illustré dans l’exemple suivant :

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'

Utilisation de nuget.config personnalisé dans Jenkins

Vous devez mettre à jour la configuration et copier nuget.config vers ${WORKSPACE}/CLI, après l’étape InstallPlatform , comme illustré dans l’exemple suivant :

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