Globale Optionen

Globale Optionen, die von jedem „uip“-Aufruf akzeptiert werden und das Ausgabeformat, den Ausgabefilter, die Protokollebene und die Protokolldatei abdecken.

Jeder uip -Aufruf wird nach einem festen Satz globaler Optionen vorab durchsucht, bevor ein Tool oder Unterbefehl seine Argumente sieht – sie können überall in der Befehlszeile erscheinen, funktionieren in jedem Tool identisch und werden vor der Flag-Parsing pro Befehl entfernt ausgeführt wird.

Option	Short	Wert	Standard	Zweck
--output	–	table, json, yaml, plain, markdown	json	Das in „stdout“ geschriebene Format der primären Ausgabe.
--json	–	Markieren	–	Ausgeblendeter Kompatibilitäts-Alias für --output json. Wenn sie zusammen mit einer expliziten --output <value> übergeben wird, stellt dies einen Konflikt dar – siehe unten.
--output-filter	–	JMESPath-Ausdruck	–	Nachfilter, der vor der Formatierung auf die JSON-Nutzlast angewendet wurde.
--log-level	–	debug, info, warn, error	info	Ausführlichkeit der in Standardr geschriebenen Protokollmeldungen (und --log-file , wenn festgelegt).
--log-file	–	Pfad	–	Wenn diese Option festgelegt wird, werden Protokolle im JSON-Zeilenformat in dieser Datei dupliziert.
--profile	–	name	–	Wählt ein benanntes, gespeichertes Anmeldeprofil anstelle des standardmäßigen Speicherorts für Anmeldeinformationen aus. Sich gegenseitig mit der eigenen -f, --file <folder> eines Befehls ausschließen (z. B. auf uip login, uip login tenant list/set, uip logout) – beides wird als ValidationError übergeben. Siehe Sitzungen und Anmeldeinformationen.
--interactive / --no-interactive	–	Markieren	auto (prompts nur für ein Tty)	Erzwingen von Prompts ein- oder ausschalten, wobei die Standardeinstellung „Prompt nur, wenn eine Verbindung mit einem Tty“ besteht Verhalten. Nicht spezifisch für einen Befehl – sie regelt jeden Ort, an dem ein uip -Befehl sonst eine Frage stellen würde (z. B. Mandantenauswahl während uip login oder die Agent-/Zielauswahl in uip skills install).

--version (-v) und --help (-h) werden auch in uip und jedem Unterbefehl erkannt, aber es handelt sich dabei um Standardkonventionen der CLI und nicht um globale Flags im obigen Sinne.

--output

Wählen Sie das Ausgabeformat aus. Sowohl --output json als auch --output=json funktionieren; Bei den Werten wird die Groß-/Kleinschreibung beachtet.

uip or folders list                     # default: json
uip or folders list --output table      # human-friendly table
uip or folders list --output yaml       # yaml
uip or folders list --output plain      # key=value lines, no structure
uip or folders list --output markdown   # GitHub-flavored markdown, for agents/chat surfaces

• json (Standard) – Ein JSON-Dokument in Standardausgabe. Parsbar von jq, --output-filter und einem beliebigen JSON-Verbraucher. Dies ist der Standardwert für jeden Aufruf, unabhängig davon, ob das Terminal ein Tty ist.
• table – Enthält einen Rahmen, farbige Tabelle, die zum Lesen in einem Terminal geeignet ist. Nicht versioniert stabil – nicht analysieren.
• yaml – YAML-Serialisierung der gleichen Struktur wie json.
• plain – key=value Zeilen. Nützlich für das Piping in Shell read, grep und cut ohne Installation jq.
• markdown – eine GPM-Tabelle für eine Liste oder **key:** value Zeilen für einen einzelnen Datensatz. Gedacht für einen Agent oder eine Chatoberfläche, die die uip -Ausgabe liest, nicht für eine Terminalsitzung. Das vollständige Verhalten finden Sie unter Ausgabeformate – Markdown .

Hinweis:

Der Standardwert ist json, nicht table. Wenn ein Mensch uip or folders list in einem Terminal ausführt, wird ihm ein JSON-Dokument in der Standardausgabe angezeigt. Übergeben Sie --output table explizit (oder fügen Sie es einem Shell-Alias hinzu) für die lesbare Ansicht. Diese Auswahl behält die gleiche Standardform in einem Terminal und in einer Pipeline bei – Skripts müssen sich nicht darum kümmern, ob sie interaktiv ausgeführt werden.

--json (ausgeblendeter Alias)

--json ist ein ausgeblendeter Kompatibilitäts-Alias für --output json – er erscheint nicht in --help, ist aber voll funktionsfähig:

uip or folders list --json   # identical to --output json

Die Übergabe von --json zusammen mit einem expliziten --output <value> (beliebiger Wert, einschließlich json) wird intern als Konflikt gekennzeichnet; Vermeiden Sie das Kombinieren von ihnen – übergeben Sie das eine oder andere.

-–Profil

Wählen Sie ein benanntes, gespeichertes Anmeldeprofil anstelle des standardmäßigen Speicherorts für Anmeldeinformationen aus:

uip login --profile ci-runner --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant Production
uip or folders list --profile ci-runner

--profile <name> und die eigene -f, --file <folder> eines Befehls schließen sich gegenseitig aus – das Übergeben von beiden schlägt mit ValidationError: option '--profile' cannot be used with option '--file' fehl. Profilnamen sind normalisiert (es gelten die Groß-/Kleinschreibungs- und Trennzeichenregeln); Ein ungültiger Name wird vor jedem Netzwerkaufruf abgelehnt. Siehe Sitzungen und Anmeldeinformationen – Benannte Profile.

--interaktiv/--no-interaktiv

Überschreiben Sie den standardmäßigen Prompt nur, wenn „stdout ein Tty“ ist; Verhalten:

uip login --interactive        # force the tenant-selection prompt even when not on a TTY
uip skills install --no-interactive --agent claude   # never prompt, fail instead if a required choice is missing

--interactive legt Prompt auf Always-On fest; --no-interactive erzwingt das Aus. Keines der Flags ist spezifisch für uip login – obwohl sie in Anmeldebeispielen im gesamten Dokumentationssatz enthalten ist, ist Interaktivität eine übergreifende globale Option ohne befehlsspezifische Kurzform (es gibt keine --it oder einen ähnlichen Alias in der CLI).

Stream-Trennung

--output steuert nur Standard. Protokolle, Fortschrittsindikatoren und von Menschen verursachte Fehler werden unabhängig vom Format in „stderr“ verschoben. Das bedeutet, dass eine Pipeline saubere JSON erfassen kann mit:

uip or folders list > folders.json 2> uip.log

…und die Protokollausgabe wird weiterhin separat angezeigt.

--ausgabefilter

Wenden Sie vor der Formatierung einen JMESPath- Ausdruck auf die JSON-Nutzlast an. Der Filter wird für den vollständigen Antwortumschlag ausgeführt, sodass Data[*].Name Namen aus dem Data -Array auswählt, length(Data) eine Anzahl zurückgibt usw.

# just the Data field
uip or folders list --output-filter "Data"

# folder names only
uip or folders list --output-filter "Data[*].Name"

# count
uip or folders list --output-filter "length(Data)"

# first folder's key and name
uip or folders list --output-filter "Data[0] | {key: Key, name: Name}"

Kombinieren mit --output:

# names as YAML
uip or folders list --output-filter "Data[*].Name" --output yaml

# names as one-per-line plain text
uip or folders list --output-filter "Data[*].Name" --output plain

Ein falsch formatierter Filterausdruck schlägt schnell mit einem ValidationError und einem Exitcode 3 fehl, bevor der zugrunde liegende Befehl ausgeführt wird – ein Tippfehler macht also keinen API-Aufruf verschwendet.

Tipp:

--output-filter ist die CLI-Version von --query von Azure CLI, --query von AWS CLI und --filter/--format von gcloud. Wenn Sie JMESPath bereits von diesen Tools kennen, ist die Syntax identisch.

--log-Ebene

Legen Sie die Ausführlichkeit der Protokollmeldungen fest (geschrieben in ständigerr und in --log-file , wenn angegeben).

uip or folders list --log-level debug   # verbose — HTTP calls, auth refresh, tool loading
uip or folders list --log-level info    # default
uip or folders list --log-level warn
uip or folders list --log-level error   # only failures

Bei den Werten wird die Groß-/Kleinschreibung nicht berücksichtigt. Unbekannte Werte werden im Hintergrund ignoriert (der Standardwert wird beibehalten), anstatt einen Fehler zu verursachen – mit Absicht, damit ein Tippfehler in einem Wrapper-Skript eine Pipeline nicht unterbricht.

Die Umgebungsvariable UIPATH_LOG_LEVEL wird nicht berücksichtigt; Übergeben Sie das Flag oder legen Sie es in einem Profilskript fest.

--log-datei

Schreibt ein Duplikat des Protokollstreams in die angegebene Datei im Format JSON-Zeilen (ein JSON-Objekt pro Zeile). Die Datei wird angehängt – verwenden Sie einen Build-spezifischen Pfad, wenn Sie separate Protokolle pro Ausführung benötigen.

uip or folders list --log-file ./uip.log
uip or folders list --log-file /var/log/uip/$(date +%F).log --log-level debug

Jede Zeile in der Datei sieht so aus:

{"time":"2026-04-24T18:42:00.123Z","level":"info","message":"CLI v1.0.0 starting — output=json, logLevel=info, logFile=./uip.log"}

Dieses Format wurde für Protokollversender (Fluent Bit, Loki, Splunk) und für die Post- Aktualisierungsanalyse entwickelt.

Wo globale Optionen gelten

Globale Optionen werden aus der Befehlszeile entfernt, bevor Flags pro Befehl geparst werden, sodass sie überall in der Befehlszeile angezeigt werden können:

uip --output table or folders list
uip or --output table folders list
uip or folders list --output table
uip or folders list --output=table

Alle vier Aufrufe sind gleichwertig.

Tool-Unterbefehle definieren keine eigenen --output oder --log-level. Ein Tool, das versehentlich eins definiert hat, würde das globale Flag in Schatten stellen – die Lint-Prüfungen der CLI verhindern dies.

Exitcodes

Globale Optionen steuern nur die Ausgabe und Protokollierung; Sie wirken sich nicht auf Exitcodes aus. Siehe Exitcodes.

Überschreibungen von Umgebungsvariablen

Zwei Umgebungsvariablen ändern das Verhalten der globalen Option ohne ein Flag:

Variable	Auswirkung
UIP_DEFAULT_OUTPUT	Überschreibt den integrierten json -Standardwert für --output, wenn das Flag nicht übergeben wird. Akzeptiert table, json, yaml, plain oder markdown; Ungültige Werte werden ignoriert. Ein explizites --output in der Befehlszeile gewinnt immer.
UIP_TIMINGS	Legen Sie 1 oder true fest, um bei jedem uip -Befehl eine Zeitlinie pro Aufruf auf standardr zu ausgeben. Siehe Befehlszeiträume unten.

Befehlszeiträume

Legen Sie UIP_TIMINGS=1 (oder true) fest und jeder Aufruf gibt eine Zeile im Standardwert aus:

[timing] 'uip or assets list' exit=0 total=1250ms startup=380ms command=863ms http=691ms httpCalls=3 flush=7ms

Feld	Bedeutung
(der in Anführungszeichen angegebene Befehl)	Der Befehl, wie eingegeben.
exit	Der Exitcode, der vom Aufruf zurückgegeben wurde.
total	Gesamtzeituhr, gemessen ab Prozessstart.
startup	Alles, bevor der Befehlshandler ausgeführt wurde – Prozessstart, Konfiguration, Toolladen.
command	Der Befehlshandler selbst.
http	Summierte Dauer der ausgehenden HTTP-Aufrufe der Ausführung – eine Summe, keine Bank. Es überlappt command, anstatt es zu ergänzen, sodass parallele Aufrufe es größer als command machen können.
httpCalls	Wie viele ausgehende HTTP-Aufrufe diese Summe abdeckt.
flush	Alles, nachdem der Handler zurückgegeben wurde – Telemetriebuchung und der letzte Flush.

startup + command + flush ist immer gleich total. Felder werden weggelassen, wenn sie nicht zutreffen: Eine Ausführung, die nie einen Handler erreicht (uip --version, ein unbekannter Befehl), gibt nur total und exit aus; Ein Befehl, der keinen HTTP-Aufruf ausführt, hat weder http noch httpCalls.

Der Bericht verfügt über einen eigenen Schalter – er ist nicht von --log-level abhängig, sodass Sie Dauern erhalten, ohne die Debug-Ausgabe zu aktivieren, und der Standardwert wird nie geändert.

Siehe auch

• Ausgabeformate (Tabelle, JSON, YAML) – Tiefere Abdeckung mit vollständigen Beispielen für jedes Format.
• Skriptingmuster – Exitcodes, Streamtrennung, Wiederholungen, Abfragen.
• UIP-Login-Referenz und andere Befehlsseiten – dokumentieren ihre Flags pro Befehl zusätzlich zu diesen globalen.