Referenzübersicht

Die Referenzdokumente zu jedem uip -Befehl, Flag und Exitcode. Verwenden Sie sie als Suche, wenn Sie wissen, was Sie tun möchten, und die genaue Syntax benötigen. Beginnen Sie zum Lernen mit Schnellstart oder So ist die UiPath CLI organisiert.

Wie die Referenz organisiert ist

Die Referenz ist in drei Arten von Seiten unterteilt:

1. Übergreifend – Verhalten, das unabhängig vom Tool für jeden uip -Aufruf gilt.
2. Kernbefehle – Befehle, die der Host besitzt (login, logout, tools, skills, mcp, completion).
3. Pro Tool – ein Abschnitt pro installierbarem Tool; Jeder Abschnitt hat eine Übersicht plus eine Seite pro Ressource (für „Ressource-First“-Tools) oder pro Verb (für Einzel-Workflow-Tools).

Übergreifend

Seite (Page)	Was damit abgedeckt wird
Globale Optionen	--output, --output-filter, --log-level, --log-file – die vier Flags, die für jeden Befehl verfügbar sind.
Exitcodes	Der fünfstufige Exit-Code-Vertrag (0 / 1 / 2 / 3 / 4) plus 130 für die Ankündigung durch den Benutzer.

Kernbefehle

Befehligt den Host, sich direkt zu registrieren. Keine Toolinstallation erforderlich.

Befehl	Zweck
UIP-Anmeldung	Starten Sie eine interaktive OAuth2-Sitzung, authentifizieren Sie sich als externe App oder wechseln Sie den Mandanten.
UIP-Abmeldung	Entfernen Sie die gespeicherten Anmeldeinformationen.
UIP-Anmeldestatus	Zeigen Sie die Organisation, den Mandanten und das Ablaufdatum der aktuellen Sitzung an.
UIP-Tools	Installierbare Tools auflisten, suchen, installieren, aktualisieren oder deinstallieren.
UIP-Fähigkeiten	Installieren Sie UiPath-Fähigkeiten in Codierungsagenten (Claude Code, Cursor, GitHub Copilot, Gemini CLI, Codex, OpenCode).
UIP-MCP	Stellen Sie uip -Befehle über das Model Context Protocol für MCP-fähige Clients bereit.
uip-Vervollständigung	Installieren, drucken oder entfernen Sie die Shell-Registerkartenvervollständigung für bash, zsh, jeFge und pwsh.

Tools

Jedes Tool ist ein installierbares npm-Paket. Führen Sie uip tools install <alias> aus, um sie hinzuzufügen, oder rufen Sie sie einmal auf und lassen Sie die automatische Installation die Arbeit erledigen. Siehe Tools (Plugins) für das Modell und UIP-Tools für den Befehl, der sie verwaltet.

Alias	Tool	Referenz (Reference)
or	Orchestrator	uip oder
platform	Plattform (Mandantenlizenzierung, Benutzerpakete, Gruppenregeln, Verbrauchsmaterialien)	UIP-Plattform
solution	Lösung	UIP-Lösung
agent	Mitarbeiter	UIP-Agent
flow	Flow (nur explizite Installation – nicht auf weißen Liste für die automatische Installation)	UIP-Flow
maestro	Maestro	UIP Maestro
tm	Test Manager	UIP-TM
rpa	RPA (Studio-Verpacken, Analysieren, Wiederherstellen)	UIP-RPA
rpa-legacy	RPA Legacy – Nur Windows-Wrapper um uipcli.exe (Debuggen, Validieren, Find-Activities, Find-Package, Type-Definition, Paket)	uip rpa-legacy
resource	Ressource (Assets, Warteschlangen, Buckets, Trigger, Webhooks)	UIP-Ressource
is	Integration Service	uip ist
codedagent	Codierter Agent	UIP-codierter Agent
codedapp	Codierte App	UIP-codierte App
api-workflow	API-Workflow	UIP-API-Workflow
vss	Vertikale Lösungen	UIP vs
df	Data Fabric	UIP-df
insights	Insights	UIP-Erkenntnisse
traces	Ablaufverfolgungen	UIP-Ablaufverfolgungen
docsai	DocsAI	UIP-Dokumentation

So wird eine Befehlsseite gelesen

Die Referenzseite jedes Befehls folgt derselben Struktur:

1. Synopse – die einzeilige Befehlsform, die Positionsargumente und den allgemeinen Flag-Set zeigt.
2. Beschreibung – ein oder zwei Absätze darüber, was der Befehl bewirkt und wo er in einen Workflow passt.
3. Argumente – Tabelle der Positionsargumente: Name, erforderlich/optional, Zweck.
4. Optionen – Tabelle von Flags, gruppiert nach Bedenken (Identität, Filterung, Ausgabe, Verhalten). Jede Zeile zeigt einen Kurznamen, einen Langnamen, einen Werttyp, einen Standardwert und eine einzeilige Beschreibung an.
5. Beispiele – drei oder mehr funktionierte Beispiele: minimal, gängiger Fall, skriptfähig (mit --output-filter oder expliziter JSON-Behandlung).
6. Beendigungscodes – ein Verweis auf Beendigungscodes sowie alle befehlsspezifischen Überschreibungen.
7. Zugehörige Befehle – Befehle, die häufig zusammen mit diesem verwendet werden.
8. Siehe auch – Konzept- und Anleitungsseiten, die den Kontext des Befehls abdecken.

Alle Seiten übernehmen die globalen Optionen; sie werden nicht bei jedem Befehl wiederholt.

Konventionen

• Befehlspräfix. uip ist die ausführbare Datei; jedes Beispiel beginnt damit.
• Platzhalter. <angle-brackets> für erforderliche Werte, [square-brackets] für optionale Werte. Ersetzen Sie durch Ihre echten Werte.
• Kurze Flags. Wenn ein Flag eine kurze Form hat (z. B. -t für --tenant), werden beide zusammen in der Optionstabelle aufgeführt; Beispiele verwenden die lange Form für die Lesbarkeit.
• JSON-Beispiele. --output json ist der Standardwert. Beispiele, die die Ausgabe zeigen, lassen irrelevante Felder mit … , um den Fokus zu behalten.
• Versionshinweise. Befehle oder Flags mit der Bezeichnung „Vorschau“ können sich ohne eine wesentlichen Versionserhöhung ändern. Befehle, die als veraltet gekennzeichnet sind, funktionieren für mindestens einen MaJOR-Zyklus weiter. Siehe Versionierung und Stabilität.