Options globales

Options globales acceptées par chaque invocation `uip`, couvrant le format de sortie, le filtre de sortie, le niveau de journalisation et le fichier journal.

Chaque uip invocation est pré-analysée pour un ensemble fixe d'options globales avant qu'un outil ou une sous-commande ne voie ses arguments — elles peuvent apparaître n'importe où sur la ligne de commande, fonctionner de manière identique dans chaque outil et sont supprimés avant l'analyse des indicateurs par commande s'exécute.

Option	Short	Valeur (Value)	Default	Objectif
--output	—	table, json, yaml, plain, markdown	json	Format de la sortie principale écrite sur stdout.
--json	—	Drapeau	—	Alias de compatibilité masqué pour --output json. Le transmettre avec un --output <value> explicite est un conflit - voir ci-dessous.
--output-filter	—	Expression JMESPath	—	Post-filtrage appliqué à la charge utile JSON avant le formatage.
--log-level	—	debug, info, warn, error	info	Détail des messages de journal écrits dans stderr (et --log-file si défini).
--log-file	—	Chemin d'accès	—	Si cette option est définie, les journaux sont dupliqués dans ce fichier au format de lignes JSON.
--profile	—	name	—	Sélectionne un profil de connexion nommé et enregistré au lieu de l'emplacement des informations d'identification par défaut. mutuellement exclusif avec le propre -f, --file <folder> d'une commande (par exemple sur uip login, uip login tenant list/set, uip logout) — la transmission des deux est un ValidationError. Voir Sessions et informations d’identification.
--interactive / --no-interactive	—	Drapeau	auto (invite uniquement sur un service TType)	Forcer l’activation ou la désactivation de l’invite, remplaçant l’invite « UiPath » par défaut uniquement en cas de connexion à un « TType » comportement. Non spécifique à une seule commande - elle régit chaque endroit où une commande uip poserait autrement une question (par exemple la sélection du locataire pendant uip login, ou le sélecteur d'agent/de cible lors de uip skills install).

--version (-v) et --help (-h) sont également reconnus sur uip et chaque sous-commande, mais il s'agit de conventions CLI standard plutôt que d'indicateurs globaux au sens ci-dessus.

--sortie

Choisissez le format de sortie. --output json et --output=json fonctionnent; les valeurs sont sensibles à la casse.

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 (par défaut) — un document JSON sur stdout. Analysable par jq, --output-filter et tout consommateur JSON. Il s'agit de la valeur par défaut pour chaque invocation, que le terminal soit un Tty.
• table — tableau colorée à bordures adapté à la lecture dans un terminal. Non stable entre les versions, ne l’analysez pas.
• yaml — Sérialisation YAML de la même structure que json
• plain — lignes plates key=value . Utile pour les pipelines dans le shell read, grep et cut sans installer jq
• markdown — une table GPM pour une liste ou **key:** value lignes pour un seul enregistrement. Destiné à une sortie uip de lecture d'agent ou d'interface de chat, et non à une session de terminal. Voir Formats de sortie - Markdown pour le comportement complet.

Remarque :

La valeur par défaut est json, et non table. Lorsqu'un humain exécute uip or folders list dans un terminal, un document JSON s'affiche sur stdout. Transmettez --output table explicitement (ou ajoutez-le à un alias shell) pour améliorer la vue. Ce choix conserve la même forme stdout dans un terminal et dans un pipeline - les scripts n'ont pas besoin de se soucier s'ils s'exécutent de manière interactive.

--json (alias masqué)

--json est un alias de compatibilité masqué pour --output json — il n'apparaît pas dans --help, mais il est entièrement fonctionnel:

uip or folders list --json   # identical to --output json

La transmission de --json avec un --output <value> explicite (toute valeur, y compris json) est signalée comme un conflit en interne; éviter de les combiner — transmettez l'une ou l'autre.

-- profil

Sélectionnez un profil de connexion nommé et enregistré au lieu de l’emplacement des informations d’identification par défaut:

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> et le -f, --file <folder> d'une commande sont mutuellement exclusifs; la transmission des deux échoue avec ValidationError: option '--profile' cannot be used with option '--file'. Les noms de profil sont normalisés (des règles de casse et de séparation s'appliquent); un nom non valide est rejeté avant tout appel réseau. Voir Sessions et informations d’identification — Profils nommés.

--interactive / --no-interactive

Remplacer l’invite « UiPath » par défaut uniquement lorsque stdout est un « TType »; Comportement:

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 définit l'invite sur Toujours activée; --no-interactive l'empêche. Aucun indicateur n'est spécifique à uip login - bien qu'apparaissant dans les exemples de connexion tout au long de cet ensemble de documentation, l'interactivité est une option globale croisée sans forme courte spécifique à la commande (il n'y a pas --it ou d'alias similaire n'importe où dans la CLI).

Séparation des flux

--output contrôle uniquement le stdout. Les journaux, les indicateurs de progression et les erreurs liées à un humain sont transmis à stderr, quel que soit leur format. Cela signifie qu'un pipeline peut capturer un fichier JSON propre avec:

uip or folders list > folders.json 2> uip.log

…et toujours consulter la sortie du journal séparément.

--filtre-sortie

Appliquez une expression JMESPath à la charge utile JSON avant le formatage. Le filtre s'exécute sur l'enveloppe de réponse complète: Data[*].Name sélectionne donc les noms dans le tableau Data , length(Data) renvoie un nombre, etc.

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

Combinaison avec --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

Une expression de filtre mal formée échoue rapidement avec un ValidationError et quitte le code 3 avant que la commande sous-jacente ne s'exécute - pour qu'une faute de frappe ne consomme pas d'appel d'API.

Astuce :

--output-filter est la version pour la CLI de --query pour la CLI Azure, --query pour la CLI AWS et de --filter/--format pour gcloud. Si vous connaissez déjà JMESPath de ces outils, la syntaxe est identique.

--niveau-Journalisation

Définissez la description textuelle des messages de journal (écrits dans stderr et sur --log-file si fourni).

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

Les valeurs ne sont pas sensibles à la casse. Les valeurs inconnues sont ignorées en mode silencieux (la valeur par défaut est conservée) plutôt que de générer des erreurs — intentionnellement, de sorte qu'une faute de frappe dans un script de wrapper n'interrompt pas un pipeline.

La variable d’environnement UIPATH_LOG_LEVEL n’est pas respectée; transmettez l'indicateur ou définissez-le dans un script de profil.

--log-file

Écrivez une copie du flux de journal dans le fichier spécifié, au format de lignes JSON (un objet JSON par ligne). Le fichier est ajouté — utilisez un chemin spécifique au build si vous avez besoin de journaux distincts par exécution.

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

Chaque ligne du fichier ressemble à:

{"time":"2026-04-24T18:42:00.123Z","level":"info","message":"CLI v1.0.0 starting — output=json, logLevel=info, logFile=./uip.log"}

Ce format est conçu pour les expéditeurs de journaux et pour l'analyse post- garantir.

Lorsque les options globales s'appliquent

Les options globales sont supprimées de la ligne de commande avant que les indicateurs par commande ne soient analysés, de sorte qu'ils peuvent apparaître n'importe où sur la ligne de commande:

uip --output table or folders list
uip or --output table folders list
uip or folders list --output table
uip or folders list --output=table

Les quatre invocations sont équivalentes.

Les sous-commandes d'outils ne définissent pas leurs propres --output ou --log-level. Un outil qui en définissait une par inadvertance ombrerait l'indicateur global — les vérifications de charge de la CLI interdisent cela.

Codes de sortie

Sortie de contrôle des options globales et journalisation uniquement; elles n'affectent pas les codes de sortie. Voir Codes de sortie.

Remplacements des variables d'environnement

Deux variables d'environnement modifient le comportement d'option globale sans indicateur:

Variable	Effet
UIP_DEFAULT_OUTPUT	Remplace la valeur par défaut json intégrée pour --output lorsque l'indicateur n'est pas transmis. Accepte table, json, yaml, plain ou markdown; les valeurs non valides sont ignorées. Un --output explicite sur la ligne de commande l'emporte toujours.
UIP_TIMINGS	Définissez sur 1 ou true pour imprimer une ligne de synchronisation par invocation sur stderr pour chaque commande uip. Voir Synchronisations des commandes ci-dessous.

Horodatages des commandes

Définissez UIP_TIMINGS=1 (ou true) et chaque invocation imprime une ligne sur stderr:

[timing] 'uip or assets list' exit=0 total=1250ms startup=380ms command=863ms http=691ms httpCalls=3 flush=7ms

Champ	Signification
(la commande entre guillemets)	La commande telle qu'elle est saisie.
exit	Le code de sortie renvoyé par l’invocation.
total	Heures totales, mesurées à partir du début du processus.
startup	Tout avant l’exécution du gestionnaire de commandes: démarrage du processus, configuration, chargement de l’outil.
command	Le gestionnaire de commandes lui-même.
http	Durée additionnée des appels HTTP sortants de l'exécution — une somme, pas une horloge. Elle chevauche command plutôt que de s’ajouter à celle-ci, de sorte que les appels parallèles peuvent la rendre supérieure à command.
httpCalls	Combien d'appels HTTP sortants cette somme couvre.
flush	Tout après le retour du gestionnaire - la comptabilité de la télémétrie et le nettoyage final.

startup + command + flush est toujours égal à total. Les champs sont omis lorsqu'ils ne s'appliquent pas: une exécution qui n'atteint jamais un gestionnaire (uip --version, une commande inconnue) imprime uniquement total et exit; une commande qui n'effectue aucun appel HTTP n'a ni http ni httpCalls.

Le rapport a son propre commutateur, — il ne dépend pas de --log-level, vous obtenez donc des durées sans activer la sortie de débogage, et stdout n'est jamais modifié.

Voir également

• Formats de sortie (table, JSON, YAML) — couverture plus approfondie avec des exemples complets de chaque format.
• Modèles de script — codes de sortie, séparation des flux, nouvelles tentatives, interrogation.
• référence de connexion uip et d'autres pages de commande - documentent leurs indicateurs par commande en plus de ces globales.