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": "orchestrator-tool",
      "Version": "1.2.3",
      "Description": "UiPath Orchestrator Tool",
      "CommandPrefix": "or",
      "Status": "ok"
    },
    {
      "Name": "agent-tool",
      "Version": "1.1.7",
      "Description": "UiPath Agent Tool",
      "CommandPrefix": "agent",
      "Status": "needs update"
    }
  ]
}

Champ	Description
Name	Nom de l’outil.
Version	Installed version.
Description	Description de l’outil.
CommandPrefix	The top-level alias you type — for example, or for Orchestrator. Use it to confirm what uip <prefix> … runs.
Status	ok when the installed version is on the running CLI's MAJOR.MINOR line. needs update when it is off that line; the CLI replaces the tool with a version on its line the next time you run one of the tool's commands. In an interactive table, needs update rows are highlighted.

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.2.3",
      "Description": "Manage UiPath Orchestrator resources from the CLI",
      "AvailableVersions": ["1.2.3", "1.2.2", "1.2.1"]
    }
  ]
}

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

Install an allowlisted tool from the npm registry. The CLI resolves the version from whichever registry npm's own configuration sets for the @uipath scope (a scoped @uipath:registry entry in .npmrc, otherwise npm's default registry).

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.2.3" }
}

Failures

When no version can be resolved for the CLI's line, the failure envelope carries an ErrorCode that names the cause. When npm's configuration can be read, the message also names the registry that was queried.

ErrorCode	Origine	Que faire
authentication_required	The registry rejected the credentials.	Fix that registry's credentials in .npmrc, then re-run.
network_error	The registry could not be reached.	Check network access and any proxy or registry configuration in .npmrc, then re-run.
not_found	The registry has no version of the tool on the CLI's MAJOR.MINOR line.	Install a build for this line with uip tools install <tool>@<version>, run uip update to move the CLI onto a line that publishes the tool, or point the @uipath scope at the registry that publishes it.
server_error	The registry returned metadata the CLI could not read.	Re-run. If it persists, check whether a proxy or mirror is rewriting the response.

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"
    }
  ]
}

Status is updated or up-to-date. If any tool fails to update, the command emits a Failure envelope naming the number of tools that failed, and exits with code 1. Run with --log-level debug to see the per-tool 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" }
  ]
}

Status is uninstalled, skipped for a tool that ships with the CLI itself, or failed. Skipped and failed rows carry an Error field. If any tool fails to uninstall in the --all path, the command exits with code 1 — the full per-tool breakdown is still emitted.

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.