Configuration

Référence de la configuration pour la UiPath CLI, couvrant les variables d'environnement, les indicateurs de ligne de commande et les règles de priorité.

La UiPath CLI est configurée via des indicateurs de ligne de commande, des variables d'environnement et un fichier de configuration local. Les indicateurs concernent une seule invocation; les variables d'environnement adaptées aux exécuteurs et aux conteneurs CI; le fichier de configuration contient des valeurs par défaut qui sont conservées entre les invocations sur une même machine (format de sortie, niveau de journalisation et politique de version/canal de mise à jour).

Sources de configuration

Par ordre de priorité, du plus spécifique au plus général:

1. Indicateur de ligne de commande — --tenant, --authority, --client-id, --output, --log-level, etc. Les indicateurs ont priorité sur toutes les autres sources.
2. Variable d'environnement — variables lues par la CLI au moment du runtime (voir Variables d'environnement). La CLI lit chaque variable uniquement aux points documentés; il n'y a pas de règle implicite « chaque indicateur a une homologue env-var».
3. Fichier de configuration — .uipath/config.json, découvert en remontant le répertoire actuel vers $HOME, revenant à ~/.uipath/config.json. Géré via uip config get|set|clear; contient output, logLevel, interactive, updateChannel et version. Voir uip config pour la référence complète de la clé.
4. Valeurs par défaut codées en dur — https://cloud.uipath.com pour l'autorité, json pour le format de sortie, info pour le niveau du journal, taille de page de 50 sur les verbes de la liste.

Variables de l'environnement

Les variables d'environnement sont le principal mécanisme de configuration de la CLI dans les runtimes CI, les conteneurs et les configurations de développeur par shell. Définissez-les dans l'environnement de l'exécuteur (ou dans un fichier .env utilisé par votre exécuteur) et la CLI les lira aux points documentés ci-dessous.

Variable	Lire par	Objectif
UIPATH_URL	uip login, chaque commande authentifiée	Remplacer l’URL de base de l’autorité d’identité. La valeur par défaut est https://cloud.uipath.com.
UIPATH_CLI_ENABLE_ENV_AUTH	Chaque commande authentifiée	Set to literal true to switch the CLI from the file-based credentials flow to environment-variable auth. With this gate on, the CLI reads the access token + tenant + organization from the variables below and bypasses the ~/.uipath/ credentials folder entirely. Refer to Authentication — Flow 4.
UIPATH_CLI_AUTH_TOKEN	env-var flux d'authentification uniquement	Access token: a JWT, or a Personal Access Token. For a JWT, the server URL is derived from the token's iss claim. For a Personal Access Token, which is not a JWT, set UIPATH_URL to the UiPath base URL.
UIPATH_CLI_ORGANIZATION_NAME	env-var flux d'authentification uniquement	Champ de données dynamique de l’organisation.
UIPATH_CLI_ORGANIZATION_ID	env-var flux d'authentification uniquement	UUID de l’organisation.
UIPATH_CLI_TENANT_NAME	env-var flux d'authentification uniquement	Champ de données dynamique du locataire.
UIPATH_CLI_TENANT_ID	env-var flux d'authentification uniquement	UUID du locataire.
UIPATH_TELEMETRY_DISABLED	Initialisation de la télémétrie	Définissez sur 1 ou true pour refuser la télémétrie d'utilisation anonyme.
UIPATH_AI_CONNECTION_STRING	Initialisation de la télémétrie	Remplacez la chaîne de connexion Application Insights.
HTTP_PROXY / http_proxy	Couche réseau	Proxy HTTP pour les demandes sortantes (hôte et outils).
UIPATH_PROXY_INTEGRATED_AUTH	Couche réseau	Set to literal true to authenticate the proxy CONNECT tunnel with Windows Integrated Authentication — Kerberos/Negotiate or NTLM single sign-on. Without the opt-in the CLI supports no-auth and Basic proxies only.
UIPATH_PROXY_USER / UIPATH_PROXY_PASSWORD / UIPATH_PROXY_DOMAIN	Couche réseau	Authenticate the proxy as a specific account rather than the logged-in user. Credentials may also be supplied as user:pass@ in the proxy URL. Supplying them excludes ambient SSO, so a wrong password fails rather than silently falling back.
HTTPS_PROXY / https_proxy	Couche réseau	Proxy HTTPS.
NO_PROXY / no_proxy	Couche réseau	Liste de contournement du proxy.
UIP_DEFAULT_OUTPUT	Formatage de sortie	Remplace la valeur par défaut json intégrée lorsque la valeur --output n’est pas définie. Accepte table, json, yaml, plain ou markdown; un --output explicite sur la ligne de commande l' utilisant toujours.
UIP_TIMINGS	Synchronisation de l'instrumentation	Set to 1 or true to print a per-invocation timing line to stderr (total, startup, command, http/httpCalls, flush). Refer to Global options — Command timings.
UIP_TIMINGS_FILE	Synchronisation de l'instrumentation	Path of a file to append the timing line to instead of stderr. Read only when UIP_TIMINGS is on.
UIPATH_CLI_TOOLS_DIRS	Tool discovery and install	For a host application that embeds the CLI: a list of node_modules/@uipath directories, separated by ; on Windows and : on macOS/Linux. When set, only these directories are searched for tools, the first entry is where uip tools install writes, and the CLI does not update itself.
NO_COLOR	Sortie de terminal	Toute valeur force la couleur dans --output table, remplaçant la détection automatique TType.
FORCE_COLOR	Sortie de terminal	Force la couleur d'activation, même lorsque stdout n'est pas un TType (par exemple la sortie du pipeline que vous souhaitez toujours colorer). Vérifié avant la détection TType, avec NO_COLOR.

Pour les valeurs non secrètes qui varient d’un déploiement à l’autre (locataire, organisation, nom de dossier), transmettez-les en tant que variables dans votre exécuteur CI et référencez-les dans les commandes uip :

env:
  UIPATH_TENANT: Production
  UIPATH_FOLDER: Shared
script:
  - uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant "$UIPATH_TENANT"
  - uip or folders list --all --path "$UIPATH_FOLDER"

Avertissement :

Aucune lecture implicite de UIPATH_CLient_ID /UIPATH_CLient_SECRET

Setting UIPATH_CLIENT_ID and UIPATH_CLIENT_SECRET in the environment alone does not authenticate the CLI. Pass them explicitly using the env.VAR_NAME prefix on --client-id / --client-secret, or use the env-var auth flow above for token-based authentication. Refer to Authentication.

Où chaque paramètre peut être actif

Paramètre	Drapeau	Var d'environnement	Default
Autorité / URL de base	--authority <url>	UIPATH_URL	https://cloud.uipath.com
ID client de l'application externe	--client-id <id>	— (défini via un indicateur avec le préfixe env.VAR_NAME)	aucun
Clé secrète du client de l’application externe	--client-secret <secret>	— (défini via un indicateur avec le préfixe env.VAR_NAME)	aucun
Locataire	--tenant <name> (ou session)	—	depuis la session
Dossier	--folder-path / --folder-key par commande	—	aucun
Format de sortie	--output <format>	—	json
Filtre de sortie	--output-filter <jmespath>	—	aucun
Niveau de journalisation	--log-level <level>	—	info
Fichier journal (Log File)	--log-file <path>	—	aucun
registre npm pour les outils	—	—	.npmrc @uipath:registry (si défini), sinon npm par défaut
Télémétrie	—	UIPATH_TELEMETRY_DISABLED=1	enabled

Les paramètres sans colonne env-var ne peuvent être définis que par commande via des indicateurs.

Exemples de configurations

Exécuteur CI minimum (tout via env)

env:
  UIPATH_URL: https://cloud.uipath.com
  UIPATH_CLIENT_ID: ${{ secrets.UIPATH_CLIENT_ID }}
  UIPATH_CLIENT_SECRET: ${{ secrets.UIPATH_CLIENT_SECRET }}
  UIPATH_TENANT: Production
  UIPATH_TELEMETRY_DISABLED: "1"

steps:
  - run: npm install -g @uipath/cli
  - run: uip tools install @uipath/orchestrator-tool
  - run: uip tools install @uipath/solution-tool
  - run: |
      uip login \
        --client-id env.UIPATH_CLIENT_ID \
        --client-secret env.UIPATH_CLIENT_SECRET \
        --tenant "$UIPATH_TENANT"
  - run: uip or folders list

Conteneur avec un jeton pré-émis (flux d’authentification env-var)

export UIPATH_CLI_ENABLE_ENV_AUTH=true
export UIPATH_CLI_AUTH_TOKEN="$BUILD_TOKEN"
export UIPATH_CLI_ORGANIZATION_NAME=contoso
export UIPATH_CLI_ORGANIZATION_ID="$ORG_UUID"
export UIPATH_CLI_TENANT_NAME=Default
export UIPATH_CLI_TENANT_ID="$TENANT_UUID"

uip or folders list

Aucune étape uip login , aucun fichier écrit. Chaque commande s'authentifie à partir des variables d'environnement.

Voir également

• Authentification — les flux d'authentification et les variables d'environnement que chacun lit.
• Installation de la UiPath CLI — variables proxy, refus de la télémétrie et modèles d'installation CI.
• Sessions et informations d'identification — le dossier .uipath/ Credentials écrit par uip login.
• Options globales — indicateurs qui remplacent les variables d'environnement par invocation.
• uip config — le fichier .uipath/config.json , sa référence complète de clé et les commandes get/set/clear qui le gèrent.