UIP-Tools

Syntax und Optionen für „uip-Tools“, die die npm-basierten Tools installieren, aktualisieren und entfernen, die die UiPath CLI erweitern.

uip tools verwaltet die installierbaren Tools , die die CLI erweitern. Das Konzept finden Sie unter Tools (Plugins) .

Informationen zum Steuern der automatischen Installation bei CI-Ausführungen finden Sie unter Steuern der automatischen Installation des Tools.

Zusammenfassung

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

Alle uip tools -Unterbefehle berücksichtigen die globalen Optionen (--output, --output-filter, --log-level, --log-file). Austrittscodes folgen dem Standardvertrag.

Liste der UIP-Tools

Listen Sie die Tools auf, die derzeit neben der CLI installiert sind.

Argumente

Keine.

Optionen

Keine.

Beispiel

uip tools list --output table

Datenform (--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 ist das Alias der obersten Ebene, das Sie eingeben – z. B. or für Orchestrator. Verwenden Sie sie, um zu bestätigen, was uip <prefix> … tatsächlich ausgeführt wird.

Suche nach UIP-Tools

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.

Argumente

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

Optionen

Keine.

Beispiel

uip tools search orchestrator

Datenform (--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.

UIP-Tools installieren

Install an allowlisted tool from npm.

Argumente

• <package-spec> (erforderlich) – Das zu installierende Tool. Eines von:
  • Befehls-Alias: or, solution, tm, is, vss, df, …
  • Kurzname: orchestrator-tool, solution-tool, …
  • Vollständiger npm-Name: @uipath/orchestrator-tool, @uipath/solution-tool, …
  • Mit expliziter Version: orchestrator-tool@1.0.2, @uipath/orchestrator-tool@1.0.2, orchestrator-tool@beta.

Optionen

Keine.

Beispiele

# 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

Versionsauflösung

• Bei einer expliziten Version (@1.0.2 oder @beta) wird diese Version unverändert verwendet.
• Ohne Version wählt der Host die neueste veröffentlichte Version aus, die der aktuellen MaJOR.MINOR-Zeile der CLI entspricht – d. h. die CLI 1.0.x installiert das Tool 1.0.*. Dadurch bleiben Host- und Toolprotokoll kompatibel. Siehe Versionierung und Stabilität.

Installationsziel: Das Tool wird neben dem npm-Paket der CLI installiert – global, wenn es sich bei der CLI um eine globale Installation handelt, oder lokal, wenn es sich bei der CLI um eine projektbezogene Installation handelt. Sie übergeben kein Scope-Flag. Führen Sie npm root -g aus, um den globalen Installationspfad auf Ihrer Maschine zu finden.

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.

Datenform (--output json)

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

Aktualisierung der UIP-Tools

Aktualisieren Sie ein oder mehrere installierte Tools auf die neueste kompatible Version.

Argumente

Keine.

Optionen

• --name <package> – Aktualisieren Sie ein einzelnes Tool. Akzeptiert einen Alias, einen Kurznamen oder einen vollständigen NPM-Namen. Ohne --name wird jedes installierte Tool aktualisiert.
• --version <version> – Zielversion. Der Standardwert ist latest, der auf die gleiche Weise aufgelöst wird wie install (an die Zeile MaJOR.MINOR der CLI angeheftet). Übergeben Sie eine genaue Version (1.0.3) oder ein Dist-Tag (beta) zum Überschreiben.

Beispiele

# 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

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

Ergebnisse pro Tool werden immer ausgegeben, auch bei einem Teilfehler. Wenn ein Tool nicht aktualisiert werden kann, wird der Befehl mit einem Exitcode ungleich Null beendet und die fehlgeschlagenen Einträge enthalten ein error -Feld.

UIP-Tools deinstallieren

Entfernen Sie ein installiertes Tool.

Argumente

• <package> (erforderlich) – Alias, Kurzname oder vollständiger npm-Name.

Optionen

Keine.

Beispiele

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

Datenform (--output json)

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

Nach der Deinstallation wird das Orchestrator-Tool durch Aufrufen von uip or … bei der nächsten Verwendung automatisch erneut installiert, es sei denn, die automatische Installation wird blockiert (z. B. auf einem Ausführungsprogramm ohne Netzwerkzugriff). Installieren Sie explizit, um das zu vermeiden.

Exitcodes

• 0 – Erfolg.
• 1 – Fehler (Installation, Aktualisierung, Deinstallation oder ein Fehler auf Toolebene). Bei update mit mehreren Tools ist mindestens eines fehlgeschlagen.
• 3 — validation error (unknown alias, non-allowlisted package, invalid version string).

Die vollständige Tabelle finden Sie unter Exit-Codes .

Siehe auch

• Tools (Plugins) – Das Plugin-Modell, die Versionsheft, der Installationsspeicherort und der Support von Drittanbietern.
• Installieren der UiPath CLI – Installieren Sie den Host und fügen Sie dann Tools ein.
• Steuern der automatischen Installation des Tools – warum es keine Abmeldung gibt und wie die CI-Erstellungszeiten deterministisch bleiben.
• Versionierung und Stabilität – Serververtrag über Host und Tools hinweg.