UiPath Documentation
uipath-cli
latest
false
Wichtig :
Dieser Inhalt wurde maschinell übersetzt. Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

UiPath-CLI-Benutzerhandbuch

Globale Optionen

Bei jedem uip -Aufruf werden vier Optionen erkannt, unabhängig vom Tool oder Unterbefehl. Sie steuern das Ausgabeformat, den Ausgabefilter und den Protokollstream. Alle anderen Flags werden pro Befehl definiert.

OptionShortWertStandardZweck
--outputtable, json, yaml, plainjsonDas in „stdout“ geschriebene Format der primären Ausgabe.
--output-filterJMESPath-AusdruckNachfilter, der vor der Formatierung auf die JSON-Nutzlast angewendet wurde.
--log-leveldebug, info, warn, errorinfoAusführlichkeit der in Standardr geschriebenen Protokollmeldungen (und --log-file , wenn festgelegt).
--log-filePfadWenn diese Option festgelegt wird, werden Protokolle im JSON-Zeilenformat in dieser Datei dupliziert.

--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                  # 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
  • 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.
  • plainkey=value Zeilen. Nützlich für das Piping in Shell read, grep und cut ohne Installation jq.
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.

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
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}"
# 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
# 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
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
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"}
{"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
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.

Siehe auch

  • --output
  • Stream-Trennung
  • --ausgabefilter
  • --log-Ebene
  • --log-datei
  • Wo globale Optionen gelten
  • Exitcodes
  • Siehe auch

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support

Möchten Sie lernen? UiPath Academy

Haben Sie Fragen? UiPath-Forum

Auf dem neuesten Stand bleiben