- Ü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
Eine uip -Sitzung ist der Status, der einen Befehl an eine bestimmte UiPath-Organisation und einen bestimmten Mandanten bindet und der es der CLI ermöglicht, ein gültiges Zugriffstoken zu präsentieren, ohne den Benutzer bei jedem Aufruf aufzufordern. Sitzungen werden für die interaktiven und externen App-Flows auf der Festplatte beibehalten und aus Umgebungsvariablen für den env-var-Flow rekonstruiert. Auf dieser Seite wird erläutert, wo sich dieser Status befindet, wie uip ihn findet und was zu erwarten ist, wenn Sie zwischen Mandanten oder Maschinen wechseln.
Der Ordner „Anmeldeinformationen“.
uip login behält die Sitzung in einem Ordner mit dem Namen .uipath/ bei. Behandeln Sie seinen Inhalt als undurchsichtig – sie werden von uip login, uip login tenant set und uip logout verwaltet, und das Layout auf dem Datenträger ist ein Implementierungsdetail, das sich zwischen Versionen ändern kann. Der Ordner enthält ein Zugriffstoken, ein Aktualisierungstoken sowie die aktive Organisation und den Mandanten.
Schützen Sie den Ordner. Es enthält Token, die die Identität Ihrer Sitzung annehmen können, bis sie widerrufen werden. Bewahren Sie es in Umgebungen mit mehreren Benutzern oder gemeinsam genutzten Umgebungen in einem Basisverzeichnis mit den üblichen 0600 -Berechtigungen für den Inhalt auf. Auf einer Entwicklermaschine reicht es normalerweise aus, sie dort zu belassen, wo uip login sie abgelegt hat. Fügen Sie .uipath/ zu .gitignore hinzu, wenn eine projektbasierte Sitzung pro Entwickler ist.
Standortauflösung (Walk-up)
Wenn ein uip -Befehl ausgeführt wird, sucht die CLI in dieser Reihenfolge nach dem Anmeldeinformationsordner:
- Expliziter Pfad – Wenn ein Befehl mit
-f /path/to/folderaufgerufen wurde, wird dieser Ordner verwendet. Der Pfad kann absolut oder relativ sein. - Gehen Sie vom aktuellen Verzeichnis aus – beginnend bei
cwd, überprüft die CLI./.uipath/und läuft dann die übergeordnete Kette nach oben, um nach demselben Ordner zu suchen. Die erste, die sie findet, gewinnt. - Benutzer-Startseite – Wenn beim Gehen kein projektlokaler Ordner gefunden wurde, greift die CLI auf
~/.uipath/zurück.
uip login schreibt in den Pfad, der vom nächsten Befehl gelesen werden würde:
- Wenn Sie
uip loginin einem Verzeichnis mit einem vorhandenen.uipath/in der Gehen-up-Kette ausgeführt haben, aktualisiert die Anmeldung diese Sitzung. - Andernfalls wird
~/.uipath/in Ihrem Basisverzeichnis erstellt.
Warum Gehen?
Wenn Sie von cwd nach oben wechseln, kann ein Projektordner seine eigene Sitzung übertragen, ohne Ihr Basisverzeichnis zu ändern. Platzieren Sie einen .uipath/ -Ordner in einem Repository-Stamm und jeder, der uip innerhalb des Repositorys ausführt, übernimmt die Anmeldung dieses Projekts – nützlich für projektspezifische Client-Anmeldeinformationen, Staging-Mandanten oder Demoumgebungen.
Überschreiben des Speicherorts
Drei Möglichkeiten zum Überschreiben der Suche:
-f, --file <folder>unteruip loginunduip logout– verwenden Sie nur den angegebenen Ordner für diesen Befehl.- Ein separates Basisverzeichnis – Führen Sie auf einem freigegebenen Build-Server
HOME=/srv/build-home uip loginaus, um in/srv/build-home/.uipath/zu schreiben. uip completionund andere Befehle akzeptieren kein-f-Flag und verwenden immer das Gehen-up + Home-Fallback.
Zur Überprüfung:
# print the current session status (reads via walk-up)
uip login status
# print the current session status (reads via walk-up)
uip login status
uip login status liest immer über das Gehen-up + Home-Fallback; -f wird nicht akzeptiert. Um eine Sitzung in einem nicht standardmäßigen Ordner zu überprüfen, wechseln Sie in dieses Verzeichnis (oder ein Unterverzeichnis davon), bevor Sie uip login status ausführen, oder listen Sie verfügbare Mandanten mit uip login tenant list -f /path/to/creds auf.
Aktive Organisation und Mandant
In einer Sitzung werden jeweils eine Organisation und ein Mandant gespeichert. Der Mandant ist das UiPath-Konzept, das Ordner, Aufträge, Warteschlangen und Ressourcen umfasst – effektiv das „Konto“, das die CLI erreicht, wenn Sie uip or … ausführen.
Ändern Sie den aktiven Mandanten, ohne sich erneut zu authentifizieren:
uip login tenant list # show all tenants this session can access
uip login tenant set MyTenant # switch the active tenant
uip login tenant list # show all tenants this session can access
uip login tenant set MyTenant # switch the active tenant
Hinter den Kulissen erstellt uip login tenant set neue Zugriffs-/Aktualisierungstoken für den neuen Mandanten und aktualisiert die gespeicherte Sitzung.
Übergeben Sie --tenant <name> bei einem beliebigen uip or … -Aufruf, um den aktiven Mandanten der Sitzung für einen einzelnen Befehl zu überschreiben, ohne die Sitzung auf dem Datenträger zu ändern:
uip or folders list --tenant Staging
uip or jobs start "$PROCESS_KEY" --tenant Production
uip or folders list --tenant Staging
uip or jobs start "$PROCESS_KEY" --tenant Production
Aktualisieren von Token
Zugriffstoken sind kurzlebig. Wenn die CLI erkennt, dass das gespeicherte Zugriffstoken kurz vor dem Ablauf steht, verwendet sie das Aktualisierungstoken, um ein neues anzufordern, und aktualisiert die gespeicherte Sitzung im Hintergrund. Sie müssen uip login nicht erneut ausführen, es sei denn, einer der folgenden Fälle eintritt:
- Das Aktualisierungstoken selbst läuft ab oder wird widerrufen (normalerweise nach wochenlanger Inaktivität oder wenn ein Administrator eine Abmeldung erzwingt).
- Sie haben die Organisation geändert.
- Sie benötigen einen anderen Scope als den, mit dem die Sitzung authentifiziert wurde.
uip login status meldet Expired , wenn die Aktualisierung fehlgeschlagen ist; dies das Signal ist, uip login erneut auszuführen.
Der env-var-Flow (keine Datei)
Der dritte Authentifizierungsfluss, der durch UIPATH_CLI_ENABLE_ENV_AUTH=true aktiviert wird, umgeht den Ordner „Anmeldeinformationen“ vollständig. Jeder uip -Befehl liest das Token und den Mandanten aus Umgebungsvariablen, verwendet sie unverändert und schreibt nichts auf den Datenträger.
Dies ist die richtige Wahl für:
- Container, die ein Token von einer übergeordneten Pipeline erhalten.
- Flüchtige CI-Ausführungen, bei denen das Beibehalten von Anmeldeinformationen auf dem Datenträger unpraktisch oder verboten ist.
- Eine Umgebung, in der die CLI zwischen Aufrufen zustandslos sein muss.
Unterschiede zu den dateibasierten Flows:
- Keine Aktualisierung. Das Token ist für
uipundurchsichtig – wenn es abgelaufen ist, ist der Aufrufer für das Rotieren verantwortlich. uip logoutbewirkt nichts. Es ist keine Datei zum Entfernen vorhanden. Deaktivieren Sie die env vars für „abmelden“.- Die Basis-URL wird vom Token abgeleitet. Jede
iss-Anforderung, die das JWT enthält, wird als autoritative behandelt – legen SieUIPATH_URLnicht zusammen mitUIPATH_CLI_AUTH_TOKENfest, oder die Synchronisierung wird deaktiviert.
Den vollständigen Satz von Variablen und GitHub-Aktionen/Containerbeispielen finden Sie unter Authentifizierung – Flow 3 .
Abmelden
Dateibasierte Flows:
uip logout # clear ~/.uipath/ or the walk-up match
uip logout -f /path/to/creds # clear a specific credentials folder
uip logout # clear ~/.uipath/ or the walk-up match
uip logout -f /path/to/creds # clear a specific credentials folder
logout löscht die gespeicherte Sitzung. Nachfolgende uip or … -Aufrufe schlagen mit AuthenticationError (Exitcode 2), bis Sie uip login erneut ausführen. Um die Sitzung auch auf der Serverseite ungültig zu machen, widerrufen Sie das Geheimnis der externen App in der Automation Cloud, oder melden Sie sich von Ihrem Benutzerkonto ab.
Env-var-Flow: Deaktivieren Sie UIPATH_CLI_ENABLE_ENV_AUTH (und die Tokenvariablen, um sicher zu sein).
Siehe auch
- Authentifizierung – die drei Flows, die den Ordner für Anmeldeinformationen schreiben oder umgehen.
- Konfiguration – Vorrang der Umgebungsvariablen, die sich neben, aber getrennt vom Anmeldeinformationsordner befindet.
- UIP-Anmeldereferenz, UIP-Anmeldestatusreferenz, UIP-Abmeldereferenz – Flag-Listen und Beispiele pro Befehl.
- Installieren von UiPath CLI – Anmeldeinformationen und Daten entfernen – Bereinigung nach Deinstallation.