Über UiPath-CLI

UiPath® bietet eine Befehlszeilenschnittstelle (CLI), mit der Sie bestimmte vordefinierte Aufgaben für die Verwaltung und das Testen von RPA-Paketen ausführen können. Der Zweck der UiPath-CLI ist es, diese Funktionen einfach und ohne Plugin mit Drittanbieter-Tools wie GitLab, Jenkins und vielen anderen zu integrieren.

Hinweis:

UiPath CLI kann mit dem Orchestrator verwendet werden, der über die Automation Cloud™, die Automation Suite oder eigenständig bereitgestellt wird.

Häufige Anwendungsfälle für die UiPath-CLI sind:

• Packen von Studio-Projekten in NuGet-Pakete.
• Bereitstellen von NuGet-Paketen im Orchestrator.
• Ausführen von Aufträgen im Orchestrator.
• Ausführen von Testsätzen im Orchestrator.

UiPath CLI besteht aus zwei Typen:

1. UiPath.CLI.Windows

   • Wird nur auf Windows-Geräten ausgeführt.
   • Erstellt Windows – Legacy-,Windows-und plattformübergreifende Projekte.

2. UiPath.CLI

   • Läuft nur auf Linux-Geräten.
   • Erstellt nur plattformübergreifende Projekte.

Hinweis:

• UiPath-CLI unterstützt keine SSO-Verbindung.

• Die UiPath-CLI kann nicht verwendet werden, um Projekte zu erstellen, die Lokale Trigger verwenden.

• Der UiPath-CLI fehlt die Funktionalität zum Signieren eines Pakets – eine Funktion, die verfügbar ist, wenn Sie das Paket über Studio veröffentlichen. In diesem Fall besteht die einzige Option darin, das Paket zu signieren, nachdem es mit der UiPath-CLI erstellt wurde. Weitere Informationen finden Sie unter dem Signierungsbefehl. Diese Signaturoption funktioniert auch für Azure DevOps und Jenkins.

Voraussetzungen

Hier können Sie die Kompatibilität zwischen der CLI-Version, der erforderlichen .NET-Version und der Ziel-Roboterversion überprüfen.

CLI-Version	.NET-Version erforderlich	Zielroboterversion für die erstellten Automatisierungen
24.10	.NET 8	2024.10+
23.10	.NET 6	2023.10+
23.4	.NET 6	2023.4+

Für UiPath.CLI.Windows müssen Sie auch .NET Desktop Runtime installieren, das auch mit .NET SDK mitgeliefert wird.

Herunterladen der UiPath-CLI

Sie können jede Version der UiPath-CLI aus dem offiziellen öffentlichen UiPath-Feed herunterladen.

1. Rufen Sie den offiziellen öffentlichen Feed von UiPathauf.
2. Geben Sie in der Suchleiste Nach Schlüsselwörtern filtern uipath.cli ein.
3. Wählen Sie eine der folgenden Optionen aus:
   • UiPath.CLI - UiPath-CLI, die für Linux-Geräte entwickelt wurde
   • UiPath.CLI.Windows – UiPath-CLI für Windows-Geräte
4. Wechseln Sie zur Registerkarte Versionen , und wählen Sie eine Version der CLI aus, die Sie herunterladen möchten.
5. Wählen Sie Herunterladen aus.
6. Öffnen Sie den Ordner, in den die NUPKG-Datei heruntergeladen wurde, klicken Sie mit der rechten Maustaste darauf und extrahieren Sie die Datei in einen Ordner.

Ergebnisse: Ein Ordner mit demselben Namen wie die NUPKG-Datei wird erstellt. Dieser Ordner enthält den Inhalt der UiPath CLI. Der Einstiegspunkt für alle Vorgänge ist uipcli.exe (für UiPath.CLI.Windows) oder uipcli.dll (für UiPath.CLI) im Ordner tools .

UiPath.CLI.Windows-Kompatibilitätsmatrix

Die Version von UiPath Studio, die Sie zum Erstellen Ihrer Projekte verwenden, muss mit der Version von UiPath.CLI.Windows übereinstimmen.

Legende: - kompatibel; - nicht kompatibel.

Orchestrator	Projekttyp	UiPath.CLI.Windows 23.10	UiPath.CLI.Windows 23.6	UiPath.CLI.Windows 22.10
2023.10.x hat PaaS	Windows – Legacy
2023.10.x hat PaaS	Windows
2023.10.x hat PaaS	Plattformübergreifend
2021.10.x Lokal (On-Premises)	Windows – Legacy
2021.10.x Lokal (On-Premises)	Windows
2021.10.x Lokal (On-Premises)	Plattformübergreifend
2021.10.x PaaS	Windows – Legacy
2021.10.x PaaS	Windows
2021.10.x PaaS	Plattformübergreifend
2022.4.x	Windows – Legacy
2022.4.x	Windows
2022.4.x	Plattformübergreifend
2022.10.x	Windows – Legacy
2022.10.x	Windows
2022.10.x	Plattformübergreifend
2023.4.x	Windows – Legacy
2023.4.x	Windows
2023.4.x	Plattformübergreifend
Cloud	Windows – Legacy
Cloud	Windows
Cloud	Plattformübergreifend

UiPath.CLI-Kompatibilitätsmatrix

Die Version von UiPath Studio, die Sie zum Erstellen Ihrer Projekte verwenden, muss mit der Version von UiPath.CLI übereinstimmen. Wenn Sie beispielsweise Projekte mit UiPath Studio 2021.10 erstellen, Sie müssen die Version 21.10 von UiPath.CLI verwenden.

Legende: - kompatibel; - nicht kompatibel.

Orchestrator	Projekttyp	UiPath.CLI 23.10	UiPath.CLI 23.6	UiPath.CLI 22.10	UiPath.CLI 22.4	UiPath.CLI 21.10
2023.10.x hat PaaS	Windows – Legacy
2023.10.x hat PaaS	Windows
2023.10.x hat PaaS	Plattformübergreifend
2021.10.x Lokal (On-Premises)	Windows – Legacy
2021.10.x Lokal (On-Premises)	Windows
2021.10.x Lokal (On-Premises)	Plattformübergreifend
2021.10.x PaaS	Windows – Legacy
2021.10.x PaaS	Windows
2021.10.x PaaS	Plattformübergreifend
2022.4.x	Windows – Legacy
2022.4.x	Windows
2022.4.x	Plattformübergreifend
2022.10.x	Windows – Legacy
2022.10.x	Windows
2022.10.x	Plattformübergreifend
2023.4.x	Windows – Legacy
2023.4.x	Windows
2023.4.x	Plattformübergreifend
Cloud	Windows – Legacy
Cloud	Windows
Cloud	Plattformübergreifend

Verwalten von NuGet-Feeds

In diesem Abschnitt wird beschrieben, wie Sie die integrierten NuGet-Feeds verwalten können. Darüber hinaus erhalten Sie Informationen darüber, wie Sie benutzerdefinierte NuGet-Feeds gemäß Ihren spezifischen Projektanforderungen verwenden können.

Deaktivieren der integrierten NuGet-Feeds

Standardmäßig sucht uipcli nach Abhängigkeiten in den folgenden integrierten 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(wenn sich dieser Pfad auf dem aktuellen Agenten befindet)
• C:\Program Files (x86)\Microsoft SDKs\NuGetPackages (wenn sich dieser Pfad auf dem aktuellen Agenten befindet)

Sie können festlegen, dass uipcli die integrierten Feeds nicht verwendet, indem Sie den Parameter --disableBuiltInNugetFeeds festlegen. Dieser Parameter kann für die folgenden Aufgaben verwendet werden: analyze, pack und test run. Wenn Sie uipcli mit einer Konfigurationsdatei ausführen, legen Sie "disableBuiltInNugetFeeds": true fest.

Verwenden benutzerdefinierter NuGet-Feeds

Sie können benutzerdefinierte Feeds beim Packen einer Automatisierung verwenden.

Verwenden von benutzerdefinierter nuget.config in der UiPath-CLI

Führen Sie die folgenden Schritte aus, um den benutzerdefinierten Feed zu verwenden:

1. Erstellen Sie eine benutzerdefinierte nuget.config -Datei mit dem folgenden Format:

2. Platzieren Sie die benutzerdefinierte nuget.config -Datei in dem Ordner, in dem uipcli zwischengespeichert wird:

   

Verwenden von benutzerdefinierten nuget.config in Azure DevOps

Sie müssen die Konfiguration aktualisieren und nuget.config $(Agent.ToolsDirectory)/uipclinach dem InstallPlatform Schritt in kopieren, wie im folgenden Beispiel gezeigt:

 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'

Verwenden einer benutzerdefinierten nuget.config-Datei in Jenkins

Sie müssen die Konfiguration aktualisieren und nuget.config ${WORKSPACE}/CLInach dem InstallPlatform Schritt in kopieren, wie im folgenden Beispiel gezeigt:

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

Abrufen von Automatisierungsabhängigkeiten für Umgebungen mit Air Gap

Dieser Abschnitt informiert Sie über den Erhalt der Automatisierungsabhängigkeiten, wenn Sie den Übergang von einer Online- zu einer Offline-Umgebung mit Air Gaps planen. Wenn eine Automatisierung benutzerdefinierte Bibliotheken verwendet, müssen diese manuell in die Zielumgebung übertragen werden.

Die UiPath-CLI bietet eine automatisierte Möglichkeit, sowohl die abhängigen NuGet-Pakete zu sichern als auch in die Zielumgebung hochzuladen.

Bevor Sie fortfahren, stellen Sie sicher, dass Sie die folgenden Voraussetzungen erfüllen:

• Stellen Sie sicher, dass Sie die neueste Version der UiPath-CLI verwenden (mindestens 24.12).

• Stellen Sie ggf. sicher, dass Sie .NET 8 installieren.

• Erstellen Sie eine externe App mit dem/den folgenden Anwendungs-Scope(s) (NICHT Benutzer-Scopes):

   OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring

  Weitere Informationen zum Festlegen der externen App finden Sie unter Automation Ops – Ausführen von Aufgaben.

Wenn die Voraussetzungen erfüllt sind, führen Sie die folgenden Schritte aus, um den Übergang Ihrer Automatisierungsabhängigkeiten zu einer Offline-Umgebung mit Air Gap zu erleichtern:

1. Verwenden Sie den Befehl restore . Sie müssen den Projektordner, den Speicherort für Abhängigkeitsdownloads und sichere Authentifizierungsinformationen angeben, um auf den Bibliotheksfeed Orchestrator zugreifen zu können, wie im folgenden Beispiel gezeigt:

    uipcli package restore "C:\Users\Test_User\OneDrive - UiPath\Documents\UiPath\MathAutomation" --restoreFolder "C:\restoredPackages" --libraryOrchestratorUrl "https://cloud.uipath.com/" --libraryOrchestratorTenant "TENANT_NAME"  -A "ORGANIZATION_NAME" -I "EXTERNAL_APPLICATION_ID" -S "EXTERNAL_APPLICATION_SECRET" --libraryOrchestratorApplicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring"

   Wichtig:

   Beachten Sie, dass keine Pakete heruntergeladen werden, wenn auch nur ein Paket aus dem Mandantenfeed nicht abgerufen werden kann.

2. Verwenden Sie den Befehl deploy . Dieser Befehl lädt die Pakete in den Mandantenbibliotheksfeed hoch.

   Sie müssen den Ordner mit den NuGet-Paketen und den Authentifizierungsdetails für den Orchestrator-Bibliotheksfeed angeben, wie im folgenden Beispiel gezeigt:

    uipcli.exe package deploy "C:\restoredPackages" "https://alpha.uipath.com/" "TENANT_NAME"  -A "ORGANIZATION_NAME" -I "EXTERNAL_APPLICATION_ID" -S "EXTERNAL_APPLICATION_SECRET" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "BusStop" --ignoreLibraryDeployConflict

   Bei der Ausführung des Befehls deploy kann eine Fehlermeldung Aufgabe abgebrochen werden, wie im folgenden Beispiel gezeigt:

    System.Threading.Tasks.TaskCanceledException: A task was canceled.
      at System.Threading.Tasks.Task.GetExceptions(Boolean includeTaskCanceledExceptions)
      at System.Threading.Tasks.Task`1.GetResultCore(Boolean waitCompletionNotification)
      at UiPath.CommandLine.Core.AppRunner.Run(String[] args, Func`2 containerBuilderFactory) in C:\ao-ag-eb2c89c4-we\_work\1\s\UiPath.Extensions.CommandLine.Core\AppRunner.cs:line 23
      at UiPath.CommandLine.Program.Main(String[] args) in C:\ao-ag-eb2c89c4-we\_work\1\s\UiPath.Extensions.CommandLine\Program.cs:line 10
   --- End of stack trace from previous location ---
   
   
   An error was encountered. Please check if everything was configured correctly by visiting https://docs.uipath.com/automation-ops/automation-cloud/latest/user-guide/uipath-command-line-interface

   Wenn dieser Fehler auftritt, wiederholen Sie den Befehl. In der Regel funktioniert der Befehl beim zweiten Versuch.