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>] [--version <version>]
uip tools uninstall <package>

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

Search the UiPath tool catalog for tools you can install. Results are filtered to the allowlisted @uipath/ tools (including rpa-legacy, which requires explicit install). Third-party packages are not returned.

Arguments

• <query> (optional) — substring match against package name and description. Without it, all allowlisted tools are listed.

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

Search reads from the npm registry configured for the @uipath scope (typically https://registry.npmjs.org/ via the default npm config, or an overridden registry set in your .npmrc). Results are filtered client-side against the allowlist, so any @uipath/ package that is not on the allowlist is omitted.

Installation des outils UIP

Install an allowlisted tool from 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, orchestrator-tool@beta.

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

# preview channel (npm dist-tag)
uip tools install orchestrator-tool@beta

Résolution de version

• Avec une version explicite (@1.0.2 ou @beta), cette version est utilisée telle quelle.
• En l’absence de version, l’hôte sélectionne la dernière version publiée qui correspond à la ligne MAJOR.MINIOR actuelle de la CLI, c’est-à-dire que la CLI 1.0.x installe l’outil 1.0.*. Cela permet de maintenir la compatibilité des protocoles hôte et outil. Voir Contrôle des versions et stabilité.

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.

Allowlist enforcement: <package-spec> must resolve to one of the allowlisted @uipath/ packages (or rpa-legacy). Any other value fails with ValidationError and exit code 3 — third-party tools are not supported in 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.
• --version <version> — version cible. La valeur par défaut est latest, qui résout de la même manière que install (épinglée à la ligne MAJOR.MINIOR de la CLI). Transmettez une version exacte (1.0.3) ou une dist-tag (beta) pour remplacer.

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

# pin a specific tool to an exact version
uip tools update --name orchestrator-tool --version 1.0.3

# switch a tool to a preview channel
uip tools update --name maestro-tool --version beta

Format des données (--output json)

{
  "Code": "UpdateResult",
  "Data": [
    {
      "name": "@uipath/orchestrator-tool",
      "status": "updated",
      "from": "1.0.1",
      "to": "1.0.2"
    },
    {
      "name": "@uipath/solution-tool",
      "status": "up-to-date",
      "from": "1.0.1",
      "to": "1.0.1"
    }
  ]
}

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 .

désinstallation des outils uip

Supprimer un outil installé.

Arguments

• <package> (obligatoire) : alias, nom court ou nom NPM complet.

Options

Aucun

Exemples

uip tools uninstall or
uip tools uninstall @uipath/solution-tool

Format des données (--output json)

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

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 — validation error (unknown alias, non-allowlisted package, invalid version string).

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.