automation-ops
latest
false
Important :
Veuillez noter que ce contenu a été localisé en partie à l’aide de la traduction automatique.
Guide de l'utilisateur Automation Ops
Automation CloudAutomation Cloud Public SectorAutomation Suite
Last updated 30 août 2024

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

  • 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.7ou 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 l'interface de ligne de commande 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 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: available compatibles ; Non disponible - 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

available

available

available

2023.10.x PaaS

Windows

available

available

available

2023.10.x PaaS

Multiplateforme

available

available

available

2021.10.x On-Premises

Windows - Héritage

available

available

available

2021.10.x On-Premises

Windows

available

available

available

2021.10.x On-Premises

Multiplateforme

available

available

available

2021.10.x PaaS

Windows - Héritage

available

available

available

2021.10.x PaaS

Windows

available

available

available

2021.10.x PaaS

Multiplateforme

available

available

available

2022.4.x

Windows - Héritage

available

available

available

2022.4.x

Windows

available

available

available

2022.4.x

Multiplateforme

available

available

available

2022.10.x

Windows - Héritage

available

available

available

2022.10.x

Windows

available

available

available

2022.10.x

Multiplateforme

available

available

available

2023.4.xWindows-héritage

available

available

available

2023.4.xWindows

available

available

available

2023.4.xMultiplateforme

available

available

available

Cloud

Windows - Héritage

available

available

available

Cloud

Windows

available

available

available

Cloud

Multiplateforme

available

available

available

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: available compatibles ; Non disponible - non compatible.

OrchestratorType de projetUiPath.CLI 23.10UiPath.CLI 23.6UiPath.CLI 22.10UiPath.CLI 22.4UiPath.CLI 21.10

2023.10.x PaaS

Windows - Héritage

Non disponible

Non disponible

Non disponible

Non disponible

Non disponible

2023.10.x PaaS

Windows

Non disponible

Non disponible

Non disponible

Non disponible

Non disponible

2023.10.x PaaS

Multiplateforme

available

available

available

available

available

2021.10.x On-Premises

Windows - Héritage

Non disponible

Non disponible

Non disponible

available

available

2021.10.x On-Premises

Windows

Non disponible

Non disponible

Non disponible

Non disponible

Non disponible

2021.10.x On-Premises

Multiplateforme

available

available

available

available

available

2021.10.x PaaS

Windows - Héritage

Non disponible

Non disponible

Non disponible

available

available

2021.10.x PaaS

Windows

Non disponible

Non disponible

Non disponible

Non disponible

Non disponible

2021.10.x PaaS

Multiplateforme

available

available

available

available

available

2022.4.x

Windows - Héritage

Non disponible

Non disponible

Non disponible

available

available

2022.4.x

Windows

Non disponible

Non disponible

Non disponible

Non disponible

Non disponible

2022.4.x

Multiplateforme

available

available

available

available

available

2022.10.x

Windows - Héritage

Non disponible

Non disponible

Non disponible

available

available

2022.10.x

Windows

Non disponible

Non disponible

Non disponible

Non disponible

Non disponible

2022.10.x

Multiplateforme

available

available

available

available

available

2023.4.xWindows-héritage

Non disponible

Non disponible

Non disponible

available

available

2023.4.xWindows

Non disponible

Non disponible

Non disponible

Non disponible

Non disponible

2023.4.xMultiplateforme

available

available

available

available

available

Cloud

Windows - Héritage

Non disponible

Non disponible

Non disponible

available

available

Cloud

Windows

Non disponible

Non disponible

Non disponible

Non disponible

Non disponible

Cloud

Multiplateforme

available

available

available

available

available

Contrôle des flux NuGet utilisés par la CLI

Désactivation des flux NuGet intégrés

Par défaut, uipcli recherche les dépendances dans les flux intégrés suivants : Vous pouvez spécifier uipcli pour ne pas utiliser les flux intégrés en définissant le paramètre --disableBuiltInNugetFeeds . Ce paramètre peut être utilisé pour les tâches suivantes : analyze, pack et test run.
Lorsque vous exécutez uipcli avec un fichier de configuration, définissez "disableBuiltInNugetFeeds": true.
docs image
docs image

Utilisation de flux NuGet personnalisés

Vous pouvez utiliser des flux personnalisés lors de la mise en package d’une automatisation. Pour ce faire, vous devez :

  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><?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 :
    docs image

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

Cette page vous a-t-elle été utile ?

Obtenez l'aide dont vous avez besoin
Formation RPA - Cours d'automatisation
Forum de la communauté UiPath
Uipath Logo White
Confiance et sécurité
© 2005-2024 UiPath Tous droits réservés.