Outils (extensions)

Architecture des outils dans la UiPath CLI, couvrant la façon dont les packages npm installables étendent l'hôte avec de nouvelles commandes de haut niveau.

UiPath CLI est un petit hôte encapsulé dans un ensemble d' outils installables. Chaque outil est un package npm simple qui enregistre une commande de niveau supérieur (et ses sous-commandes) avec l'hôte. Il s'agit du concept le plus important pour comprendre pourquoi uip fonctionne comme il le fait: ce qui s'installe automatiquement, ce qui ne s'installe pas, comment les versions sont synchronisées et pourquoi uip --help affiche des commandes différentes sur différentes machines.

Hôte et outils

L’hôte (@uipath/cli, l’exécutable uip ) possède uniquement un ensemble restreint de préoccupations:

• Authentification (uip login, uip logout, uip login status, uip login tenant …).
• Gestion des sessions et des informations d’identification.
• Cycle de vie de l’outil (uip tools list / search / install / update / uninstall).
• Compétences pour coder les agents (uip skills install / update / uninstall).
• Le pont du protocole de contexte du modèle (uip mcp).
• Installation de complétion du shell (uip completion).
• Options globales (--output, --output-filter, --log-level, --log-file) et l'enveloppe de sortie JSON.

Tout ce qui touche une interface UiPath — Orchestrator, Solutions, Agents, Flows, Maestro, Empaquetage RPA, Test Manager, Integration Service, Data Fabric, Insights, Traces, DocsAI, API Workflow, Solutions verticales, Agents codés et Apps codées — réside dans un package npm distinct que l'hôte charge à la demande.

Pourquoi choisir le fractionnement:

• Cadences de publication indépendantes - l'outil Orchestrator peut être livré sans libérer à nouveau l'hôte, et vice versa.
• Empreinte d'installation plus petite — un utilisateur qui exécute uniquement des pipelines de test n'a pas besoin des outils Flow ou Maestro sur le disque.
• Contrat stable — les outils communiquent avec l'hôte via une interface programmatique versionnée (enregistrement des commandes, enveloppe de sortie, contexte, télémétrie), et non via des internes partagées.
• Démarrage plus rapide : le code de l’outil est chargé de manière incorrecte. L'hôte effectue le minimum pour analyser argv et identifier l'outil pertinent, puis requiert le bundle de cet outil une fois.

La liste blanche d’installation automatique

Un ensemble d’outils appartenant à UiPath est sur une liste blanche d’installation automatique. L'hôte les connaît par leur alias de commande et mappe l'alias à un package npm:

Alias	Paquet (Package)	Nom long
or	@uipath/orchestrator-tool	Orchestrator (tâches, dossiers, processus, packages, machines, utilisateurs, rôles, licences, ressources, files d'attente, compartiments de stockage, bibliothèques, déclencheurs, webhooks)
solution	@uipath/solution-tool	Solution
rpa	@uipath/rpa-tool	RPA (empaquetage de Studio, analyse, restauration)
agent	@uipath/agent-tool	Agent (Agent)
codedagent	@uipath/codedagent-tool	Agent codé
codedapp	@uipath/codedapp-tool	Application codée
maestro	@uipath/maestro-tool	Maestro
tm	@uipath/test-manager-tool	Test Manager
is	@uipath/integrationservice-tool	Integration Service
vss	@uipath/vertical-solutions-tool	Solutions verticales
api-workflow	@uipath/api-workflow-tool	Workflow d’API
df	@uipath/data-fabric-tool	Data Fabric
insights	@uipath/insights-tool	Insights
traces	@uipath/traces-tool	Traçages
docsai	@uipath/docsai-tool	DocsAI
rpa-legacy	@uipath/rpa-legacy-tool	RPA Legacy - Enveloppeur Windows uniquement autour de uipcli.exe pour les commandes Studio pas encore portées à l'outil rpa multiplateforme (débogage, validation, recherche d'activités, recherche-package, définition de type, package). Voir uip rpa-legacy.
eval	@uipath/eval-tool	Évaluation Runtime des packages déployés par rapport à un processus Orchestrator — évaluateurs, ensembles d'évaluation, évaluations, planifications. Package autonome, ce n'est pas une sous-commande de or.
platform	@uipath/platform-tool	Plate-forme — licences de locataire, bundles d’utilisateurs, règles de groupe, consommables
admin	@uipath/admin-tool	Admin: utilisateurs, groupes, comptes Robot, applications externes, SMTP, autorisation, restriction de l'IP, organisations, locataires, passerelles VPN, catalogue de ressources, audit
gov	@uipath/gov-tool	Gouvernance — Politiques AOps, politiques d'accès, packs de conformité
agenthub	@uipath/agenthub-tool	AgentHub — Inscriptions de serveurs MCP, outils, agents A2A distants
ah	@uipath/automation-hub-tool	Automation Hub — idées, pipeline, taxonomie, utilisateurs
aops	@uipath/aops-tool	StudioAdmin AOps — connexions, référentiels, projets, solutions, pipelines, exécutions
coder	@uipath/coder-tool	Coder — Agent de codage d'IA (version préliminaire uniquement)
context-grounding	@uipath/context-grounding-tool	Ancrage dans le contexte — Python pont
conversational	@uipath/conversational-tool	Conversationnel: chat, agents, historique des conversations, coffres
function	@uipath/function-tool	Fonctions: créer, servir, publier JS/TS et Fonctions Python
guardrails	@uipath/guardrails-tool	Garde-fous - Configurations des garde-fous BYO, AI Trust Layer
ixp	@uipath/ixp-tool	IXP – Traitement intelligent des documents (projets, taxonomie, documents, déploiements)
llm-configuration	@uipath/llmgw-tool	Configuration LLM — Connexions BYO LLM, AI Trust Layer. Notez que le nom du package (llmgw-tool) ne correspond pas à l'alias.
llm-gateway	@uipath/llm-gateway-tool	Passerelle LLM — répertorie les modèles disponibles. Un package distinct de llm-configuration ci-dessus, malgré un nom similaire.
model-hub	@uipath/model-hub-tool	Model Hub - Configuration du routage de la passerelle LLM
pm	@uipath/pm-tool	Process Mining — applications, transformations, ingestion de données
tasks	@uipath/tasks-tool	Tâches Action Center — Catalogues, commentaires, libellés, métadonnées, données

L'hôte traite tout le reste comme n'est pas un outil. Cette table correspond exactement au TOOLS_WHITELIST actuel — chaque entrée a une page de référence sur ce site. @uipath/flow-tool et @uipath/case-tool sont délibérément absents: ils ne sont pas indépendamment ajoutés à la liste blanche, mais les dépendances que @uipath/maestro-tool importe directement pour enregistrer ses branches flow et case (voir la note sur À propos de UiPath CLI).

Ce qui s’installe automatiquement et ce qui ne s’installe pas

Rien n’est préinstallé. Un nouveau npm install -g @uipath/cli place uniquement l'hôte sur le disque.

Un outil est installé sur votre machine de deux manières:

1. Installation automatique lors de la première utilisation. La première fois que vous invoquez une commande dont le préfixe correspond à une entrée de liste blanche, par exemple uip or folders list avant l'installation de l'outil Orchestrator, l'hôte télécharge et installe @uipath/orchestrator-tool depuis npm, puis exécute votre commande. Les invocations suivantes utilisent l’outil installé directement de sorte que la deuxième exécution est rapide.

2. Installation explicite. Exécutez uip tools install <alias> (ou le nom complet du package). Même état de fin; plus rapidement au moment de l’exécution, car aucune étape d’installation automatique n’est nécessaire. Voir la référence des outils uip.

Utilisez l'installation explicite dans les lanceurs CI et pour les environnements hors ligne afin que les temps de création soient déterministes et que la première commande d'une tâche ne paye pas le coût de téléchargement unique. Consultez la section d’installation automatique du guide d’installation pour connaître le compromis complet.

Remarque :

CI=true ne désactive pas l'installation automatique — cette variable n'est consultée nulle part dans le chemin d'installation automatique. Le refus réel est UIPATH_CLI_DISABLE_AUTOINSTALL=true, qui désactive entièrement les installations d'outils implicites, y compris la vérification quotidienne de la fraîcheur par outil (voir la résolution de version ci-dessous). Sans cela, la solution de contournement prangique consiste à préinstaller les outils que vous savez que vous utiliserez - l'installation automatique n'est pas compatible lorsque l'outil est déjà présent.

Les outils tiers ne sont pas pris en charge dans UiPath CLI 1.x. L'hôte valide par rapport à la liste blanche au moment de l'installation, donc uip tools install my-company/some-tool échoue avec ValidationError. Un mécanisme d'extension public peut apparaître dans une version ultérieure; pour l'instant, uip ne charge que les outils dans la table ci-dessus.

Où les outils sont installés sur le disque

Les outils sont installés dans un dossier @uipath/ sous le préfixe npm qui possède le script d'entrée de la CLI:

• Si vous avez installé @uipath/cli globalement (npm install -g @uipath/cli), les outils sont installés globalement à côté — à $(npm root -g)/@uipath/<tool-name>/.
• Si vous avez installé la CLI dans un projet local (npm install @uipath/cli à l'intérieur d'un package), les outils s'installent localement à côté — à la node_modules/@uipath/<tool-name>/ de ce projet.

En d'autres termes, les outils suivent la CLI: CLI globale, outils globaux; CLI locale, outils locaux. Ceci est géré automatiquement — vous n'avez pas besoin de transmettre d'indicateur d'étendue à uip tools install.

Exécutez uip tools list pour voir quels outils sont installés et quelle version. Exécutez npm root -g pour trouver le chemin d'installation global sur votre machine.

Résolution de version — les outils suivent l’hôte

Par défaut, chaque version d'outil est épinglée à la ligne major.minor de la CLI. Lorsque vous exécutez uip tools install or avec CLI 1.0.x, l'hôte résout le dernier @uipath/orchestrator-tool dont la version commence par 1.0. et l'installe. Lorsque vous exécutez uip tools update, chaque outil installé est rejeté dans la dernière version toujours dans la ligne major.minor de la CLI.

Les conséquences pratiques:

• La mise à niveau de la CLI vers une nouvelle version mineure est une opération en deux étapes. Après npm install -g @uipath/cli@1.1.0, exécutez uip tools update pour mettre chaque outil installé au niveau 1.1.x ligne.
• L'épinglage de la CLI épingle efficacement tous les outils. npm install -g @uipath/cli@1.0.3 , puis uip tools update produit un ensemble déterministe de versions d'outils sur n'importe quelle machine.
• L'hôte et les outils sont livrés avec des modifications de protocole compatibles. Un outil construit contre 1.1.x peut appeler un contrat interne qui 1.0.x ne sait pas — autoriser des versions mixtes CLI + outil risque de charger un outil que l’hôte ne peut pas comprendre.

Vous pouvez remplacer la valeur par défaut et installer explicitement une version d’outil spécifique:

uip tools install orchestrator-tool@1.2.3
uip tools update --name @uipath/orchestrator-tool --version 1.2.5

Les versions d'aperçu ne sont pas sélectionnées avec une balise dist-tag comme @beta dans la commande d'installation — cette syntaxe n'existe pas. Au lieu de cela, le canal de publication à l’échelle de la CLI est un paramètre de configuration, core.updateChannel, géré avec uip config:

uip config set updateChannel preview   # opt into preview tool builds
uip tools install orchestrator-tool    # now resolves the preview line

uip config set updateChannel stable    # switch back

updateChannel est l’un des stable (par défaut) ou preview; un troisième canal dev non annoncé existe pour les versions CLI publiées à partir de main. Les commandes d’aperçu dans un outil autrement stable sont étiquetées indépendamment; voir Contrôle de version et stabilité.

La CLI se actualise également automatiquement, ainsi que ses outils. Une fois par jour, la première commande uip éligible vérifie une version plus récente de la CLI sur le canal configuré et se réexécute sur celle-ci si une existe (ne jamais franchir une nouvelle version MAJ par Unattended); séparément, chaque outil installé est actualisé vers la dernière version sur la propre ligne de la CLI la première fois que vous l'utilisez, chaque jour. Les deux vérifications échouent plutôt que d’être ignorées en mode silencieux si elles ne peuvent pas se terminer. Désactivez les deux avec UIPATH_CLI_DISABLE_VERSION_SYNC=true. Pour geler la ligne de version vous-même au lieu de suivre « la plus récente», épinglez-la avec uip config set version <major.minor[.patch]> — voir uip config pour le contrat exact version/updateChannel .

Astuce :

Pour vérifier quelles versions d’outil se trouvent sur une machine après un déploiement, uip tools list --output json imprime le nom, la version et le préfixe de commande de chaque outil installé. Comparez-le à un instantané connu pour capturer la dérive.

Comment l'hôte charge les outils

Lorsque uip <alias> … s’exécute:

1. L'hôte lit argv, strie les indicateurs globaux (--output, --log-level, etc.) et identifie le premier jeton non-indicateur comme un alias d'outil potentiel.
2. Si l’alias correspond à un outil installé, l’hôte charge cet outil à la demande et lui demande d’enregistrer ses sous-commandes.
3. Si l'alias se trouve sur la liste blanche mais que l'outil n'est pas installé, l'hôte exécute l'installation automatique (voir ci-dessus), puis passe à l'étape 2.
4. Si l'alias ne figure pas sur la liste blanche et ne constitue pas une commande de l'hôte reconnue, l'hôte échoue avec une « commande inconnue» et l'utilisation des imprime.

Il s'agit de l'ensemble du modèle de chargement. Il n’y a aucun manifeste de plug-in, aucun fichier de configuration de registre, aucune liste modifiable par l’utilisateur. La liste blanche intégrée au package hôte est la source de la vérité.

Quoi lire ensuite

• référence des outils uip — syntaxe complète et exemples pour chaque sous-commande uip tools .
• Installation de la UiPath CLI — installez l'hôte; les outils en suivent.
• Installation automatique de l’outil de contrôle — UIPATH_CLI_DISABLE_AUTOINSTALL et la solution de contournement pré-installation pour CI.
• Gestion des outils et des compétences — workflows quotidiens (mise à niveau, épingler les versions, inspecter la dérive).
• Compétences — un système parallèle pour apprendre aux agents de codage à utiliser uip. Les compétences ne sont pas des outils et uip skills est un groupe de commandes distinct.
• Contrôle des versions et stabilité - comment les versions de l'hôte et de l'outil sont coordonnées sous semer.