- Überblick
- Erste Schritte
- Konzepte
- Verwenden der UiPath CLI
- UiPath für Codierungs-Agents
- Anleitungen
- CI/CD-Rezepte
- Befehlsreferenz
- Überblick
- Exitcodes
- Globale Optionen
- UIP-codierter Agent
- UIP-Dokumentation
- Add-Test-Data-Entität
- Add-Test-Data-Queue
- Add-Test-Data-Variation
- Analysieren
- Erstellen
- Ein Projekt erstellen
- Diff
- Suchaktivitäten
- Get-Analyse-Regeln
- get-standard-aktivität-xaml
- Fehler abrufen
- Manuelle-Testfälle erhalten
- Manuelle-Testschritte erhalten
- Get-Versionen
- Beispiel für einen Workflow abrufen
- Anwendung anzeigen
- Anzeigeelement
- Inspektionspaket
- install-data-fabric-entities
- Pakete installieren oder aktualisieren
- list-data-fabric-entities
- Beispiele für Listenworkflows
- Packen
- restore
- Ausführungsdatei installieren
- Suchvorlagen
- Studio starten
- Ausführung anhalten
- UIA
- UIP-Ablaufverfolgungen
- Migration
- Überblick
- Migrieren von der Legacy-.NET-CLI
- Befehlszuordnung (Legacy zu uip)
- Umbenennungen kennzeichnen
- Durchschlagende Änderungen
- Referenz und Support
UiPath-CLI-Benutzerhandbuch
UiPath CLI 1.x (uip, verteilt auf npm als @uipath/cli) ersetzt die Legacy-.NET-CLI (uipcli.exe, verteilt als UiPath.CLI über die Kalenderversionen 2023.10, 2024.10 und 2025.10) . Auf dieser Seite wird erläutert, wer migrieren sollte, was sich auf Toolebene ändert und wie Sie sich auf den vier folgenden Detailseiten zurechtfinden.
Wenn Sie nur die Flag-für-Flag-Antwort auf „Was tippe ich anstelle von uipcli <verb>?“ möchten, springen Sie zu Befehlszuordnung und Flag-Umbenennungen.
Für wen dieses Handbuch ist
Sie sollten migrieren, wenn einer der folgenden Fälle zutrifft:
- Ihre Pipeline ruft
uipcli.exeauf – direkt, überUiPathCLIAzure DevOps-Aufgabe oder über einen Jenkins/GitHub Actions Shell-Schritt. - Sie heften die Legacy-CLI an eine Kalenderversion (
2023.10,2024.10,2025.10) an und haben die jährliche Kadenz nachverfolgt. - Sie verwenden die Benutzer-/Kennwort-Authentifizierung (
-u/-p) oder die Aktualisierungstoken-Authentifizierung (-t/-a) für den Orchestrator. - Sie erstellen ein
.nupkgmituipcli package pack, stellen mituipcli package deploybereit oder führen Orchestrator-Tests mituipcli test runaus.
Sie können vorerst die Legacy-CLI beibehalten, wenn Sie eine reine Windows-Funktion benötigen, die noch nicht auf das plattformübergreifende uip rpa -Tool portiert wurde (Studio Debugger-Integration, validate, find-package, find-activities, type-definition). Ein gleichgeordnetes uip rpa-legacy -Tool umschließt die 2025.10-Binärdatei unter Windows; siehe uip rpa – Legacy-Wrapper für nur Windows. Alles andere – Pakete unter Linux/macOS, Orchestrator-Vorgänge, Lösungen, Test Manager, Agents, Flows, Maestro – ist heute in uip .
Was sich auf einen Blick ändert
| Dimension | Legacy uipcli (bis 2025.10) | uip 1.x |
|---|---|---|
| Binärname | uipcli.exe / uipcli.dll | uip |
| Verteilung | MSI, NuGet (UiPath.CLI, UiPath.CLI.Windows) | npm (@uipath/cli) |
| Laufzeit | .NET 6/.NET Framework | Node.js 18+ |
| Plattform | Windows (primär), Linux über plattformübergreifendes NuGet | Windows, macOS, Linux, ARM64 |
| Versionierung | Kalender (2023.10, 2024.10, 2025.10) | Semantisch (1.0.0, 1.1.0, 2.0.0) |
| Installieren Sie das Modell | Mon soliisch | Host + Tool-Plugins pro Oberfläche (siehe Tools) |
| Standardausgabe | Textprotokolle in Standardausgabe + Exitcode | JSON-Umschlag auf standardout, Protokolle auf standard |
| Primäre Authentifizierungsflows | Benutzer/Übergeben, Aktualisierungstoken, externe App | externe App (CI), interaktiver OAuth (dev), env-token (Container) |
| Konfiguration | Nur CLI-Flags | Flags + Umgebungsvariablen (siehe Konfiguration) |
Die Zusammenfassung für die Neufassung finden Sie unter Neuigkeiten .
Welche CLI-Version verwende ich?
Führen Sie uipcli --version (oder dotnet uipcli.dll --version) aus. Die Ausgabe sieht wie folgt aus: 23.10.8817.35919, 24.10.9248.xxxxx oder 25.10.xxxx.xxxxx. Die folgenden Migrationspfade decken alle drei ab.
| Sie werden ausgeführt | Wohin soll |
|---|---|
uipcli 23.10.* | Lesen Sie diese ganze Seite, dann Befehlszuordnung + Flag-Umbenennungen. Die von Ihnen verwendeten Verben deploy und asset deploy werden alle zugeordnet. |
uipcli 24.10.* | Wie 23.10 – die Befehlsoberfläche wurde unverändert. Wenn Sie das in 24.10 hinzugefügte Verb solution übernommen haben, wird jeder Unterbefehl zugeordnet. |
uipcli 25.10.* | Dasselbe wie oben. test parallel und das Bereitstellungsformular für den Mehrfacheinstiegspunkt --processNames <csv> haben spezifische Migrationshinweise in der Befehlszuordnung. |
Mit uipcli run <args.json> | Siehe Befehlszuordnung – Ausführen – die neue CLI hat kein direktes Äquivalent; Das empfohlene Muster ist ein Shell-Skript mit einem uip -Aufruf pro Schritt. |
Entscheidungstabelle – Wählen Sie Ihren Ausgangspunkt aus
Ihr Anwendungsfall ist aktiviert uipcli | Migrationsziel | Detailseite |
|---|---|---|
| Ein Studio-Projekt packen → in Orchestrator hochladen → Prozess erstellen | uip rpa pack → uip or packages upload → uip or processes create | Befehlszuordnung – Paket |
Packen und Bereitstellen einer Lösung (.uipx) | uip solution pack → uip solution publish → uip solution deploy run | Befehlszuordnung – Lösung, erste Pipeline |
| Starten Sie einen Orchestrator-Auftrag | uip or jobs start <process-key> [--wait-for-completion] | Befehlszuordnung – Auftrag |
| Führen Sie einen Test Manager-Testsatz aus | uip tm testsets run → uip tm wait → uip tm report get | Befehlszuordnung – Test |
| Stellen Sie CSV-deklarierte Assets bereit | uip resource assets create in einer Schleife ( heute keine einmaligen CSV-Bereitstellung) | Befehlszuordnung – Asset |
| Führen Sie die Workflow-Analyse aus | uip rpa analyze <project> --governance-file-path <policy> | Befehlszuordnung – Analysieren |
| Authentifizieren einer CI-Pipeline | uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant <name> | Flag-Umbenennungen – Authentifizierung |
| Portieren Sie eine Azure DevOps/Jenkins-Pipeline | Ersetzen Sie UiPathCLI Aufgabenblöcke durch uip Shell-Schritte | Pipelinebeispiele |
Häufigste grundlegende Änderungen
Diese drei erscheinen in fast jeder Migration. Die vollständige Liste finden Sie unter Durchschlagende Änderungen .
- Die Standardauthentifizierung (
-u/-p) und die Aktualisierungstoken-Authentifizierung (-t/-a) sind nicht verfügbar. Nur Client-Anmeldeinformationen für externe Anwendungen, interaktives OAuth2 und Zugriffstoken mit Umgebungsvariablen werden unterstützt. Siehe Authentifizierung. UIPATH_CLIENT_ID/UIPATH_CLIENT_SECRETwerden nicht mehr implizit gelesen. Übergeben Sie sie als--client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET(das Präfixenv.liest die Variable, ohne sie in der Befehlszeile verfügbar zu machen).- Stdout ist standardmäßig JSON. Legacy-Shell-Skripte, die
uipcli-Textausgabe geparst haben, müssenjq(oder--output plain+--output-filter) verwenden oder für menschliches Lesen zu--output tablewechseln.
Bevor Sie beginnen
Führen Sie diese vier Schritte aus, bevor Sie mit dem Portieren einer Pipeline beginnen.
1. Sichern Sie Ihre aktuellen Pipelinedateien
Commit eine bekannte Kopie von jedem azure-pipelines.yml, Jenkinsfile, .github/workflows/*.yml oder .gitlab-ci.yml in einer Verzweigung (oder einem Tag). Der Port ist als Unterschied einfacher zu überprüfen.
2. Heften Sie @uipath/cli an eine bestimmte Version an
Installieren Sie während der Migration immer mit einer expliziten Version, damit sich das Pipelineverhalten nicht unerwartet ändert:
npm install -g @uipath/cli@1.0.0
npm install -g @uipath/cli@1.0.0
Tools werden implizit an die Zeile MAJOR.MINOR der CLI angeheftet (siehe Versionierung), sodass eine angeheftete CLI auch jedes Tool an einen bekannten Nebenbereich anheftet. Für eine strenge Reproduzierbarkeit auf Patch-Ebene können Sie auch Tools anheften – siehe Abschnitt „Anheften von Versionen in CI“ von Skriptingmuster.
3. Lesezeichen für die Legacy-.NET-CLI-Dokumentation
Verhalten der Referenz-Flags während des Ports. Die Referenz für 2025.10 befindet sich unter docs.uipath.com – UiPath Befehlszeilenschnittstelle (2025.10). Lassen Sie es in einer Registerkarte geöffnet.
4. Erstellen Sie eine externe Anwendung in UiPath
Die Legacy-CLI akzeptierte mehrere Authentifizierungsmodi; Die neue CLI reduziert die CI-Authentifizierung auf Client-Anmeldeinformationen für externe Anwendungen. Erstellen Sie die App jetzt, damit der Port auf etwas verweisen kann. Siehe Authentifizierung – Flow 2.
Gewähren Sie der externen App die gleichen Scopes, die Ihre Legacy-CLI verwendet hat – OR.Folders, OR.Jobs, OR.Execution, OR.Assets, OR.Users.Read, OR.Machines.Read, OR.TestSets, OR.TestSetExecutions deckt den allgemeinen CI-Fall ab. Sehen Sie sich den Wert --applicationScope aus Ihren vorhandenen uipcli -Aufrufen für die genaue Liste an, die Sie benötigen.
Die vier Detailseiten
Jede Seite unten ist so fokussiert, dass sie in einer Sitzung überprüft werden kann. Durchlaufen Sie sie in der richtigen Reihenfolge, wenn Sie eine vollständige Pipeline portieren; Springen Sie direkt zu der Sie benötigen, wenn Sie nur eine bestimmte Antwort möchten.
Befehlszuordnung
Jedes Legacy-Verb – package pack, package analyze, package deploy, package restore, job run, test run, test parallel, asset deploy, asset delete, solution pack, solution deploy, run – mit dem Äquivalent uip , einer 1:1-/mehrstufigen/entfernten Klassifizierung und einem Vorher-/Nachher-Snippet für jede nicht-triviale Zeile.
Umbenennungen kennzeichnen
Zuordnung auf Flag-Ebene mit dem Authentifizierungsblock oben. Legacy -u/-p/-t/-a/-A/-I/-S/-o/--applicationScope/--identityUrl/--outputType/--traceLevel zugeordnet ihre uip -Gegenstück (oder als entfernt angezeigt, mit dem Ersatz). Lesen Sie dies zusammen mit der Befehlszuordnung – die Befehlszuordnung zeigt das Verb, Flag-Umbenennungen zeigen das Flag an.
Durchschlagende Änderungen
Prose-Abdeckung der Änderungen, die Pipelines ohne Warnung unterbrechen. Entfernungen des Authentifizierungsmodus, Entfernung des automatischen Lesevorgangs env-var, Korrektur des Exit-Code-Vertrags, JSON-stdout-Standard, NuGet-Ordner mit Kalenderversion weg,.NET-Laufzeit eingestellt. Ein Absatz pro Änderung mit einer „Was ist zu tun“-Behebung.
Pipelines
Vorher/Nachher-Snippets für Azure DevOps und Jenkins (erforderlich), mit kürzeren GitHub Actions und GitLab CI-Snippets. Querverlinkung zu den vollständigen CI/CD-Rezipien für vollständige Pipelines.
Siehe auch
- Neuigkeiten – Überschriftszusammenfassung der Neufassung.
- Ihre erste Pipeline – praktische Anleitung von
pack → publish → deploy runmit der neuen CLI. - Authentifizierung – die drei unterstützten Authentifizierungsflows in 1.x.
- Austrittscodes – der verfeinerte Fünf-Stufen-Vertrag.
- Tools (Plugins) – warum die Befehlsoberfläche auf npm-Pakete aufgeteilt ist und was bei der ersten Verwendung automatisch installiert wird.
- Für wen dieses Handbuch ist
- Was sich auf einen Blick ändert
- Welche CLI-Version verwende ich?
- Entscheidungstabelle – Wählen Sie Ihren Ausgangspunkt aus
- Häufigste grundlegende Änderungen
- Bevor Sie beginnen
- 1. Sichern Sie Ihre aktuellen Pipelinedateien
- 2. Heften Sie @uipath/cli an eine bestimmte Version an
- 3. Lesezeichen für die Legacy-.NET-CLI-Dokumentation
- 4. Erstellen Sie eine externe Anwendung in UiPath
- Die vier Detailseiten
- Befehlszuordnung
- Umbenennungen kennzeichnen
- Durchschlagende Änderungen
- Pipelines
- Siehe auch