- Ü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
uip or ist das Orchestrator-Tool: Es verwaltet Aufträge, Ordner, Prozesse, Pakete, Maschinen, Benutzer, Rollen, Lizenzen, Feeds und Anhänge auf einem UiPath Orchestrator-Mandanten. Installieren Sie es mit uip tools install or oder rufen Sie uip or … auf und lassen Sie die automatische Installation ausführen. Das Installationsmodell finden Sie unter Tools (Plugins) und unter UIP-Tools finden Sie den Befehl, der die Toolinstallation verwaltet.
Ressourcen
Jede Ressource hat eine eigene Referenzseite. Das auf jeder Seite festgelegte Verb stimmt mit den von uip or registrierten Befehlen überein – führen Sie uip or --help aus, um die vollständige Oberfläche Ihrer Installation zu bestätigen.
| Ressource | Zweck |
|---|---|
| Jobs | Starten, Stoppen, Neustarten, Fortsetzen und Überprüfen von Prozessausführungen; Abrufen von Protokollen, Ablaufverfolgungen, Reparaturdaten und Statusverlauf. |
| Ordner | Erstellen, Auflisten, Verschieben, Bearbeiten und Löschen von Ordnern; Überprüfen Sie die Runtime-Zuweisung. |
| Prozesse | Pakete als ausführbare Prozesse an Ordner binden; Aktualisieren, Rollback und Bearbeiten. |
| Pakete | Das Hochladen, Herunterladen, Auflisten und Überprüfen von .nupkg -Automatisierungspaketen und deren Einstiegspunkte. |
| Maschinen | Verwalten von Maschinenvorlagen und Slot-Zuweisungen; Maschinen zu Ordnern zuweisen. |
| Benutzer | Erstellen, Bearbeiten, Löschen und Zuweisen von Orchestrator-Benutzern; Verwalten Sie Rollenzuweisungen auf Mandantenebene. |
| Rollen | Verwalten Sie Rollen, Berechtigungen und Rollenbenutzermitgliedschaften im Mandanten- und Ordnerbereich. |
| Lizenzen | Runtime- und Named-User-Lizenzzuweisungen auflisten; Maschinenlizenzierung umschalten; Zusammenfassung der Mandantenlizenzen anzeigen. |
| Feeds | Listen Sie Paketfeeds auf, die für den aktuellen Benutzer verfügbar sind. |
| Anhänge (Attachments) | Auftragsanhänge auflisten und herunterladen. |
Zusammenfassung
uip or <resource> <verb> [options]
uip or <resource> <verb> [options]
Immer uip or, nie uip orchestrator. or ist das Befehlspräfix des Tools (siehe Spalte commandPrefix in uip tools list).
So lesen Sie diesen Abschnitt
Jede Ressourcenseite ist gleich strukturiert:
- Synopse – die Befehlsform
uip or <resource> <verb>. - Verben – eine einzeilige Tabelle mit jedem Verb, das die Ressource verfügbar macht.
- Ein H2 pro Verb – Beschreibung, Positionargumente (falls vorhanden), Flag-Tabelle, drei Beispiele (einfaches, gängigstes Fall, Skripting-freundlich mit
--output-filter) und dieData-Form, die unter--output jsonzurückgegeben wird. - Austrittscodes – ein Verweis auf den gemeinsam genutzten Austrittscode -Vertrag mit allen verbspezifischen Überschreibungen, die inline aufgerufen werden.
- Zugehörige Befehle und Siehe auch – Querlinks zu gleichgeordneten Ressourcen und relevanten Konzeptseiten.
Das Standardausgabeformat ist --output json. Datenstrukturen auf jeder Seite spiegeln die JSON-Payload wider – Tabelle, yaml und einfache Renderings werden vom gleichen Data -Objekt abgeleitet.
Allgemeine Flags
Eine kleine Reihe von Flags wird in den meisten Ressourcen wiederholt. Sie verhalten sich überall gleich:
| Markieren | Wird von verwendet | Zweck |
|---|---|---|
-t, --tenant <tenant-name> | jedes Verb | Überschreiben Sie den zum Zeitpunkt der Authentifizierung ausgewählten Mandanten. Optional; verwenden Sie den Sitzungsstandard nicht. Siehe Authentifizierung. |
--folder-path <path> | die meisten Verben, die sich auf einen Ordner beziehen | Zielordner nach vollqualifiziertem Pfad (z. B. Shared, Production/EU). |
--folder-key <key> | die meisten Verben, die sich auf einen Ordner beziehen | Zielordner nach GUID. Gemeinsam mit --folder-path verwendbar; Entweder löst derselbe Ordner auf. |
-l, --limit <number> | jedes Listenverb | Seitengröße. Die Standardeinstellung ist DEFAULT_PAGE_SIZE der CLI (50 zum Zeitpunkt des Schreibens). |
--offset <number> | jedes Listenverb | Anzahl der Elemente, die vor der Rückgabe übersprungen werden sollen. Die Standardeinstellung ist 0. |
--order-by <field> | die meisten Listenverben | OData-Sortierungsausdruck (z. B. Name asc, Id desc). Jedes Verb dokumentiert seinen Standardwert. |
--all-fields | viele list / get Verben | Geben Sie die Roh-API-Antwort anstelle der kuratierten Zusammenfassung zurück. Nützlich, wenn Sie Felder benötigen, die die Standardform auslässt. |
Flags auf Verbebene (Filter, Eingabe-/Ausgabepfade, Strategien, Prioritäten) werden auf jeder Ressourcenseite dokumentiert.
Globale Optionen und Exitcodes
Alle uip or -Verben berücksichtigen die vier globalen Optionen (--output, --output-filter, --log-level, --log-file). Austrittscodes folgen dem gemeinsamen Vertrag; Jede Verb-spezifische Überschreibung wird auf der entsprechenden Ressourcenseite aufgerufen.
Siehe auch
- Konzepte: Wie die UiPath CLI organisiert ist – wo Tools in das Host- und Toolmodell passen.
- Sitzungen – wie Mandanten- und Ordnerkontext aufgelöst werden.
- Konfiguration – Umgebungsvariablen und Konfigurationsdateien, die sich auf jedes Tool auswirken.
- Schnellstart und Ihre erste Pipeline – End-to-End-Anleitungen, die
uip ortrainieren.