Formats de sortie

Formats de sortie dans la UiPath CLI, couvrant l'enveloppe structurée émise par chaque commande au format JSON, table, YAML et rendus bruts.

Chaque commande uip génère une seule enveloppe structurée au niveau de stdout. L'enveloppe a le même schéma, que ce soit dans un terminal, dans jq ou dans un pipeline. Cinq formats rendent cette enveloppe différemment: json (par défaut), table, yaml, plain et markdown. Basculez entre elles avec --output et filtrez avec --output-filter.

L'enveloppe

Réussite:

{
  "Result": "Success",
  "Code": "FolderList",
  "Data": [
    {
      "Key": "9f2b3c…-…",
      "Name": "Shared",
      "Path": "Shared",
      "Type": "Standard"
    }
  ]
}

Échec:

{
  "Result": "ValidationError",
  "Message": "Unknown option '--folder-pth'. Did you mean '--folder-path'?",
  "Instructions": "Run 'uip or folders list --help' to see valid options.",
  "ErrorCode": "invalid_argument",
  "Retry": "RetryWillNotFix",
  "Log": "/var/log/uip/2026-04-24.log"
}

Champs :

• Result — la catégorie du résultat. Success en cas de réussite; Failure, ConfigError, AuthenticationError, ValidationError, ou TimeoutError en cas d'échec. Mappe directement au code de sortie.
• Code — l'identifiant de réussite spécifique à la commande. Stable dans une version majeure (FolderList, SolutionPack, JobStarted, SkillsInstall, etc.).
• Data — la charge utile de la commande. La forme est spécifique à la commande; voir la page de référence de chaque commande pour les champs exacts.
• Message, Instructions — présent à l'échec. Message est l'erreur lisible par un humain; Instructions indique à l’utilisateur ou à l’opérateur quoi faire.
• ErrorCode — présent à chaque échec. Une taxonomie stable et indépendante des commandes pour les scripts qui ont besoin d'une ramification plus précise que le code de sortie seul: invalid_argument, authentication_required, permission_denied, local_permission_denied, not_found, rate_limited, network_error, timeout, server_error, method_not_allowed, configuration_error, unknown_error.
• Retry — présent à chaque échec. Indique si une nouvelle tentative en vaut la peine et à quel moment: RetryWillNotFix, RetryLater, RetryAfter1Second, RetryAfter10Seconds, RetryAfter30Seconds, RetryAfter60Seconds.
• Context — détails facultatifs de l'échec (statut HTTP, ID de requête, etc.).
• Warning — optional non-fatal note, for example when --output-filter returned nothing from the records it read.
• Log — lorsque --log-file est actif, le chemin d'accès au fichier journal, inclus dans chaque enveloppe.

ErrorCode et Retry sont remplis automatiquement à chaque échec, même lorsqu'une commande ne les définit pas explicitement. Consultez Modèles de scripts — réessayez sur Retry pour savoir comment ramifier sur eux au lieu d'analyser le texte Message .

L'enveloppe elle-même est stable entre les versions mineures. La forme de Data est spécifique aux commandes et peut évoluer — voir Contrôle des versions et stabilité.

Les cinq formats

json (par défaut)

uip or folders list

{
  "Result": "Success",
  "Code": "FolderList",
  "Data": [
    { "Key": "9f2b3c…", "Name": "Shared", "Path": "Shared", "Type": "Standard" },
    { "Key": "a4b8f1…", "Name": "Finance", "Path": "Finance", "Type": "Standard" }
  ]
}

Par défaut, car il est analysable par n’importe quel consommateur JSON (jq, --output-filter, scripts, agents d’IA) et déterministe entre les versions. Dans un terminal, elle se lit correctement; pour une table plutôt imprimée, passez à --output table.

Table

uip or folders list --output table

Key         Name       Path      Type
9f2b3c…     Shared     Shared    Standard
a4b8f1…     Finance    Finance   Standard

Couleurs et bordures dans un terminal réel (les couleurs sont supprimées lorsque stdout n'est pas un GMT). Chaque commande sélectionne les colonnes qu'elle juge les plus utiles pour la vue de la table - tous les champs de Data ne sont pas nécessairement affichés. Pour l’ensemble de champs complet, utilisez JSON ou YAML.

N’analysez pas la sortie de la table. La largeur des colonnes, les bordures et même l'ensemble des colonnes peuvent changer d'une version mineure à l'autre. Il est destiné à la lecture humaine uniquement.

YAML

uip or folders list --output yaml

Result: Success
Code: FolderList
Data:
  - Key: 9f2b3c…
    Name: Shared
    Path: Shared
    Type: Standard
  - Key: a4b8f1…
    Name: Finance
    Path: Finance
    Type: Standard

Une sérialisation YAML littérale de la même enveloppe que json. Utile si votre outil préférez YAML (Ansible, manifestes Kubernetes, certaines plates-formes CI) ou si vous comparez deux exécutions à l’œil et que vous trouvez YAML plus facile à analyser.

plain

uip or folders list --output plain

Data[0].Key=9f2b3c…
Data[0].Name=Shared
Data[0].Path=Shared
Data[0].Type=Standard
Data[1].Key=a4b8f1…
Data[1].Name=Finance
Data[1].Path=Finance
Data[1].Type=Standard

Un path=value par ligne. Le chemin d'accès est une clé de type JMESPath à notation par points dans l'enveloppe. Pratique pour les boucles shell sur les machines qui n'ont pas jq:

uip or folders list --output plain | grep -E '\.Name=' | cut -d= -f2

Markdown

uip or folders list --output markdown

| Key | Name | Path | Type |
| --- | --- | --- | --- |
| 9f2b3c… | Shared | Shared | Standard |
| a4b8f1… | Finance | Finance | Standard |

Rend l'enveloppe sous la forme d'une syntaxe Markdown GitHub — une table pour une liste d'enregistrements, ou **key:** value lignes et des sections d'en-tête imbriquées pour un seul enregistrement. Destiné à un agent ou à une surface de chat lisant la sortie uip via un shell, et non pour une session de terminal humain: une commande qui renvoie déjà un prose (par exemple uip rpa validate) le passe via un élément textuel au lieu d’une chaîne JSON échappée. En cas d'échec, le format renvoie **Failed:** <Message> suivi de Data et Instructions.

Filtrer avec --output-filter

--output-filter accepts a JMESPath expression. It runs on the envelope's Data field before formatting, and its result replaces Data; the other envelope fields stay in place. The filter output inherits whichever format --output produces.

Quelques schémas courants:

# project specific fields
uip or folders list --limit 50 --output-filter "[*].{Name: Name, Path: Path}"

# count
uip or folders list --limit 50 --output-filter "length(@)"

# first match
uip or folders list --limit 50 --all --name Shared --output-filter "[0]"

# flat list of names
uip or folders list --limit 50 --output-filter "[*].Name" --output plain

A malformed expression exits with ValidationError (exit code 3) before the command runs, so a typo does not waste an API call. When a filter returns nothing from records that were there, the envelope carries a Warning field naming the fields that do not exist. On failure, the filter applies to the failure's Data only. Refer to Global options — --output-filter for the full flag.

Séparation des flux

--output contrôle uniquement le stdout. Toutes les autres formes de sortie sont transmises à stderr, quel que soit leur format:

• Lignes de journal (ce que --log-level contrôle).
• Indicateurs de progression (fileurs, barres de téléchargement lors de l'installation automatique de l'outil).
• Texte d'erreur rendu par l'hôte lorsqu'il détecte un indicateur non valide.

Cela signifie qu'un pipeline peut capturer la sortie propre d'un fichier sans perdre les diagnostics:

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

Dans CI, redirigez-les séparément pour rendre les journaux exploitables sans avoir à supprimer les artefacts ANSI ou de progression du flux de données.

Détection des couleurs et des Tty

Le format table génère des codes couleur ANSI lorsque stdout est un terminal interactif (isTTY). Lorsque vous dirigez un pipeline vers un fichier ou un autre processus, ou lorsque vous l'exécutez dans un runtime CI qui désactive TTY, la sortie de la table est du texte brut sans codes d'échappement par défaut.

Deux variables d'environnement remplacent la détection automatique TType:

Variable	Effet
NO_COLOR	Toute valeur entraîne la déconnexion de la couleur, même sur un cadenas.
FORCE_COLOR	Force la couleur activée, même lorsque stdout n'est pas un TTY — utile lorsqu'une visionneuse de journaux CI renvoie les codes ANSI et que vous voulez quand même la table de couleur.

Les autres formats (json, yaml, plain) n'émettent jamais de couleurs.

Remplacer le format par défaut

La valeur --output est définie par défaut sur json lorsqu'elle est omise. Définissez UIP_DEFAULT_OUTPUT pour modifier la valeur par défaut du shell actuel sans transmettre --output à chaque commande:

export UIP_DEFAULT_OUTPUT=table
uip tools list                  # → table

uip tools list --output yaml   # --output still wins → yaml

Accepte table, json, yaml, plain ou markdown; une valeur non valide est ignorée et la valeur par défaut json intégrée est conservée.

Choix d’un format

Use case	Format recommandé
Lire dans un terminal	--output table
Scripts (jq, pipelines shell)	--output json (par défaut)
Intégration Ansible / Kubernetes	--output yaml
grep- sortie plate conviviale sans jq	--output plain
Agents de codage d’IA	--output json (par défaut) avec --output-filter pour une extraction ciblée, ou --output markdown pour un rendu lisible par chat
Pipelines CI qui transmettent des valeurs entre les étapes	--output json avec --output-filter, ou --output plain pour les cas simples

Voir également

• Options globales — les indicateurs --output, --output-filter, --log-level et --log-file .
• Codes de sortie — mappage de Result au code de sortie du processus.
• Modèles de script — réessais, interrogation et extraction JSON sécurisée dans CI.
• Contrôle des versions et stabilité — ce que signifie une « enveloppe JSON stable» sous semper.