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.
--output-filter	–	JMESPath-Ausdruck	–	Filter applied to the Data field of the response envelope before formatting.
--log-level	–	debug, info, warn, error	info	Verbosity of log messages written to stderr (or to --log-file if set).
--log-file	–	Pfad	–	If set, logs are written to this file instead of stderr.
--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 — a GFM table for a list, or **key:** value lines for a single record. Meant for an agent or chat surface reading uip output, not a terminal session. Refer to Output formats — markdown for the full behavior.

Only the five format names above are read as the global option. Several commands own a -o, --output <path> option of their own; a value that is not a format name, such as --output ./report.pdf, is left for the command. You can therefore combine a format and a command's output path in one invocation, for example --output json -o ./report.pdf.

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.

-–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

Apply a JMESPath expression to the Data field of the response envelope before formatting. The expression starts at Data, not at the envelope, so [*].Name picks names out of a Data array and length(@) returns a count. The result replaces Data; Result, Code, and the other envelope fields stay in place.

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

# count
uip or folders list --limit 50 --output-filter "length(@)"

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

Keys in the filtered result are normalized to PascalCase, the same as unfiltered Data. A projection that returns plain values, such as [*].Name, is rendered as one record per value, keyed by the last field name in the expression.

Kombinieren mit --output:

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

# names as one-per-line plain text
uip or folders list --limit 50 --output-filter "[*].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.

The filter runs on the client, over the records the command fetched. On a command whose --limit has a default value, --output-filter requires an explicit --limit; without one, the command fails instead of filtering only the first page of records.

When the filter returns nothing, or only null values, from records that were there, the envelope carries a Warning field that names the fields the expression read that do not exist, and lists the available fields. The same note is written to stderr.

On failure, the filter is applied to the failure envelope's Data the same way. Message, Instructions, ErrorCode, Retry, and Context are never filtered. If the filter cannot be evaluated against a failure's Data, Data is shown in full and Warning explains why.

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

Set the verbosity of log messages (written to stderr, or to --log-file if provided).

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

Write the log stream to the specified file instead of stderr. The file is created if it does not exist, including missing parent directories, and is truncated at the start of each run — use a build-specific path if you need to keep logs from several runs.

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

Each line in the file is the log message prefixed with an ISO 8601 timestamp:

2026-04-24T18:42:00.123Z [DEBUG] <message>

Debug, warning, and error lines carry a [DEBUG], [WARN], or [ERROR] tag; info lines carry none. When --log-file is set, every envelope includes a Log field with the file path.

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 subcommands do not define their own --log-level. Commands that take an output path define -o, --output <path>; the CLI reads --output as the global option only when its value is one of the format names, so the two do not collide.

Exitcodes

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

Überschreibungen von Umgebungsvariablen

These environment variables change global-option behavior without a 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	Set to 1 or true to print a per-invocation timing line on every uip command. Refer to Command timings below.
UIP_TIMINGS_FILE	Path of a file to append the timing line to, instead of writing it to stderr. Read only when UIP_TIMINGS is on.

Befehlszeiträume

Set UIP_TIMINGS=1 (or true) and every invocation prints one line to stderr (or to the --log-file file, when one is set):

[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.

To keep the report off stderr without moving the rest of the log stream, set UIP_TIMINGS_FILE to a file path. Each invocation appends its line to that file, so several runs can share one file. Only the values 1 and true turn the report on; any other UIP_TIMINGS value leaves it off.

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.