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 besteht darin, diese Funktionen ohne Plugin einfach in Tools von Drittanbietern wie GitLab, Jenkins und viele andere 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.

Note: UiPath CLI does not support SSO connection.

Voraussetzungen

• Installieren Sie für UiPath.CLI .NET 6.0.7, das mit SDK 6.0.302 oder höher mitgeliefert wird.
• Installieren Sie für UiPath.CLI.Windows .NET 6.0.7 oder höher. Sie müssen auch .NET Desktop Runtime installieren, das auch mit .NET SDK mitgeliefert wird.

Herunterladen der CLI

Sie können eine beliebige Version der UiPath-CLI aus dem offiziellen öffentlichen UiPath-Feed herunterladen. Um die richtige Version für Ihr Projekt zu finden, überprüfen Sie die Kompatibilitätsmatrix unten.

1. Wechseln Sie zum offiziellen öffentlichen UiPath-Feed.
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.Windows
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

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