- Überblick
- Erste Schritte
- Konzepte
- Überblick
- So ist die UiPath CLI organisiert
- Tools (Plugins)
- Fähigkeiten
- Sitzungen und Anmeldeinformationen
- 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
UiPath CLI besteht aus einem kleinen Host sowie einer Reihe von Tools und einigen übergreifenden Diensten. Wenn Sie verstehen, wie die Teile zusammengehören, sind die Designoptionen – Standardausgabeformat, automatische Installation, Sitzungsauflösung, Stabilitätsvertrag – leichter nachvollziehbar. Diese Seite ist eine Übersicht über jede Ebene mit einem einzelnen Absatz mit Links zu der Seite, die tiefer ist.
Der Host
Der Host ist das @uipath/cli npm-Paket, das über den Befehl uip aufgerufen wird, den npm install -g auf Ihrem PATH platziert. Es ist ein schlankes Befehlszeilenprogramm, das Folgendes besitzt:
- Argv-Analyse und globale Optionen, einschließlich des Vier-Flag-Vertrags:
--output,--output-filter,--log-level,--log-file. Globale Optionen werden aus argv entfernt, bevor der Unterbefehl eines Tools die Argumente sieht, sodass Tools sie nicht versehentlich überlagern können. - Authentifizierung und Sitzungsverwaltung über drei Flows (interaktives OAuth2, externe App, env-var). Siehe Sitzungen und Anmeldeinformationen.
- Konfiguration über Umgebungsvariablen und Flags pro Befehl. Siehe Konfiguration.
- Toollebenszyklus über
uip tools install / update / uninstall / list / search. Siehe Tools (Plugins). - Fähigkeiten-Lebenszyklus über
uip skills install / update / uninstall. Rechtzeitig zu Tools. Siehe Fähigkeiten. - Shell-Vervollständigung über
uip completion(bash, zsh,daten, pwsh). - Die Model Context Protocol-Bridge über
uip mcpfür MCP-fähige Clients. - Protokollierung, Telemetrie, Ausgabeformatierung und der JSON-Umschlag – die Runtime-Dienste, die jeder Befehl verwendet, um eine konsistente Ausgabe zu erzeugen.
Der Host wird als @uipath/cli auf npm veröffentlicht. Die Veröffentlichungskadenz ist unabhängig von den Tools.
Tools
Jede UiPath-Oberfläche – Orchestrator, Lösungen, Agents, Flows, Maestro, RPA, Test Manager, Integration Service, Data Fabric, Insights, Traces, DocsAI, API Workflow, vertikale Lösungen, codierte Agents, codierte Apps – ist ein separates npm-Paket unter @uipath/ -Scope. Der Host unterhält eine weiße Liste für die automatische Installation dieser Pakete und installiert sie bei der ersten Verwendung. Tools werden langsam geladen; Eine Neuinstallation hat null Tools auf dem Datenträger.
Toolversionen verfolgen standardmäßig die MaJOR.MINOR-Zeile des Hosts, sodass durch Aktualisieren der CLI und Ausführen von uip tools update die gesamte Toolkette in Schritt ausgeführt wird.
Das vollständige Modell und die UIP-Tools-Referenz für den Befehl finden Sie unter Tools (Plugins) . Das Verhalten bei der automatischen Installation ohne Opt-out wird unter Installieren der UiPath CLI unter „Automatische Installation des Steuerelements“ behandelt.
Fähigkeiten
Fähigkeiten sind ein paralleler Erweiterungsmechanismus, der auf KI-Codierungsagents abzielt, nicht auf die Befehlsoberfläche. uip skills install --agent <name> schreibt einen Katalog von UiPath-spezifischen Anweisungen in Claude Code, Cursor, GitHub Copilot, Gemini CLI, Codex oder OpenCode. Der Agent liest diese Anweisungen, um zu erfahren, wie uip für gängige UiPath-Aufgaben verwendet wird – eine Lösung packen, einen Agent bereitstellen, einen Testsatz ausführen und so weiter.
Fähigkeiten und Tools sind unabhängig. Tools Befehle hinzufügen; Fähigkeiten lehren Agents, die Befehle zu verwenden. Durch das Installieren von Tools werden keine Fähigkeiten installiert und umgekehrt. Siehe Fähigkeiten.
Sitzungen und Anmeldeinformationen
uip login erstellt eine Sitzung – eine Organisation, einen Mandanten und ein Paar von Zugriffs-/Aktualisierungstoken – und behält sie in einem .uipath/ -Ordner bei. Die CLI löst den Ordner durch Gehen vom aktuellen Verzeichnis nach oben auf und greift auf ~/.uipath/ zurück, wenn kein projektlokaler Ordner gefunden wird. Token werden geräuschlos aktualisiert, bis das Aktualisierungstoken selbst abläuft oder widerrufen wird.
Ein dritter Authentifizierungsfluss umgeht den Status auf der Festplatte vollständig: Mit UIPATH_CLI_ENABLE_ENV_AUTH=true liest die CLI Token + Mandant + Organisation bei jedem Aufruf aus Umgebungsvariablen, was für Container und flüchtige Ausführungsinstanzen geeignet ist. Siehe Sitzungen und Anmeldeinformationen und Authentifizierung.
Ausgabe- und Exitcodes
Jeder Befehl gibt einen einzelnen strukturierten Umschlag bei Standardausgabe aus. Vier Formate – json (Standard), table, yaml, plain – rendern denselben Umschlag unterschiedlich. Das Feld Result des Umschlags ordnet eins zu eins einem schmalen Satz von Exitcodes zu (0 / 1 / 2 / 3 / 4 + 130 für Benutzerabbruch), auf denen Skripts verzweigen können, ohne Strings zu analysieren.
Stdout ist für den Umschlag reserviert. Protokolle, Fortschrittsindikatoren und visuell lesbarer Fehlertext werden immer in „stderr“ verschoben, sodass Pipelines die beiden Streams unabhängig umleiten können.
Siehe Ausgabeformate, Exitcodes und Skriptmuster.
Protokollierung und Telemetrie
Protokolle sind strukturierte JSON-Zeilen. Sie wechseln standardmäßig zu standard und werden mit --log-file <path> in eine Datei dupliziert, damit Protokollversender sie aufnehmen können. --log-level steuert die Ausführlichkeit (debug / info / warn / error).
Telemetrie sind anonyme Nutzungsdaten, die an Application Insights von UiPath gesendet werden. Er kann mit UIPATH_TELEMETRY_DISABLED=1 deaktiviert oder mit UIPATH_AI_CONNECTION_STRING umgeleitet werden. Es werden keine Befehlsargumente, Dateiinhalte oder Anmeldeinformationen übertragen.
Siehe Konfiguration und Abschnitt Telemetrie der Installation der UiPath CLI.
Die vollständige Befehlsoberfläche
uip <core-command> … # login, logout, tools, skills, mcp, completion
uip <tool-alias> <verb> [options] # single-workflow tools (solution, agent, flow, maestro, rpa, codedagent, codedapp, api-workflow, vss)
uip <tool-alias> <resource> <verb> # resource-first tools (or, tm, resource)
uip <tool-alias> [options] # flat wrappers (df, insights, traces, docsai, is)
uip <core-command> … # login, logout, tools, skills, mcp, completion
uip <tool-alias> <verb> [options] # single-workflow tools (solution, agent, flow, maestro, rpa, codedagent, codedapp, api-workflow, vss)
uip <tool-alias> <resource> <verb> # resource-first tools (or, tm, resource)
uip <tool-alias> [options] # flat wrappers (df, insights, traces, docsai, is)
Drei Formen, eine Grammatik. Auf der Referenzseite jedes Tools sind die genauen Verben und Flags dokumentiert; Jedes Tool erbt die gleichen globalen Optionen und den gleichen Umschlag.
Wie ein Befehl ausgeführt wird
Die Sequenz für einen uip or folders list -Aufruf auf einer höheren Ebene:
- Parsen Sie globale Optionen. Der Host entfernt
--output,--output-filter,--log-level,--log-fileaus Argv und konfiguriert die Laufzeit. - Lösen Sie das Tool auf.
orist mit der weißen Liste abgeglichen. Wenn@uipath/orchestrator-toolnoch nicht installiert ist, wird die automatische Installation ausgeführt. Andernfalls wird das Tool dynamisch geladen. - Tool registriert Unterbefehle. Der Host erlernt mehr über
uip or folders listund andere Orchestrator-Unterbefehle. - Authentifizierung auflösen. Das Tool fragt den Host nach der Sitzung. Der Host ruft sie aus einem
.uipath/-Ordner (Walk-up) von env-var auth ab oder schlägt schnell mit dem Exitcode2fehl, wenn nichts verfügbar ist. - Konfiguration auflösen. Umgebungsvariablen und Flags werden per Präfixkette abgeglichen.
- Führen Sie das Verb aus. Das Tool ruft den Orchestrator mit der aufgelösten Sitzung und Konfiguration auf und gibt dann den Umschlag über den Formatierer des Hosts aus.
- Beenden. Der Host übersetzt das
Resultdes Umschlags in einen Prozessexitcode.
Nichts in dieser Sequence ist spezifisch für Orchestrator. Jeder uip <tool> … -Aufruf folgt der gleichen Form, wodurch Skripte über Tools hinweg portierbar sind.
Siehe auch
- Tools (Plugins) – Das Plugin-Modell im Detail.
- Fähigkeiten – der parallele Erweiterungsmechanismus für KI-Agents.
- Sitzungen und Anmeldeinformationen – wo sich der Anmeldeinformationsordner befindet und wie er aufgelöst wird.
- Konfiguration – Dateien, env-Variablen und Priorität.
- Ausgabeformate, Austrittscodes, Globale Optionen – der Laufzeitvertrag.