- Ü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
- Referenz und Support
UiPath-CLI-Benutzerhandbuch
Die Kern -Befehlsoberfläche ist alles, mit dem der Host (@uipath/cli) ausgeliefert wird – keine Toolinstallation erforderlich. Diese Befehle verwalten die Authentifizierung, den Toollebenszyklus, die Fähigkeiten von AI-Coding Agent, die MCP-Bridge und die Shell-Vervollständigung. Jeder Befehl auf dieser Seite ist verfügbar, sobald npm install -g @uipath/cli beendet ist.
Befehle, die mit einer UiPath-Oberfläche kommunizieren (Orchestrator, Lösungen, Agents usw.), finden Sie auf den Referenzseiten der einzelnen Tools – jede wird von einem separaten npm-Paket bereitgestellt, das der Host bei Bedarf lädt.
Die sieben Befehle
| Befehl | Zweck | Anmeldung erforderlich |
|---|---|---|
uip login | Authentifizierung über interaktive OAuth2 oder externe App; wechseln Sie zu Mandanten. Schreibt eine Sitzung in .uipath/.auth. | – |
uip logout | Entfernen Sie die Anmeldeinformationsdatei. | – |
uip login status | Zeigen Sie die aktuelle Organisation, den Mandanten, das Ablaufdatum und die Anmeldeinformationsdatei an, die die CLI liest. | Optional (meldet Not logged in andernfalls) |
uip tools | Auflisten, Suchen, Installieren, Aktualisieren, Deinstallieren der installierbaren Tools (Orchestrator, Lösung, Agent, Flow, …). | – |
uip skills | Installieren Sie UiPath-Fähigkeiten in KI-Codierungsagents (Claude Code, Cursor, GitHub Copilot, Gemini CLI, Codex, OpenCode). | – |
uip mcp | Stellen Sie die CLI als Modellkontextprotokollserver über Studio bereit. | Pro run_command (erbt die dateibasierte Sitzung). |
uip completion | Installieren oder drucken Sie die Shell-Registerkartenvervollständigung (bash, zsh,daten, pwsh). | – |
Zusammenfassung
uip login [--interactive] [--tenant <name>] [--organization <name>] [--client-id <id>] [--client-secret <secret>] [--scope <scopes>] [-f <folder>]
uip login status [-f <folder>]
uip login tenant list [-f <folder>]
uip login tenant set <name> [-f <folder>]
uip logout [-f <folder>]
uip tools list / search / install / update / uninstall …
uip skills install / update / uninstall --agent <claude|cursor|copilot|gemini|codex|opencode>
uip mcp serve
uip completion [shell] [--print] [--uninstall]
uip login [--interactive] [--tenant <name>] [--organization <name>] [--client-id <id>] [--client-secret <secret>] [--scope <scopes>] [-f <folder>]
uip login status [-f <folder>]
uip login tenant list [-f <folder>]
uip login tenant set <name> [-f <folder>]
uip logout [-f <folder>]
uip tools list / search / install / update / uninstall …
uip skills install / update / uninstall --agent <claude|cursor|copilot|gemini|codex|opencode>
uip mcp serve
uip completion [shell] [--print] [--uninstall]
Alle Kernbefehle berücksichtigen die vier globalen Optionen (--output, --output-filter, --log-level, --log-file) und folgen dem Standardvertrag für den Exitcode.
Wie sich die Kernoberfläche auf Tools bezieht
Jeder andere uip <tool> … -Aufruf wird über diesen ausgeführt:
- Die Authentifizierung wird einmal mit
uip logineingerichtet und von jedem nachfolgenden Toolaufruf (Orchestrator, Lösung, Agent, …) übernommen. - Toollebenszyklus (
uip tools install) steuert, welche Erweiterungspakete geladen werden, wenn Sie das nächste Mal ein Toolpräfix aufrufen. - Fähigkeiten stehen neben Tools – sie lehren KI-Agents, wie sie
uipverwenden, anstatt neue Befehle hinzuzufügen. - MCP umschließt die gesamte Oberfläche (Kern + installierte Tools) als ein einziges MCP-Tool, das jeder MCP-fähige Client aufrufen kann.
- Die Vervollständigung erkennt Befehle zur Installationszeit, also führen Sie
uip completionnachuip tools installerneut aus, wenn Sie eine Vervollständigung für neu hinzugefügte Befehle möchten.
Ausführlich siehe So ist die UiPath CLI für die Host-vs-Tool-Architektur organisiert .
Authentifizierungsform
Jeder Kernbefehl mit Ausnahme der Authentifizierungsbefehle selbst funktioniert ohne Sitzung – sie kommunizieren nur mit lokalen Dateien (Konfiguration, Manifest, Vervollständigungsskript). Die Authentifizierungsbefehle verwalten die Sitzung selbst:
uip login– drei Flows: interaktiver OAuth2 (Browser), externe App (Client-Anmeldeinformationen) und Umgebungsvariablentoken. Siehe Authentifizierung.uip logout– entfernt die Datei. Der env-var-Flow hat nichts zu löschen.uip login status– meldet die aktive Sitzung.uip login tenant list / set– Wechseln Sie den Mandanten ohne erneute Authentifizierung.
Toolbefehle erben die Sitzung, die sich zum Zeitpunkt des Aufrufs auf der Festplatte befindet; --tenant Überschreibungen pro Aufruf.
Wohin jeder Befehl seine Ausgabe sendet
| Stream | Inhalt |
|---|---|
| standardout | Der strukturierte JSON-Umschlag (Result, Code, Data, …). Eine pro Aufruf. |
| Standardr | Protokolle (gesteuert durch --log-level), Fortschrittsindikatoren und für Menschen lesbaren Fehlertext. Niemals durch Maschine parsbare JSON. |
Die Aufteilung wird überall erzwungen; Sie können sie unabhängig umleiten:
uip tools list > tools.json 2> uip.log
uip tools list > tools.json 2> uip.log
Unter Ausgabeformate finden Sie die vier Formate (json, table, yaml, plain) und JMESPath-Filterung.
Siehe auch
- Konzepte: Wie die UiPath CLI organisiert ist – was „Host“ bedeutet und warum der Kern von Tools aufgeteilt wird.
- Konzepte: Tools (Plugins) – Die Whitelist für die automatische Installation und das Anheften von Versionen.
- Konzepte: Fähigkeiten – wie
uip skills installKI-Agents erweitert. - Konzepte: Sitzungen und Anmeldeinformationen – was
uip loginschreibt und wo. - Authentifizierung – die drei Authentifizierungsflüsse im Detail.
- Globale Optionen, Austrittscodes – Verträge, die für jeden Befehl gemeinsam genutzt werden.