Outils UIP

Syntaxe et options pour `uiptools`, qui installe, met à jour et supprime les outils basés sur npm qui étendent la UiPath CLI.

uip tools gère les outils installables qui étendent la CLI. Voir Outils pour le concept.

Pour savoir comment contrôler l'installation automatique sur les runtimes CI, consultez Contrôler l'installation automatique de l'outil.

Synthèse

uip tools list
uip tools search [<query>]
uip tools install <package-spec>
uip tools update [--name <package>]
uip tools uninstall [<package>] [--all]

Toutes les sous-commandes uip tools respectent les options globales (--output, --output-filter, --log-level, --log-file). Les codes de sortie suivent le contrat standard.

Liste des outils UIP

Répertoriez les outils actuellement installés avec la CLI.

Arguments

Aucun

Options

Aucun

Exemple

uip tools list --output table

Format des données (--output json)

{
  "Code": "ToolList",
  "Data": [
    {
      "name": "@uipath/orchestrator-tool",
      "version": "1.0.2",
      "commandPrefix": "or"
    },
    {
      "name": "@uipath/solution-tool",
      "version": "1.0.1",
      "commandPrefix": "solution"
    }
  ]
}

commandPrefix est l'alias de niveau supérieur que vous saisissez, par exemple or pour Orchestrator. Utilisez-le pour confirmer ce que uip <prefix> … sera réellement exécuté.

Recherche d’outils UIP

Recherchez dans le catalogue d’outils UiPath les outils que vous pouvez installer. Les résultats sont filtrés selon les outils @uipath/ de la liste d'autorisation (y compris rpa-legacy, qui nécessite une installation explicite). Les packages tiers ne sont pas retournés.

Arguments

• <query> (facultatif) : correspondance de sous-chaînes avec le nom et la description du package. Sans cela, tous les outils de la liste d'autorisation sont répertoriés.

Options

Aucun

Exemple

uip tools search orchestrator

Format des données (--output json)

{
  "Code": "SearchResult",
  "Data": [
    {
      "name": "@uipath/orchestrator-tool",
      "latestVersion": "1.0.2",
      "description": "Orchestrator jobs, folders, processes, packages, and resources",
      "availableVersions": ["1.0.0", "1.0.1", "1.0.2"]
    }
  ]
}

Recherchez des lectures à partir du registre npm configuré pour l'étendue @uipath (généralement https://registry.npmjs.org/ via la configuration npm par défaut ou un registre remplacé défini dans votre .npmrc). Les résultats sont filtrés côté client par rapport à la liste d'autorisation, de sorte que tout package @uipath/ qui ne figure pas sur la liste d'autorisation est omis.

Installation des outils UIP

Installez un outil sur la liste d'autorisation depuis npm.

Arguments

• <package-spec> (requis) — l'outil à installer. L'un des éléments suivants:
  • Alias de commande: or, solution, tm, is, vss, df,...
  • Nom court: orchestrator-tool, solution-tool,…
  • Nom npm complet: @uipath/orchestrator-tool, @uipath/solution-tool,…
  • Avec version explicite: orchestrator-tool@1.0.2, @uipath/orchestrator-tool@1.0.2. La valeur après @ doit être une chaîne de serveur valide (par ex. 1.0.2 ou 1.0.0-preview.1) — un nom de canal à barres comme @beta est rejeté avec un ValidationError.

Options

Aucun

Exemples

# by alias — simplest
uip tools install or

# by short name
uip tools install orchestrator-tool

# by full npm name
uip tools install @uipath/orchestrator-tool

# specific version
uip tools install orchestrator-tool@1.0.2

# exact preview build
uip tools install orchestrator-tool@1.0.0-preview.1

# preview channel — switch the channel, then install normally
uip config set updateChannel preview
uip tools install orchestrator-tool

Résolution de version

• Avec une version de serveur explicite (par exemple @1.0.2 ou @1.0.0-preview.1), cette version est utilisée telle quelle. Il n'y a pas de raccourci npm-dist-tag comme @beta - la valeur après @ doit être analysée en tant que serveur, ou la commande échoue avec un ValidationError.
• Sans version, l'hôte se résout par rapport au canal de mise à jour de la CLI (stable par défaut, ou preview/dev via uip config set updateChannel <channel>) et à sa ligne MAJOR.MINIOR actuelle, c'est-à-dire qu'une CLI stable 1.0.x installe le dernier outil stable correspondant 1.0.*. Cela permet de maintenir la compatibilité des protocoles hôte et outil. Voir Contrôle des versions et stabilité et uip config.

Cible d'installation: l'outil est installé à côté du package npm de la CLI — globalement si la CLI est une installation globale, localement si la CLI est une installation au niveau du projet. Vous ne transmettez pas d'indicateur d'étendue. Exécutez npm root -g pour trouver le chemin d'installation global sur votre machine.

Application de la liste d'autorisation: <package-spec> doit se résoudre à l'un des packages @uipath/ de la liste d'autorisation (ou rpa-legacy). Toute autre valeur échoue avec ValidationError et le code de sortie 3 — les outils tiers ne sont pas pris en charge dans 1.x.

Format des données (--output json)

{
  "Code": "Message",
  "Data": { "Message": "Successfully installed @uipath/orchestrator-tool@1.0.2" }
}

mise à jour des outils uip

Mettez à jour un ou plusieurs outils installés vers la dernière version compatible.

Arguments

Aucun

Options

• --name <package> — mettez à jour un seul outil. Accepte l’alias, le nom court ou le nom NPM complet. Sans --name, chaque outil installé est mis à jour.

Important :

Il n'y a pas d'indicateur --version sur uip tools update — seul --name est enregistré. Chaque outil est mis à jour vers la dernière version autorisée par la politique de version active (généralement épinglée à la ligne MAJOR.MINIOR de la CLI); pour épingler une version spécifique à la place, utilisez uip config set version <line> ou réinstallez avec une version explicite via uip tools install <package>@<version>.

Exemples

# update every installed tool to the latest version within the CLI's major.minor line
uip tools update

# update just the Orchestrator tool
uip tools update --name or

Format des données (--output json)

{
  "Code": "UpdateResult",
  "Data": [
    {
      "name": "orchestrator-tool",
      "status": "updated",
      "from": "1.2.2",
      "to": "1.2.3"
    },
    {
      "name": "agent-tool",
      "status": "up-to-date",
      "from": "1.2.3",
      "to": "1.2.3"
    }
  ]
}

Les résultats par outil sont toujours émis, même en cas d’échec partiel. Si la mise à jour d’un outil échoue, la commande se termine avec un code de sortie non nul, et les entrées défaillantes comportent un champ error .

Si core.version est épinglé sur une version exacte (pas une ligne MAJOR.MINOR), la mise à jour est entièrement ignorée - la commande quitte toujours 0 avec un tableau Data vide et une note Instructions expliquant la épingle, depuis une installation épinglée ne se déplace intentionnellement jamais.

désinstallation des outils uip

Supprimez un outil installé ou tous les outils installés à la fois.

Arguments

• [package-name] (facultatif) : alias, nom court ou nom NPM complet. Capture mutuellement exclusive avec --all. Indiquez exactement l'un des arguments ou --all — en omettant les deux ou en transmettant les deux, est un ValidationError.

Options

• --all — désinstaller chaque outil installé. Capture mutuellement exclusive avec [package-name].

Exemples

# uninstall a single tool
uip tools uninstall orchestrator
uip tools uninstall @uipath/solution-tool

# uninstall every installed tool
uip tools uninstall --all

Format des données (--output json)

La désinstallation d’un seul outil génère Code: "Message":

{
  "Code": "Message",
  "Data": { "Message": "Successfully uninstalled @uipath/orchestrator-tool" }
}

--all génère Code: "UninstallResult" avec une ligne par outil:

{
  "Code": "UninstallResult",
  "Data": [
    { "name": "orchestrator-tool", "status": "uninstalled" },
    { "name": "agent-tool", "status": "uninstalled" }
  ]
}

Si la désinstallation d'un outil échoue dans le chemin --all, sa ligne comporte un champ error et la commande se termine avec un code de sortie non nul — la répartition complète par outil est toujours émise.

Après la désinstallation, l'invocation de uip or … réinstallera automatiquement l'outil Orchestrator lors de l'utilisation suivante, à moins que l'installation automatique ne soit bloquée (par exemple, sur un exécuteur sans accès au réseau). Installez explicitement pour éviter cela.

Codes de sortie

• 0 — réussite.
• 1 — échec (installation, mise à jour, désinstallation ou erreur au niveau de l'outil). Pour update comportant plusieurs outils, au moins un a échoué.
• 3 — Error de validation (alias inconnu, package non autorisé, chaîne de version non valide) sur install et update.

Les propres erreurs de validation d'argument de uninstall (nom de package manquant ou --all combinée à un nom de package) sortent 1 plutôt que 3, même si le corps de la réponse indique toujours Result: "ValidationError" — branche sur Result/ErrorCode dans le corps JSON plutôt que le code de sortie si vous devez distinguer ce cas des autres échecs.

Voir Codes de sortie pour la table complète.

Voir également

• Outils (extensions) : le modèle d'extension, l'épinglage de la version, l'emplacement d'installation et l'assistance tierce.
• Installation de la UiPath CLI — installez l'hôte, puis apportez des outils.
• Contrôle de l'installation automatique des outils - pourquoi il n'y a pas de refus et comment maintenir les temps de création de CI déterministes.
• Contrôle des versions et stabilité — contrat de service entre l'hôte et les outils.