Comment la UiPath CLI est organisée

UiPath CLI est assemblee à partir d'un petit hôte, d'un ensemble d'outils et de quelques services croisés. La compréhension de l’intégration des éléments facilite le raisonnement. Cette page est une carte à un seul paragraphe de chaque couche, avec des liens vers la page qui va en profondeur.

L'hôte

L'hôte est le package npm @uipath/cli , invoqué via la commande uip que npm install -g place sur votre PATH. Il s'agit d'un programme de ligne de commande léger qui possède:

• Analyse d'arguments et options globales, y compris le contrat à quatre indicateurs: --output, --output-filter, --log-level, --log-file Les options globales sont retirées d'argv avant que la sous-commande d'un outil ne voie les arguments, de sorte que les outils ne puissent pas les ombres accidentellement.
• Authentification et gestion des sessions via trois flux (OAuth2 interactif, Application externe, env-var). Voir Sessions et informations d’identification.
• Configuration via les variables d'environnement et les indicateurs par commande. Voir Configuration.
• Cycle de vie de l’outil via uip tools install / update / uninstall / list / search. Voir Outils.
• Cycle de vie des compétences via uip skills install / update / uninstall. Orchestrator des outils. Voir Compétences.
• Remplissage du shell via uip completion .
• Le pont du protocole de contexte du modèle via uip mcp, pour les clients compatibles MCP.
• Journalisation, télémétrie, formatage de sortie et enveloppe JSON — les services de runtime que chaque commande utilise pour produire une sortie cohérente.

L’hôte est publié en tant que @uipath/cli sur npm. Sa cadence de publication est indépendante des outils.

Outils

Chaque interface UiPath — Orchestrator, Solutions, Agents, Flux, Maestro, RPA, Test Manager, Integration Service, Data Fabric, Insights, Traces, DocsAI, API Workflow, Solutions verticales, Agents codés, Apps codées — est un package npm distinct sous le @uipath/ étendue. L'hôte maintient une liste blanche d'installation automatique de ces packages et les installe lors de la première utilisation. Les outils sont chargés paressiquement; une nouvelle installation n'a aucun outil sur le disque.

Les versions de l’outil suivent la ligne MAJOR.MINIOR de l’hôte par défaut, de sorte que la mise à niveau de la CLI et l’exécution de uip tools update mettent l’ensemble de la chaîne d’outils en étape.

Voir Outils pour la référence complète des outils du modèle et uip pour la commande. Le comportement d'installation automatique sans refus est couvert dans Installation de la UiPath CLI sous « Contrôle de l'installation automatique de l'outil ».

Compétences

Les compétences sont un mécanisme d'extension parallèle destiné aux agents de codage d'IA, et non à l'interface de commande. uip skills install --agent <name> écrit un catalogue d'instructions spécifiques à UiPath dans Claude Code, Cursor, GitHub Copilot, Gemini CLI, Coded ou OpenCode. L'agent lit ces instructions pour savoir comment utiliser uip pour les tâches UiPath courantes — compresser une solution, déployer un agent, exécuter un ensemble de test, etc.

Les compétences et les outils sont indépendants. Les outils ajoutent des commandes; Les compétences apprennent aux agents à utiliser les commandes. L'installation d'outils n'installe pas de compétences, et vice versa. Voir Compétences.

Sessions et informations d’identification

uip login établit une session — une organisation, un locataire et une paire de jetons d'accès/actualisation — et la persiste dans un dossier .uipath/ . La CLI résout le dossier en remontant le répertoire actuel, et revient à ~/.uipath/ si aucun dossier local du projet n'est trouvé. Les jetons sont actualisés en mode silencieux jusqu'à ce que le jeton d'actualisation expire ou soit révoqué.

Un troisième flux d’authentification contourne entièrement l’état sur disque: avec UIPATH_CLI_ENABLE_ENV_AUTH=true, la CLI lit le jeton + le locataire + l’organisation à partir des variables d’environnement à chaque invocation, ce qui est adapté aux conteneurs et aux exécuteurs éphémères. Voir Sessions et informations d’identification et Authentification.

Codes de sortie et de sortie

Chaque commande génère une seule enveloppe structurée au niveau de stdout. Quatre formats — json (par défaut), table, yaml, plain — rendent la même enveloppe différemment. Le champ Result de l'enveloppe correspond à un ensemble restreint de codes de sortie (0 / 1 / 2 / 3 / 4 + 130 pour l'annulation de l'utilisateur) auxquels les scripts peuvent se ramifier sans analyser les chaînes.

Le paramètre Stdout est réservé pour l'enveloppe. Les journaux, les indicateurs de progression et le texte d'erreur lisible par un humain sont toujours dirigés vers stderr, afin que les pipelines puissent rediriger les deux flux indépendamment.

Voir Formats de sortie, Codes de sortie et Modèles de script.

Journalisation et télémétrie

Les journaux sont des lignes JSON structurées. Ils passent à stderr par défaut et, avec --log-file <path>, sont dupliqués dans un fichier permettant aux expéditeurs de journaux de le récupérer. --log-level contrôle l'élément textuel (debug / info / warn / error).

La télémétrie est des données d'utilisation anonymes envoyées à l'application Insights d'UiPath. Il peut être désactivé avec UIPATH_TELEMETRY_DISABLED=1 ou redirigé avec UIPATH_AI_CONNECTION_STRING Aucun argument de commande, aucun contenu de fichier ou aucune information d’identification n’est transmis.

Consultez Configuration et la section Télémétrie de l'installation de UiPath CLI.

L'interface de commande complète

uip <core-command> …                  # login, logout, tools, skills, mcp, completion
uip <tool-alias> <verb> [options]     # single-workflow tools (solution, agent, flow, maestro, rpa, codedagent, codedapp, api-workflow, vss)
uip <tool-alias> <resource> <verb>    # resource-first tools (or, tm, resource)
uip <tool-alias> [options]            # flat wrappers (df, insights, traces, docsai, is)

Trois formes, une grammaire. La page de référence de chaque outil documente les verbes et indicateurs exacts; chaque outil hérite des mêmes options globales et de la même enveloppe.

Exécution d'une commande

La séquence d'une invocation uip or folders list , à un niveau élevé:

1. Analysez les options globales. L'hôte supprime --output, --output-filter, --log-level, --log-file d'arguments et configure le runtime.
2. Résolvez l’outil. or correspond à la liste blanche. Si @uipath/orchestrator-tool n’est pas encore installé, l’installation automatique s’exécute. Sinon, l’outil est chargé dynamiquement.
3. L’outil enregistre les sous-commandes. L'hôte apprend uip or folders list et d'autres sous-commandes Orchestrator.
4. Résolvez l’authentification. L’outil demande la session à l’hôte. L'hôte le récupère à partir d'un dossier .uipath/ , de l'authentification env-var, ou échoue rapidement avec le code de sortie 2 si rien n'est disponible.
5. Résoudre la configuration. Les variables d'environnement et les indicateurs sont réconciliés par la chaîne de priorité.
6. Exécutez le verbe. L'outil appelle Orchestrator avec la session et la configuration résolues, puis envoie l'enveloppe via le formateur de l'hôte.
7. Quitter. L'hôte traduit le Result de l'enveloppe en code de sortie de processus.

Rien dans cette séquence n’est spécifique à Orchestrator. Chaque appel uip <tool> … suit la même forme, ce qui rend les scripts portables entre les outils.

Voir également

• Outils (extensions) : le modèle de plug-in en détail.
• Compétences — le mécanisme d'extension parallèle pour les agents d'IA.
• Sessions et informations d’identification — où se trouve le dossier d'informations d'identification et comment il est résolu.
• Configuration — fichiers, variables d'environnement et priorité.
• Formats de sortie, codes de sortie, options globales — le contrat de runtime.