UIP-Konfiguration

Syntax und Optionen für „uip config“, die in config.json gespeicherte CLI-Konfigurationseinstellungen liest, festlegt und löscht.

uip config liest und schreibt die lokale Konfigurationsdatei der CLI – Standardeinstellungen wie das Ausgabeformat, die Protokollebene und die Versions-/Updatekanal-Richtlinie, die uip update und uip tools update regelt. Die Datei wird erkannt, indem Sie vom aktuellen Verzeichnis zu $HOME auf der Suche nach .uipath/config.json gehen und auf ~/.uipath/config.json zurückgreifen, wenn keines gefunden wird; --config-file überschreibt die Erkennung für jedes Verb.

Zusammenfassung

uip config get [key] [-c <path>]
uip config set <key> <value> [-c <path>]
uip config clear <key> [-c <path>]

Alle uip config -Verben berücksichtigen die globalen Optionen (--output, --output-filter, --log-level, --log-file). Austrittscodes folgen dem Standardvertrag.

Konfigurationsschlüssel

Schlüssel	Gültige Werte	Beschreibbar	Beschreibung
output	table, json, yaml, plain, markdown	ja	Standardausgabeformat für CLI-Befehle.
logLevel	error, warn, info, debug	ja	Standardprotokollebene.
interactive	never, auto, always	ja	Wenn die CLI interaktive Prompts anzeigen kann. Die Standardeinstellung ist auto.
updateChannel	stable, preview (dev wird akzeptiert, aber nicht angegeben)	ja	Release-Kanal, der zum Auflösen von Toolaktualisierungen verwendet wird.
version	major.minor oder major.minor.patch (z. B. 1.2 oder 1.2.3).	ja	Versionsrichtlinie: Ein exaktes major.minor.patch friert die automatische Aktualisierung vollständig ein; eine major.minor -Zeile verfolgt diese Zeile; Unset folgt der neuesten Version.
clientSecret	–	nein	Geheimer Schlüssel des externen App-Clients, der von uip login verwendet wird. Schreibgeschützt von uip config – Legen Sie es über uip login --client-secret env.NAME fest, sodass das Geheimnis in einer Umgebungsvariablen und der Authentifizierungsdatei bleibt, niemals in config.json.

Zwei ältere Schlüssel, autoVersionSync und versionSource, wurden entfernt, als die Versionsrichtlinie auf version + updateChannel reduziert wurde. Die Ausführung von uip config set autoVersionSync ... oder versionSource ... schlägt jetzt mit Unknown config key fehl und die Fehlermeldung leitet Sie zu dem Äquivalent version/updateChannel weiter.

UIP-Konfiguration abrufen

Rufen Sie einen Konfigurationswert oder die vollständige Konfiguration ab, wenn kein Schlüssel angegeben ist.

Argumente

Name	Erforderlich	Zweck
[key]	nein	Einer der oben genannten Konfigurationsschlüssel. Lassen Sie es aus, um die gesamte Konfigurationsdatei anzuzeigen.

Optionen

• -c, --config-file <path> – Der Pfad zu einer bestimmten Konfigurationsdatei, der die Erkennung überschreibt.

Beispiele

uip config get output

# Show everything
uip config get

Datenform (--output json)

Einzelner Schlüssel:

{
  "Code": "ConfigGet",
  "Data": { "Key": "output", "Value": "table" }
}

Ein Schlüssel ohne festgelegten Wert gibt Value: "-" zurück. clientSecret (und jeder andere geheime Schlüssel) gibt immer <redacted> zurück, niemals den echten Wert.

Kein Schlüssel – die vollständige Datei, Geheimnisse zensiert:

{
  "Code": "ConfigList",
  "Data": {
    "Config": {
      "core": { "output": "table", "logLevel": "info", "updateChannel": "stable" },
      "auth": { "clientId": "client-abc", "clientSecret": "<redacted>" }
    }
  }
}

ConfigGet und ConfigList sind unterschiedliche Code -Werte, sodass ein JMESPath-Verbraucher eine stabile Form pro Code anstelle eines Data -Felds sieht, das seine Form ändert, je nachdem, ob key übergeben wurde.

UIP-Konfiguration festgelegt

Legen Sie einen Konfigurationswert fest.

Argumente

Name	Erforderlich	Zweck
<key>	ja	Ein beschreibbarer Konfigurationsschlüssel (alle oben genannten Schlüssel außer clientSecret).
<value>	ja	Der neue Wert. Validiert anhand der zulässigen Werte des Schlüssels, wenn er einen hat.

Optionen

• -c, --config-file <path> – Der Pfad zu einer bestimmten Konfigurationsdatei, der die Erkennung überschreibt. Die Datei wird erstellt, wenn sie nicht vorhanden ist.

Beispiele

uip config set output table

uip config set updateChannel preview

# Pin the CLI and tools to the 1.196 line (float — tracks patch releases within it)
uip config set version 1.196

# Freeze on an exact patch (no auto-update at all)
uip config set version 1.196.3

Datenform (--output json)

{
  "Code": "ConfigSet",
  "Data": { "Key": "output", "Value": "table", "Status": "Updated" }
}

Der Versuch, clientSecret festzulegen, schlägt fehl, da ValidationError Sie stattdessen auf uip login --client-secret env.NAME verweist. Ein ungültiger Wert für einen Aufzählungsschlüssel (z. B. uip config set output csv) schlägt mit ValidationError fehl und listet die gültigen Werte auf.

UIP-Konfiguration löschen

Entfernen Sie einen Konfigurationswert. Ein No-Op (kein Fehler), wenn der Schlüssel nie festgelegt wurde.

Argumente

Name	Erforderlich	Zweck
<key>	ja	Ein beschreibbarer Konfigurationsschlüssel.

Optionen

• -c, --config-file <path> – Der Pfad zu einer bestimmten Konfigurationsdatei, der die Erkennung überschreibt.

Beispiele

# Un-pin the version so the CLI follows the latest release again
uip config clear version

# Clearing a key that was never set is a no-op
uip config clear updateChannel

Datenform (--output json)

{
  "Code": "ConfigClear",
  "Data": { "Key": "version", "Status": "Cleared" }
}

Status ist "Not set" anstelle von "Cleared", wenn der Schlüssel keinen Wert zum Entfernen hatte.

Zugehörig

• uip update – config get version / config set version regeln, gegen welche Zeile uip update und uip tools update aufgelöst werden.
• uip-Tools – Tool-Installationen/Aktualisierungen lesen dieselben version und updateChannel Schlüssel.
• uip Login – Legt Anmeldeinformationen außerhalb von config.json fest; clientSecret ist hier aus einem bestimmten Grund schreibgeschützt.

Siehe auch

• Globale Optionen
• Exitcodes