- Überblick
- UiPath-CLI
- Über UiPath-CLI
- Herunterladen der UiPath-CLI
- Kompatibilitätsmatrix
- Ausführen der UiPath-CLI
- Verwalten von NuGet-Feeds
- Vertrauenswürdige benutzerdefinierte Zertifikate
- Test Manager-Support
- Packen von Projekten in ein Paket
- Signieren von Projektpaketen
- Analysieren eines Projekts
- Bereitstellen eines Pakets im Orchestrator
- Ausführen eines Auftrags im Orchestrator
- Testen eines Pakets oder Ausführen eines Testsatzes
- Testen mehrerer Pakete
- Eingabeparameter JSON-Format
- Bereitstellen von Assets im Orchestrator
- Löschen von Assets aus dem Orchestrator
- Ausführen von Aufgaben mithilfe der JSON-Konfiguration
- Wiederherstellen von Automatisierungsabhängigkeiten
- Überblick
- Wiederherstellen und Analysieren von Lösungen
- Eine Lösung wird gepackt
- Signieren von Lösungspaketen
- Hochladen und Löschen von Lösungspaketen
- Herunterladen von Lösungspaketen und Konfigurationen
- Bereitstellen und Aktivieren von Lösungen
- Deinstallieren von Bereitstellungen
- Authentifizierung und Scopes
- Fehlerbehebung bei der UiPath-CLI
- Azure DevOps-Erweiterung
- Jenkins-Plugin
Benutzerhandbuch zu CI/CD-Integrationen
Voraussetzungen
- Erstellen Sie Projekte.
- Führen Sie die CLI-Datei
exe(für Windows Legacy) oderdll(für Windows/Linux/maOS) aus. - Fügen Sie die erforderlichen Anwendungs-Scopes für den Zugriff auf die Orchestrator-API hinzu.
Sie können das Paket auch lokal erstellen, ohne dass Orchestrator-Scopes erforderlich sind.
Führen Sie die folgenden Schritte aus, um ein Projekt in ein Paket zu packen:
- Führen Sie die
package-Aufgabe mituipcli packageaus. Sie können eine Liste der verfügbaren Unteraufgaben sehen. - Geben Sie die erforderlichen Parameter an und führen Sie die
pack-Unteraufgabe aus. In der folgenden Tabelle sind die erforderlichen Parameter beschrieben.
Project validation and Workflow Analyzer both run by default as part of the pack task. To opt out, use the --skipValidate and --skipAnalyze flags.
Legende: (*) – Optional, nur nützlich, wenn Sie Abhängigkeiten von einer Bibliothek im Orchestrator haben.
| Parameter | Beschreibung |
|---|---|
Project(s) Path (pos. 0) (Erforderlich) | Der Pfad zu einer project.json -Datei oder zu einem Ordner, der project.json -Dateien enthält. |
-o, oder --output (erforderlich) | Pfad des Zielordners. |
-v, or --version | Legen Sie die Paketversion fest. |
--autoVersion | Eine Paketversion automatisch generieren. |
--outputType | Die Ausgabe in einem bestimmten Typ erzwingen. |
--splitOutput | Aktiviert die Aufteilung der Ausgabe in Runtime- und Designbibliotheken. |
--repositoryUrl | Die Repository-URL, unter der das Projekt versioniert wird. |
--repositoryCommit | Der Repository-Commit, aus dem das Projekt erstellt wurde. |
--repositoryBranch | Die Repository-Verzweigung, aus der das Projekt erstellt wurde. |
--repositoryType | VCS-System-Repository-Typ. |
--projectUrl | URL der Automation Hub-Idee. |
--releaseNotes | Versionshinweise hinzufügen. |
--author | Der Paketautor. |
--nugetConfigFilePath | Pfad zur NuGet.Config-Datei mit Feeds. Das <clear /> -Tag von der angegebenen Datei wird ignoriert und nur Quellen berücksichtigt. |
--disableBuiltInNugetFeeds | Deaktivieren Sie integrierte NuGet-Feeds. |
--excludeConfiguredSources | Excludes the built-in feeds and the NuGet sources configured at the user and machine level on the host running the CLI. The CLI resolves packages only from the feeds defined in --nugetConfigFilePath. See Managing NuGet feeds. |
-u, --libraryOrchestratorUsername (*) (Erforderlich , wenn Sie die Standardauthentifizierung über einen Benutzernamen und ein Kennwort verwenden) | Der Benutzername, der für die Authentifizierung beim Orchestrator verwendet wird. Sie müssen es mit dem entsprechenden Kennwort koppeln. Dies ist erforderlich, wenn Ihr Paket auf Bibliotheken aus dem Orchestrator-Feed verweist |
-p, --libraryOrchestratorPassword (*) (Erforderlich , wenn Sie die Standardauthentifizierung über einen Benutzernamen und ein Kennwort verwenden) | Das Kennwort, das für die Authentifizierung beim Orchestrator verwendet wird. Sie müssen es mit dem entsprechenden Benutzernamen koppeln. Dies ist erforderlich, wenn Ihr Paket auf Bibliotheken aus dem Orchestrator-Feed verweist |
-t, --libraryOrchestratorAuthToken (*) (Erforderlich , wenn Sie tokenbasierte Authentifizierung verwenden ) | Das OAuth2-Aktualisierungstoken, das für die Authentifizierung bei Orchestrator verwendet wird. Sie müssen es mit dem Kontonamen und der Client-ID koppeln. Dies ist erforderlich, wenn Ihr Paket auf Bibliotheken aus dem Orchestrator-Feed verweist |
-a, --libraryOrchestratorAccountName (*) (Erforderlich , wenn Sie tokenbasierte Authentifizierung verwenden ) | Der Name des Orchestrator CloudRPA-Kontos. Sie müssen es mit dem OAuth2-Aktualisierungstoken und der Client-ID koppeln. Dies ist erforderlich, wenn Ihr Paket auf Bibliotheken aus dem Orchestrator-Feed verweist |
-A, --libraryOrchestratorAccountForApp (*) | Der Name des Orchestrator CloudRPA-Kontos (Organisationsname). Sie müssen ihn mit der Anwendungs-ID,dem Anwendungsgeheimnis und dem Anwendungs-Scope für eine externe Anwendung koppeln. Dies ist erforderlich, wenn Ihr Paket auf Bibliotheken aus dem Orchestrator-Feed verweist. |
-I ,--libraryOrchestratorApplicationId (*) (Erforderlich, wenn Sie die Authentifizierung einer externen Anwendung verwenden ) | Die ID der externen Anwendung. Sie müssen es mit dem Anwendungskonto, dem Anwendungsgeheimnis und dem Anwendungs-Scope koppeln. Dies ist erforderlich, wenn Ihr Paket auf Bibliotheken aus dem Orchestrator-Feed verweist. |
-S, --libraryOrchestratorApplicationSecret (*) (Erforderlich, wenn Sie die Authentifizierung einer externen Anwendung verwenden ) | Das Geheimnis externen Anwendung. Sie müssen es mit dem Anwendungskonto, der Anwendungs-ID und dem Anwendungs-Scope koppeln. Dies ist erforderlich, wenn Ihr Paket auf Bibliotheken aus dem Orchestrator-Feed verweist. |
--libraryOrchestratorApplicationScope (*) (Erforderlich , wenn Sie die Authentifizierung einer externen Anwendung verwenden ) | Die Liste der Anwendungs-Scopes, getrennt durch einzelne Leerzeichen. Sie müssen es mit dem Anwendungskonto, der Anwendungs-ID und dem Anwendungsgeheimnis für eine externe Anwendungen koppeln. Dies ist erforderlich, wenn Ihr Paket auf Bibliotheken aus dem Orchestrator-Feed verweist. |
--libraryOrchestratorFolder (*) | Der Name des Ziel-Orchestrator-Ordners. Um Unterordner einzugeben, geben Sie sowohl den Namen des übergeordneten Ordners als auch den Namen des Unterordners ein. Zum Beispiel AccountingTeam\TeamJohn. |
--libraryOrchestratorUrl (*) | Die URL der Orchestrator-Instanz. |
--libraryOrchestratorTenant (*) | Der Mandant der Orchestrator-Instanz. |
--libraryIdentityUrl | The URL of your identity server. Required when the library Orchestrator runs on UiPath Automation Suite or standalone Orchestrator (on-premises MSI). Not needed for Automation Cloud — the CLI resolves the identity server from the cloud URL. |
--traceLevel | Zeigt die Ablaufverfolgung der Ereignisse an. |
-l, or --language | Die Sprache, die in der Orchestrator-Benutzeroberfläche verwendet wird. |
--activitiesRootCategory | The root category prefix applied to every activity exposed by the published library. Has effect only when packing a library project; ignored for process, tests and objects projects. When omitted, defaults to the library project name. |
--skipAnalyze | Skip running Workflow Analyzer during the pack step. Use only when you run package analyze as a separate pipeline stage; release pipelines should leave analyzer enabled. |
--skipValidate | Skip the project validation step during the pack step. Use only when the project has already been validated earlier in the pipeline. |
--ca-cert | Eine oder mehrere vertrauenswürdige Stammzertifikatdateien von Zertifizierungsstellen (PEM, DER oder PKCS#7), die beim Validieren der Orchestrator- und Identity Server-TLS-Zertifikate verwendet werden. Wiederholen Sie das Flag oder trennen Sie mehrere Pfade durch Komma. Weitere Informationen finden Sie unter Vertrauenswürdigen benutzerdefinierten Zertifikaten . |
--pinnedpubkey | Heften Sie den öffentlichen Schlüssel des Serverblattzertifikats an. Format: sha256//<base64>. Wird zusätzlich zur Standardzertifikatvalidierung aktiviert. Weitere Informationen finden Sie unter Vertrauenswürdigen benutzerdefinierten Zertifikaten . |
Für Orchestrator-Instanzen, die von einer privaten Zertifizierungsstelle signiert wurden (z. B. UiPath Automation Suite), akzeptiert dieser Befehl auch --ca-cert und --pinnedpubkey Parameter. Szenarien und Beispiele finden Sie unter Vertrauenswürdigen benutzerdefinierten Zertifikaten .
Wenn Sie die Authentifizierung einer externen Anwendung verwenden, ohne den Parameter --applicationScope anzugeben, wendet die CLI automatisch diese standardmäßigen Orchestrator-Scopes an:
OR.Assets OR.BackgroundTasks OR.Execution OR.Folders OR.Robots.Read OR.Machines.Read OR.Jobs OR.TestSets OR.TestSetExecutions OR.Monitoring OR.Settings.Read
Nutzung
uipcli package pack <project_path> -o <destination_folder> [-v <version>] [--autoVersion] [--outputType <Process|Library|Tests|Objects>] [--libraryOrchestratorUrl <orchestrator_url> --libraryOrchestratorTenant <orchestrator_tenant>] [--u <orchestrator_user> --p <orchestrator_pass>] [--t <auth_token> --a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --libraryOrchestratorApplicationScope <application_scope>] [--libraryIdentityUrl <identity_url>] [--libraryOrchestratorFolder <folder_name>] [-l <language>] [--splitOutput] [--skipAnalyze] [--skipValidate] [--activitiesRootCategory <root_category>] [--repositoryUrl <repository_url>] [--repositoryCommit <repository_commit>] [--repositoryBranch <repository_branch>] [--repositoryType <repository_type>] [--projectUrl <automation_hub_idea_url>] [--releaseNotes <release_notes>] [--disableBuiltInNugetFeeds] [--excludeConfiguredSources] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>]
uipcli package pack <project_path> -o <destination_folder> [-v <version>] [--autoVersion] [--outputType <Process|Library|Tests|Objects>] [--libraryOrchestratorUrl <orchestrator_url> --libraryOrchestratorTenant <orchestrator_tenant>] [--u <orchestrator_user> --p <orchestrator_pass>] [--t <auth_token> --a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --libraryOrchestratorApplicationScope <application_scope>] [--libraryIdentityUrl <identity_url>] [--libraryOrchestratorFolder <folder_name>] [-l <language>] [--splitOutput] [--skipAnalyze] [--skipValidate] [--activitiesRootCategory <root_category>] [--repositoryUrl <repository_url>] [--repositoryCommit <repository_commit>] [--repositoryBranch <repository_branch>] [--repositoryType <repository_type>] [--projectUrl <automation_hub_idea_url>] [--releaseNotes <release_notes>] [--disableBuiltInNugetFeeds] [--excludeConfiguredSources] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>]
Beispiele
uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output"uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --libraryOrchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --libraryOrchestratorTenant "TenantName" -u "orchestratorUsername" -p "********" --orchestratorFolder "FolderName" --author ExampleAuthoruipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --libraryOrchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S '********' --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" --libraryOrchestratorFolder "FolderName" --libraryIdentityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity"uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --libraryOrchestratorUrl "https://automation-suite.base.url.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S '********' --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" --libraryOrchestratorFolder "FolderName"uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --libraryOrchestratorUrl "https://cloud.uipath.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S '********' --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" --libraryOrchestratorFolder "FolderName"
Library pack with a custom activities root category
uipcli package pack "C:\userprofile\MyLibrary\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --outputType Library --activitiesRootCategory "MyCompany.Finance.Invoicing"
Pack with analyzer and validation skipped (faster local builds, CI separate-analyze stages)
uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --skipAnalyze --skipValidate
Hermetic pack — ignore user/machine NuGet sources on the build agent
uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --nugetConfigFilePath "C:\ci\nuget.config" --excludeConfiguredSources