- Überblick
- Erste Schritte
- Installieren der UiPath CLI
- Erste Befehle (Schnellstart)
- Ihre erste Pipeline
- 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
- Referenz und Support
UiPath-CLI-Benutzerhandbuch
Dieser Schnellstart durchläuft fünf Befehle, die Sie von einer Neuinstallation zu einem Auftrag führen, der im Orchestrator ausgeführt wird. Warten Sie fünf Minuten.
Bevor Sie beginnen
- Installieren Sie die UiPath CLI. Siehe Installieren der UiPath CLI.
- Sie müssen über ein UiPath Automation Cloud- oder Automation Suite-Konto mit Zugriff auf mindestens einen Mandanten verfügen.
- Beachten Sie den Namen (oder Pfad) eines Ordners im Orchestrator, der mindestens einen Prozess enthält. Der Standardordner
Sharedfunktioniert für die meisten Versuche.
Öffnen Sie ein Terminal. Alle folgenden Befehle werden dort eingegeben.
Schritt 1. Anmelden
Starten Sie die interaktive Anmeldung:
uip login
uip login
uip öffnet Ihren Standardbrowser, fordert Sie auf, sich bei UiPath anzumelden, und nach der Authentifizierung werden Sie aufgefordert, einen Mandanten auszuwählen. Wenn die Browser-Registerkarte Erfolg meldet, kehren Sie zum Terminal zurück – die Sitzung ist aktiv. Die Sitzung wird in ~/.uipath/ beibehalten (oder in einem projektlokalen .uipath/ -Ordner, wenn einer im aktuellen Ordner oder in einem Vorgänger vorhanden ist).
Wenn Sie den Mandanten bereits kennen und die Auswahl überspringen möchten, führen Sie uip login --tenant DefaultTenant aus. Wenn Sie sich in einer CI-Umgebung befinden, finden Sie weitere Informationen unter Authentifizierung für die nicht interaktiven Flows.
Schritt 2. Bestätigen Sie die Sitzung
uip login status --output table
uip login status --output table
Erwartete Ausgabe:
Status Organization Tenant Expiration Date
Logged in my-org DefaultTenant 2026-04-24T18:42:00Z
Status Organization Tenant Expiration Date
Logged in my-org DefaultTenant 2026-04-24T18:42:00Z
Jeder uip -Befehl gibt standardmäßig JSON aus. Übergeben Sie --output table für die lesbare Ansicht. Siehe Globale Optionen für die vier Ausgabeformate (table, json, yaml, plain) und das JMESPath-Flag --output-filter .
Wenn der Befehl Not logged in meldet, führen Sie uip login erneut aus.
Schritt 3. Ordner auflisten
Ihre erste echte Abfrage trifft den Orchestrator:
uip or folders list
uip or folders list
Dadurch werden die ersten 50 Ordner im Mandanten zurückgegeben. Die Ausgabe enthält Key (GUID), Name, Path und Type jedes Ordners.
Um zu filtern oder tiefer zu suchen, übergeben Sie --all , um Filter freizuschalten:
uip or folders list --all --name Shared
uip or folders list --all --top-level
uip or folders list --all --name Shared
uip or folders list --all --top-level
--all ist erforderlich, damit die Filter-Flags (--name, --path, --type, --top-level, --order-by) Auswirkungen haben. Dies ist ein bewusstes Sicherheitsnetz – ein Tippfehler in einem Filter für einen großen Mandanten würde andernfalls im Hintergrund die ungefilterte erste Seite zurückgeben.
Schritt 4: Suchen Sie einen auszuführenden Prozess
Wählen Sie einen Ordner aus Schritt 3 – Shared wird hier als Beispiel verwendet – und listen Sie seine Prozesse auf:
uip or processes list --folder-path Shared
uip or processes list --folder-path Shared
Die Ausgabe zeigt Key (GUID), Name, Version und Type jedes Prozesses. Kopieren Sie das Key eines Prozesses, den Sie ausführen möchten. Ersetzen Sie <process-key> im nächsten Schritt durch diese GUID.
Schritt 5. Einen Auftrag starten
uip or jobs start <process-key>
uip or jobs start <process-key>
uip wird sofort zurückgegeben, nachdem der Orchestrator die Anforderung akzeptiert hat. Die Antwort zeigt den Key, State des neuen Auftrags (normalerweise zuerst Pending ) und den aufgelösten ProcessName an.
Um zu blockieren, bis der Auftrag abgeschlossen ist und seine Ausgabe angezeigt wird, fügen Sie --wait-for-completion hinzu:
uip or jobs start <process-key> --wait-for-completion --timeout 600
uip or jobs start <process-key> --wait-for-completion --timeout 600
Mit --wait-for-completion fragt der Befehl alle fünf Sekunden ab (standardmäßig) und wird beendet, wenn der Auftrag einen Endstatus erreicht (Successful, Faulted, Stopped). Der Exitcode ist auf Faulted nicht Null. --timeout ist in Sekunden und wird standardmäßig auf 300 festgelegt.
Übergeben Sie Eingabeargumente mit --input-arguments (JSON-Zeichenfolge) oder --input-file (Pfad zu einer JSON-Datei):
uip or jobs start <process-key> \
--input-arguments '{"invoiceNumber":"INV-001","customer":"Contoso"}'
uip or jobs start <process-key> \
--input-arguments '{"invoiceNumber":"INV-001","customer":"Contoso"}'
Was Sie gerade getan haben
In fünf Befehlen haben Sie sich authentifiziert, zwei Orchestrator-Ressourcen abgefragt und einen Auftrag gestartet. Jeder uip -Befehl folgt derselben Form – uip <tool> <resource> <verb> für Tools mit mehreren Ressourcen oder uip <tool> <verb> für Single-Workflow-Tools – und jeder unterstützt dieselben globalen Flags für Ausgabeformat, Filterung und Protokollierung. Siehe Globale Optionen.
Nächste Schritte
- Ihre erste Pipeline – packen Sie eine Lösung lokal, veröffentlichen Sie sie für Ihren Mandanten und stellen Sie sie im Orchestrator bereit.
- Authentifizierung – interaktive Anmeldung im Detail, Anmeldeinformationen des externen App-Clients für CI und der Umgebungsvariablenflow für Container.
- Ausgabeformate – wechseln Sie zwischen
table,json,yamlundplainund verwenden Sie die JMESPath-Filterung mit--output-filter. - Orchestrator-Befehlsreferenz – jeder Befehl, jedes Flag.
- Verwenden von UiPath CLI mit Codierungs-Agents – Lassen Sie Claude Code, Cursor, GitHub Copilot und andere Agents UiPath-Automatisierungen mit
uiperstellen.