- Überblick
- Über UiPath-CLI
- Neuigkeiten
- Versionierung und Stabilität
- 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 UiPath CLI befindet sich derzeit in öffentlicher Vorschau. Alle Releases vor Version 1.0.0 sind Vorschau-Releases und können grundlegende Änderungen zwischen Versionen enthalten. Version 1.0.0 wird die erste stabile Version sein.
Die UiPath-Befehlszeilenschnittstelle (UiPath CLI, aufgerufen als uip) ist das plattformübergreifende Befehlszeilentool für die UiPath Plattform. Damit können Entwickler, RPA-Ingenieure und DevOps-Teams UiPath-Automatisierungen – Orchestrator-Aufträge und -Ressourcen, Lösungen, Agents, Flows, Maestro-Prozesse, Test Manager-Assets und mehr – über ein Terminal oder ein CI/CD erstellen, verwalten , betreiben und bereitstellen Pipeline.
UiPath CLI wird auf npm verteilt und folgt der semantischen Versionierung (MAJOR.MINOR.PATCH). Dies ersetzt das bis zu 2025.10 verwendete kalenderbasierte Schema und die Legacy-.NET-CLI (uipcli.exe).
Dies ist die Dokumentation für die UiPath CLI (der TypeScript-basierte uip -Befehl). Informationen zur Legacy-.NET-CLI (uipcli.exe / dotnet uipcli.dll) finden Sie in den Dokumenten zu CI/CD-Integrationen 2025.10. Ein Migrationsleitfaden ist verfügbar.
Informationen zur Azure DevOps-Erweiterung, zum Jenkins-Plugin und zu anderen Pipelineintegrationen finden Sie unter CI/CD-Integrationen.
Mehr als ein CI/CD-Tool
Frühere UiPath-Befehlszeilentools konzentrierten sich auf CI/CD-Aufgaben – Packen, Analysieren, Bereitstellen, Ausführen von Tests. UiPath CLI 1.x behält all das bei und fügt die vollständige Plattformoberfläche hinzu. Sie können uip verwenden, um:
- Erstellen – Gerüst für Projekte (
uip solution new,uip agent init,uip flow init,uip maestro init), Packen (uip rpa pack,uip solution pack,uip agent pack) und Analysieren (uip rpa analyzemit Governance-Richtlinien). - Verwalten – Arbeiten mit Orchestrator-Ordnern, Benutzern, Rollen und Lizenzen; Assets, Warteschlangen, Speicher-Buckets, Bibliotheken, Trigger und Webhooks erstellen und aktualisieren; Verwalten von Test Manager-Projekten, Testsätzen und Ergebnissen; Verwalten Sie Integration Service-Connectors und Verbindungen.
- Betrieb – Starten, Anhalten und Überprüfen von Orchestrator-Aufträgen Überwachen Sie Flow- und Maestro-Instanzen und -Vorfälle; Agents ausführen und anhand von Datasets auswerten; Führen Sie Testsätze aus und lesen Sie die Ergebnisse.
- Bereitstellung – Pakete hochladen, Prozesse erstellen und aktualisieren, Lösungen und Agents veröffentlichen, Lösungsbereitstellungen aktivieren oder deinstallieren.
Es ist dasselbe Tool, egal ob Sie ein Entwickler sind, der die Plattform von einem Laptop aus erkunden, oder eine Pipeline, die Unattended-Bereitstellungen durchführt. Die Verben, Flags, Ausgabeformate und Exitcodes sind in beiden Kontexten gleich.
Konzipiert für Menschen und Codierungs-Agents
Die UiPath CLI ist so konzipiert, dass sie von zwei Zielgruppen gleich gut genutzt wird:
- Menschen – eine Terminal-First-Erfahrung mit interaktiver
uip login, Shell-Registerkarte (uip completion), einer farbigen--output table-Ansicht und eingebetteter Hilfe in jedem Befehl (uip <cmd> --help). - Codierungsagenten – Das
uip skills-System installiert UiPath-Fähigkeiten in Codierungsagenten, sodass sie wissen, wie UiPath-Automatisierungen mituiperstellt, bereitgestellt und betrieben werden – nicht nur , welche Befehle vorhanden sind. Unterstützte Agents: Claude Code, Cursor, GitHub Copilot, Gemini CLI, Codex und OpenCode.
uip skills install ruft den vollständigen UiPath-Fähigkeitenkatalog von GitHub ab und installiert ihn in einem oder mehreren Codierungsagenten. Sie wählen die Ziel- Agents (nicht einzelne Fähigkeiten – der Agent entscheidet selbst, welche Fähigkeit für eine bestimmte Aufgabe gilt) entweder durch Übergeben von --agent <name> oder interaktiv über einen Kontrollkästchen-Prompt aus, wenn das Flag weggelassen wird. Standardmäßig ist die Installation global; --local , um dem aktuellen Projekt Scope-Fähigkeiten hinzuzufügen (wo der Agent dies unterstützt – z. B. Claude Code ist nur global).
uip skills install # prompts you to pick one or more agents
uip skills install --agent claude # non-interactive, skills installed globally for Claude Code
uip skills install --agent cursor --local # non-interactive, skills installed into the current project for Cursor
uip skills update --agent claude # re-fetch and reinstall to pick up new skills
uip skills uninstall --agent claude # remove skills for Claude Code
uip skills install # prompts you to pick one or more agents
uip skills install --agent claude # non-interactive, skills installed globally for Claude Code
uip skills install --agent cursor --local # non-interactive, skills installed into the current project for Cursor
uip skills update --agent claude # re-fetch and reinstall to pick up new skills
uip skills uninstall --agent claude # remove skills for Claude Code
Die gleichen Befehle funktionieren in beiden Richtungen. Ein uip -Aufruf, den ein Entwickler manuell eingibt, ist genau der gleiche Aufruf, den ein Agent ausführt – was bedeutet, dass Ihr Team interaktiv eine Automatisierung erstellen, die genaue Sequenz in ein Skript leiten und sie an einen KI-Agent zur weiteren Iteration übergeben kann.
Die Ausgabe ist standardmäßig JSON – dieselbe auf einem Entwickler-Laptop und in einer Pipeline, sodass Skripte nicht verzweigt werden müssen, ob sie interaktiv ausgeführt werden. Fügen Sie --output table für die lesbare Ansicht, --output yaml für YAML oder --output plain für key=value Zeilen hinzu. Die JMESPath-Filterung ist über --output-filter "Data[*].Name" verfügbar.
So ist die UiPath CLI organisiert
uip ist ein kleiner Host mit einem Plugin-System. Der Host kümmert sich um die Authentifizierung, Sitzungsverwaltung, Konfiguration und den Tool-Lebenszyklus. Alles andere – Orchestrator, Lösung, Agent, Flow, Maestro, RPA, Test Manager usw. – wird als installierbares Tool auf npm ausgeliefert.
uip <tool> <resource-or-command> [subcommand] [options]
uip <tool> <resource-or-command> [subcommand] [options]
Beispiele:
uip login # core command
uip or jobs list # orchestrator jobs (manage + operate)
uip solution pack ./MySolution ./dist # solution packing (build)
uip rpa analyze ./MyProject # workflow analyzer (build)
uip agent deploy my-agent # agent deploy (deploy)
uip login # core command
uip or jobs list # orchestrator jobs (manage + operate)
uip solution pack ./MySolution ./dist # solution packing (build)
uip rpa analyze ./MyProject # workflow analyzer (build)
uip agent deploy my-agent # agent deploy (deploy)
Ein neuer npm install -g @uipath/cli enthält nur die Host- und Kernbefehle – es sind keine Tools vorinstalliert. Wenn Sie zum ersten Mal einen Befehl aufrufen, dessen Präfix mit einem Tool auf der weißen Liste übereinstimmt, installiert der Host dieses Tool automatisch über npm. Sie können Tools auch explizit mit uip tools install <name> installieren – nützlich für die Offline-Vorbereitung und CI-Ausführungen. Weitere Informationen finden Sie unter Tools (Plugins) .
Integrierte Tools
Alle folgenden Tools befinden sich auf der Zulassungsliste für die automatische Installation – die Eingabe des Präfixes reicht aus. Die angezeigten Präfixe sind die kanonischen Namen, wie sie im Host definiert sind:
| Tool | Prefix | Zweck |
|---|---|---|
| Orchestrator | or | Aufträge, Ordner, Prozesse, Pakete, Maschinen, Benutzer, Rollen, Lizenzen, Feeds |
| Lösung | solution | Gerüst, Packen, Veröffentlichen, Hochladen, Bereitstellen von UiPath-Lösungen |
| Ressource | resource | Assets, Warteschlangen, Speicher-Buckets, Bibliotheken, Trigger, Webhooks |
| RPA | rpa | Packen von Studio-Projekten, Workflow-Analyse, Wiederherstellen von Abhängigkeiten |
| Mitarbeiter | agent | Erstellung, Verpackung, Bereitstellung, Ausführung von Low-Code-Agents |
| Codierter Agent | codedagent | Python-basierte codierte Agents |
| Codierte App | codedapp | Codierte Webanwendungsprojekte |
| Maestro | maestro | Erstellen, Verpackung und Runtime-Vorgänge von Maestro-Projekten |
| Test Manager | tm | Testfälle, Testsätze, Ausführungen, Ergebnisse, Berichte |
| Integration Service | is | Connectors und Verbindungen |
| Vertikale Lösungen | vss | Gerüst und Generierung von vertikalen Lösungen |
| API-Workflow | api-workflow | Lokale Ausführung von UiPath API-Workflows |
| Data Fabric | df | Data Fabric-Vorgänge |
| Insights | insights | Insights-Dashboards und -Berichte |
| Ablaufverfolgungen | traces | Ausführungsablaufverfolgungen und Diagnose |
| DocsAI | docsai | KI-gestützte Suche in der UiPath-Dokumentation |
Führen Sie uip --help aus, um die genauen Präfixe in Ihrer Installation anzuzeigen, und uip tools list um anzuzeigen, welche Tools derzeit installiert sind. Nur die oben genannten @uipath/ -Tools werden in UiPath CLI 1.x unterstützt; Eine Drittanbieter-Erweiterung ist noch nicht verfügbar. Das Flow- Tool (@uipath/flow-tool) wird veröffentlicht, steht aber nicht auf der Zulassungsliste für die automatische Installation – installieren Sie es explizit mit uip tools install @uipath/flow-tool bevor Sie uip flow -Befehle verwenden.
Authentifizierung auf einen Blick
UiPath CLI unterstützt drei Authentifizierungsflows. Der interaktive Flow ist neu in 1.x; die anderen beiden haben Entsprechungen in der Legacy-.NET-CLI.
| Flow | Verwendungszweck | Verwendungsweise |
|---|---|---|
| Interaktive OAuth2-Benutzeranmeldung (neu in 1.x) | Entwickler, die von einem Terminal aus arbeiten. Bindet die Sitzung an Ihr persönliches Konto und dessen Berechtigungen. | uip login öffnet sich einen Browser für die Anmeldung und wählt einen Mandanten aus. Sitzungstoken werden automatisch gespeichert und aktualisiert. |
| Externe App (Client-Anmeldeinformationen) | CI/CD-Pipelines, Server, jeder nicht interaktive Kontext. Bindet die Sitzung an eine externe App, die Sie in UiPath mit expliziten Scopes erstellen. | uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant <name> – Das Präfix env.VAR liest das Geheimnis aus einer Umgebungsvariablen, ohne es in der Befehlszeile preiszugeben. |
| Authentifizierung der Umgebungsvariablen | Container und flüchtige Ausführungsprogramme, die bereits ein UiPath-Zugriffstoken enthalten. Kein Browser, kein Round Trip mit externer Apps, kein Status auf dem Datenträger. | Legen Sie UIPATH_CLI_ENABLE_ENV_AUTH=true fest und liefern Sie UIPATH_CLI_AUTH_TOKEN + Organisations-/Mandantenvariablen. Jeder uip -Befehl authentifiziert sich über die env vars; es gibt keine Aktualisierung. |
Den vollständigen Ablauf, die Mandantenauswahl, das Layout des Anmeldeinformationsordners und die Vorkonfiguration externer Apps für CI finden Sie unter Authentifizierung .
UiPath CLI im Vergleich zur Legacy-.NET-CLI
| Aspekt | UiPath CLI (uip, 1.x) | Legacy .NET-CLI (uipcli, 2025.10 und früher) |
|---|---|---|
| Laufzeit | Node.js (plattformübergreifend) | .NET 8 (Windows zuerst) |
| Verteilung | npm install -g @uipath/cli | .nupkg im MyGet/NuGet-Feed |
| Versionierung | Semantische Versionierung (1.0.0, 1.1.0, …) | Kalenderversionierung (2023.10, 2024.10, 2025.10) |
| Umfang | Erstellen, Verwalten, Betreiben und Bereitstellen der gesamten Plattform | CI/CD-fokussiert – packen, analysieren, bereitstellen, Tests ausführen |
| Authentication | Interaktive OAuth2 (uip login) und externe App (Client-Anmeldeinformationen) | Externe App (Client-Anmeldeinformationen) sowie veraltete Basis-/Tokenauthentifizierung |
| Architektur | Modulare Tools, die bei der ersten Verwendung von npm automatisch installiert werden | Mon soliische ausführbare Datei |
| Ausgabeformate | table, json, yaml, plain mit JMESPath-Filterung | Text/JSON (begrenzt) |
| KI-Integration | Fähigkeitensystem für die Codierung von Agents | Nicht verfügbar |
| Workflow-Analyse | Beibehalten als uip rpa analyze, mit Governance-Dateirichtlinienunterstützung | Im Paket mit CLI (uipcli package analyze) |
| Wiederherstellung der Abhängigkeiten | Beibehalten als uip rpa restore, mit Air-Gap- und NuGet-Config-Unterstützung | Im Paket mit CLI (uipcli package restore) |
Wenn Sie heute eine neue Pipeline starten, verwenden Sie UiPath CLI 1.x. Wenn Sie vorhandene Azure DevOps- oder Jenkins-Pipelines beibehalten, die auf uipcli.exe basieren, finden Sie im Migrationsleitfaden die Befehlszuordnung, Flag-Umbenennungen und grundlegende Änderungen.
UiPath CLI im Vergleich zu den CI/CD-Plugins
UiPath CLI (uip) ist das Tool. Die Azure DevOps-Erweiterung, das Jenkins-Plugin und ähnliche Pipelineintegrationen sind Wrapper für dieses Tool – sie packen uip -Aufrufe hinter UI-gesteuerten Aufgabenformularen, sicherer Variableninjektion und Pipeline-nativer Protokollierung ein. Zukünftig werden neuere Versionen dieser Plugins uip intern aufrufen.
Verwenden Sie das Plugin, wenn Sie die Pipeline-Benutzeroberfläche und die Variablenverwaltung möchten. Verwenden Sie uip direkt (über einen bash oder pwsh -Schritt), wenn Sie die neuesten CLI-Funktionen möchten, ohne auf ein Plugin-Release zu warten, oder wenn Sie einen Befehl benötigen, den das Plugin nicht verfügbar macht.
Die Plugin-Dokumentation finden Sie unter CI/CD-Integrationen .
Unterstützte Plattformen
UiPath CLI 1.x wird auf jeder Plattform ausgeführt, die Node.js 18 oder höher unterstützt:
- Windows (x64, ARM64)
- macOS (x64, ARM64)
- Linux (x64, ARM64)
Stabilität und Veröffentlichungskadenz
Die UiPath CLI folgt der semantischen Versionierung:
- Maestro – grundlegende Änderungen an Befehlsnamen, Flag-Semantik oder dem JSON-Umschlag. Ein Einstellungszyklus geht jeder GRUPPIERT-Version voraus.
- MINOR – neue Befehle, neue Flags, neue Tools; Nur Additiv. Beachten Sie, dass die Form von
Datain der JSON-Ausgabe befehlsspezifisch ist und sich in MINOR-Versionen ändern kann; Pipelines müssen@uipath/clianheften. - PATCH – Fehlerbehebungen; Keine dokumentierte Verhaltensänderung.
Einzelne Befehle und Tools sind als allgemein verfügbar, Vorschau oder Veraltet gekennzeichnet. Vorschau-Befehle können sich ohne größere Versionserhöhung ändern; funktionieren veraltete Befehle noch für mindestens einen MaJOR-Zyklus. Den vollständigen Vertrag finden Sie unter Versionierung und Stabilität .
Nächste Schritte
- Installieren der UiPath CLI – Richten Sie
uipunter Windows, macOS oder Linux ein. - Schnellstart – Melden Sie sich an, listen Sie die Orchestrator-Ordner auf und führen Sie einen Auftrag in fünf Minuten aus.
- Ihre erste Pipeline – Packen Sie ein Projekt und stellen Sie es über eine CI-Pipeline bereit.
- Verwenden von UiPath CLI mit Codierungs-Agents – Installieren Sie Fähigkeiten in Claude Code, Cursor, GitHub Copilot oder Gemini CLI und lassen Sie sie UiPath-Automatisierungen mit
uiperstellen. - Befehlsreferenz – vollständige Referenz für jeden Befehl.
- Migrieren von der Legacy-.NET-CLI – wenn Sie von
uipcli.exekommen.
- Mehr als ein CI/CD-Tool
- Konzipiert für Menschen und Codierungs-Agents
- So ist die UiPath CLI organisiert
- Integrierte Tools
- Authentifizierung auf einen Blick
- UiPath CLI im Vergleich zur Legacy-.NET-CLI
- UiPath CLI im Vergleich zu den CI/CD-Plugins
- Unterstützte Plattformen
- Stabilität und Veröffentlichungskadenz
- Nächste Schritte