Configuration UIP

Syntaxe et options pour `uip config`, qui lit, définit et efface les préférences de configuration CLI stockées dans config.json.

uip config lit et écrit le fichier de configuration local de la CLI — les valeurs par défaut sont le format de sortie, le niveau de journalisation et la politique de version/canal de mise à jour qui régit uip update et uip tools update. Le fichier est découvert en remontant du répertoire actuel vers $HOME à la recherche de .uipath/config.json, et en revenant en arrière vers ~/.uipath/config.json si aucun n’est trouvé; --config-file remplace la découverte pour n'importe quel verbe.

Synthèse

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

Tous les verbes uip config respectent les options globales (--output, --output-filter, --log-level, --log-file). Les codes de sortie suivent le contrat standard.

Configuration des clés

Clé (Key)	Valeurs valides	Inscriptible	Description
output	table, json, yaml, plain, markdown	oui	Format de sortie par défaut pour les commandes CLI.
logLevel	error, warn, info, debug	oui	Niveau de journalisation par défaut.
interactive	never, auto, always	oui	Lorsque la CLI peut afficher des invites interactives. La valeur par défaut est auto.
updateChannel	stable, preview (dev est accepté mais non annoncé)	oui	Canal de publication utilisé pour résoudre les mises à jour d’outils.
version	major.minor ou major.minor.patch (par ex. 1.2 ou 1.2.3)	oui	Politique de version: un major.minor.patch exact bloque entièrement la mise à jour automatique; une ligne major.minor suit cette ligne; non défini suit la dernière version.
clientSecret	—	non	Clé secrète de client d'application externe utilisée par uip login. En lecture seule à partir de uip config — définissez-le via uip login --client-secret env.NAME afin que le secret reste dans une variable d'environnement et le fichier d'authentification, jamais dans config.json.

Deux anciennes clés, autoVersionSync et versionSource, avaient été supprimées lorsque la stratégie de version était réduite à version + updateChannel. L'exécution de uip config set autoVersionSync ... ou versionSource ... échoue désormais avec Unknown config key, et le message d'erreur vous dirige vers l'équivalent version/updateChannel.

Obtenir la configuration de l’uip

Obtenez une valeur de configuration ou la configuration complète lorsqu'aucune clé n'est fournie.

Arguments

Nom	Requis	Objectif
[key]	non	L'une des clés de configuration ci-dessus. Omettez pour afficher l'intégralité du fichier de configuration.

Options

• -c, --config-file <path> — chemin d'accès à un fichier de configuration spécifique, remplacement de la découverte.

Exemples

uip config get output

# Show everything
uip config get

Format des données (--sortie json)

Clé unique:

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

Une clé sans valeur définie renvoie Value: "-". clientSecret (et toute autre clé secrète) renvoie toujours <redacted>, jamais la valeur réelle.

Aucune clé — le fichier complet, les secrets caviardés:

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

ConfigGet et ConfigList sont des valeurs Code distinctes, de sorte qu'un consommateur JMESPath voit une forme stable par Code plutôt qu'un champ Data qui change de forme selon que key est défini ou non.

Ensemble de configurations uip

Définissez une valeur de configuration.

Arguments

Nom	Requis	Objectif
<key>	oui	Une clé de configuration inscriptible (toutes les clés ci-dessus à l'exception de clientSecret).
<value>	oui	La nouvelle valeur. Validé par rapport aux valeurs autorisées de la clé, lorsqu'elle en contient une.

Options

• -c, --config-file <path> — chemin d'accès à un fichier de configuration spécifique, remplacement de la découverte. Le fichier est créé s’il n’existe pas déjà.

Exemples

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

Format des données (--sortie json)

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

La tentative de définition de clientSecret échoue avec ValidationError vous pointant vers uip login --client-secret env.NAME à la place. Une valeur non valide pour une clé énumérée (par exemple uip config set output csv) échoue avec ValidationError et répertorie les valeurs valides.

Effacer la configuration de l’uip

Supprimer une valeur de configuration Une exception (pas une erreur) si la clé n'a jamais été définie.

Arguments

Nom	Requis	Objectif
<key>	oui	Une clé de configuration inscriptible.

Options

• -c, --config-file <path> — chemin d'accès à un fichier de configuration spécifique, remplacement de la découverte.

Exemples

# 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

Format des données (--sortie json)

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

Status est "Not set" au lieu de "Cleared" lorsque la clé n'avait aucune valeur à supprimer.

Associé

• mise à jour uip — config get version / config set version régissent la ligne par laquelle uip update et uip tools update se résolvent.
• outils uip — installations/mises à jour d'outils lisent les mêmes clés version et updateChannel .
• uip pull — définit les informations d'identification en dehors de config.json; clientSecret est ici en lecture seule pour une raison.

Voir également

• Options globales
• Codes de sortie