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

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

Feld	Beschreibung
Name	Toolname.
Version	Installed version.
Description	Toolbeschreibung.
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.

Suche nach UIP-Tools

Durchsuchen Sie den UiPath-Tool-Katalog nach Tools, die Sie installieren können. Die Ergebnisse werden nach den auf der Zulassungsliste aufgeführten @uipath/ -Tools gefiltert (einschließlich rpa-legacy, das eine explizite Installation erfordert). Pakete von Drittanbietern werden nicht zurückgegeben.

Argumente

• <query> (optional) – Übereinstimmung der Teilzeichenfolge mit dem Paketnamen und der Beschreibung. Ohne diese werden alle Tools auf der Zulassungsliste aufgelistet.

Optionen

Keine.

Beispiel

uip tools search orchestrator

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

Die Suche liest aus der npm-Registrierung, die für den Scope @uipath konfiguriert ist (normalerweise https://registry.npmjs.org/ über die standardmäßige npm-Konfiguration oder über einen überschriebenen Registrierungssatz in Ihrem .npmrc). Die Ergebnisse werden clientseitig gegen die Zulassungsliste gefiltert, sodass jedes @uipath/ -Paket, das sich nicht auf der Zulassungsliste befindet, weggelassen wird.

UIP-Tools installieren

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).

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. Der Wert nach @ muss eine gültige Semserver-Zeichenfolge sein (z. B. 1.0.2 oder 1.0.0-preview.1) – Ein leerer Kanalname wie @beta wird mit einem ValidationError abgelehnt.

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

# 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

Versionsauflösung

• Mit einer expliziten Serverversion (z. B. @1.0.2 oder @1.0.0-preview.1), wird diese Version so verwendet, wie sie ist. Es gibt keine npm-dist-tag-Kurzbefehl wie @beta – der Wert nach @ muss als semver geparst werden, oder der Befehl schlägt mit ValidationError fehl.
• Ohne Version löst der Host den Aktualisierungskanal der CLI (standardmäßig stable oder preview/dev über uip config set updateChannel <channel>) und seine aktuelle MaJOR.MINOR-Zeile auf – also wird eine stable -CLI 1.0.x installiert Das neueste übereinstimmende stabile Tool 1.0.*. Dadurch bleiben Host- und Toolprotokoll kompatibel. Siehe Versionierung und Stabilität und UIP-Konfiguration.

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.

Durchsetzung auf der Zulassungsliste: <package-spec> muss in eines der zulässigen @uipath/ -Pakete (oder rpa-legacy) aufgelöst werden. Jeder andere Wert schlägt mit ValidationError und Exitcode 3 fehl – Drittanbieter-Tools werden in 1.x nicht unterstützt.

Datenform (--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	Ursache	Was zu tun ist
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.

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.

Wichtig:

Es gibt kein --version -Flag auf uip tools update – nur --name ist registriert. Jedes Tool wird auf die neueste Version aktualisiert, die gemäß der Richtlinie für die aktive Version zulässig ist (normalerweise an die Zeile MaJOR.MINOR der CLI angeheftet); Um stattdessen eine bestimmte Version anzuheften, verwenden Sie uip config set version <line>, oder installieren Sie sie mit einer expliziten Version über uip tools install <package>@<version> neu.

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

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

Wenn core.version an eine genaue Version angeheftet ist (keine MAJOR.MINOR -Zeile), wird die Aktualisierung vollständig übersprungen – der Befehl beendet 0 weiterhin mit einem leeren Data -Array und einem Instructions -Hinweis, der die Anheftung erläutert Eine angeheftete Installation wird absichtlich nie verschoben.

UIP-Tools deinstallieren

Entfernen Sie ein installiertes Tool oder alle installierten Tools gleichzeitig.

Argumente

• [package-name] (optional) – Alias, Kurzname oder vollständiger npm-Name. Sich gegenseitig mit --all ausschließen. Geben Sie genau eines der Argumente oder --all an – wenn Sie beide weglassen oder beides übergeben, ist ein ValidationError.

Optionen

• --all – Deinstallieren Sie jedes installierte Tool. Sich gegenseitig mit [package-name] ausschließen.

Beispiele

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

# uninstall every installed tool
uip tools uninstall --all

Datenform (--output json)

Das Deinstallieren eines einzelnen Tools gibt Code: "Message" aus:

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

--all gibt Code: "UninstallResult" mit einer Zeile pro Tool aus:

{
  "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.

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 – Validierungsfehler (unbekannter Alias, nicht auf der Zulassungsliste stehende Paket, ungültige Versionszeichenfolge) für install und update.

uninstalls eigene Argumentvalidierungsfehler (fehlender Paketname oder --all in Kombination mit einem Paketnamen) beenden 1 statt 3, obwohl der Antworttext immer noch Result: "ValidationError" meldet – Verzweigung bei Result/ErrorCode im JSON-Textkörper anstelle des Exitcodes, wenn Sie diesen Fall von anderen Fehlern unterscheiden müssen.

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.