Options globales

Quatre options sont reconnues sur chaque uip invocation, indépendamment de l’outil ou de la sous-commande. Ils contrôlent le format de sortie, le filtre de sortie et le flux du journal. Tous les autres indicateurs sont définis par commande.

Option	Short	Valeur (Value)	Default	Objectif
--output	—	table, json, yaml, plain	json	Format de la sortie principale écrite sur stdout.
--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.

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

• 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

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.

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.

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.