Tools (Plugins)

Toolarchitektur in UiPath CLI, die abdeckt, wie installierbare npm-Pakete den Host mit neuen Befehlen auf oberster Ebene erweitern.

UiPath CLI ist ein kleiner Host, der eine Reihe installierbarer Tools umgibt. Jedes Tool ist ein gewöhnliches npm-Paket, das einen Befehl auf oberster Ebene (und dessen Unterbefehle) beim Host registriert. Dies ist das wichtigste Konzept, um zu verstehen, warum uip so funktioniert – was wird automatisch installiert, was nicht, wie Versionen synchronisiert werden und warum uip --help auf verschiedenen Maschinen unterschiedliche Befehle anzeigt.

Host und Tools

Der Host (@uipath/cli, die ausführbare Datei uip ) hat nur eine begrenzte Anzahl von Bedenken:

• Authentifizierung (uip login, uip logout, uip login status, uip login tenant …).
• Sitzungs- und Anmeldeinformationsverwaltung.
• Toollebenszyklus (uip tools list / search / install / update / uninstall).
• Fähigkeiten zum Codieren von Agents (uip skills install / update / uninstall).
• Die Bridge (uip mcp) für das Modellkontextprotokoll.
• Installation der Shell-Vervollständigung (uip completion).
• Globale Optionen (--output, --output-filter, --log-level, --log-file) und der Umschlag der JSON-Ausgabe.

Alles, was eine UiPath-Oberfläche erreicht – Orchestrator, Lösungen, Agents, Flows, Maestro, RPA-Verpacken, Test Manager, Integration Service, Data Fabric, Insights, Traces, DocsAI, API Workflow, vertikale Lösungen, codierte Agents und codierte Apps – befindet sich in ein separates npm-Paket, das der Host bei Bedarf lädt.

Warum die Aufteilung:

• Unabhängige Veröffentlichungskadenz – Das Orchestrator-Tool kann ausgeliefert werden, ohne den Host erneut freizugeben, und umgekehrt.
• Geringerer Installationsbedarf – ein Benutzer, der nur Testpipelines ausführt, benötigt die Flow- oder Maestro-Tools nicht auf dem Datenträger.
• Stabiler Vertrag – Tools kommunizieren mit dem Host über eine versionierte programmgesteuerte Schnittstelle (Befehlsregistrierung, Ausgabeumschlag, Kontext, Telemetrie), nicht über gemeinsam genutzte Interne Elemente.
• Schnellerer Start – Toolcode wird langsam geladen. Der Host führt das Minimum an, um argv zu parsen und das relevante Tool zu identifizieren, und benötigt dann einmal das Paket dieses Tools.

Die Zulassungsliste für die automatische Installation

Eine Reihe von UiPath-eigenen Tools befindet sich auf einer weißen Liste für die automatische Installation. Der Host erkennt sie durch ihren Befehls-Alias und ordnet den Alias einem npm-Paket zu:

Alias	Paket	Langer Name
or	@uipath/orchestrator-tool	Orchestrator (Aufträge, Ordner, Prozesse, Pakete, Maschinen, Benutzer, Rollen, Lizenzen, Assets, Warteschlangen, Speicher-Buckets, Bibliotheken, Trigger, Webhooks)
solution	@uipath/solution-tool	Lösung
rpa	@uipath/rpa-tool	RPA (Studio-Verpacken, Analysieren, Wiederherstellen)
agent	@uipath/agent-tool	Mitarbeiter
codedagent	@uipath/codedagent-tool	Codierter Agent
codedapp	@uipath/codedapp-tool	Codierte App
maestro	@uipath/maestro-tool	Maestro
tm	@uipath/test-manager-tool	Test Manager
is	@uipath/integrationservice-tool	Integration Service
vss	@uipath/vertical-solutions-tool	Vertikale Lösungen
api-workflow	@uipath/api-workflow-tool	API-Workflow
df	@uipath/data-fabric-tool	Data Fabric
insights	@uipath/insights-tool	Insights
traces	@uipath/traces-tool	Ablaufverfolgungen
docsai	@uipath/docsai-tool	DocsAI
rpa-legacy	@uipath/rpa-legacy-tool	RPA Legacy – Nur Windows-Wrapper um uipcli.exe für die Studio-Befehle, die noch nicht auf das plattformübergreifende rpa -Tool portiert wurden (Debug, Validieren, Find-Activities, Find-Package, Typdefinition, Paket). Siehe uip rpa-legacy aus.
eval	@uipath/eval-tool	Runtime-Auswertung bereitgestellter Pakete anhand eines Orchestrator-Prozesses – Auswerter, Bewertungssätze, Evaluierungen, Zeitpläne. Eigenständiges Paket, kein Unterbefehl von or.
platform	@uipath/platform-tool	Plattform – Mandantenlizenzierung, Benutzerpakete, Gruppenregeln, Verbrauchsmaterialien
admin	@uipath/admin-tool	Administrator – Benutzer, Gruppen, Roboterkonten, externe Apps, SMTP, Autorisierung, IP-Einschränkung, Organisationen, Mandanten, VPN-Gateways, Ressourcenkatalog, Prüfung
gov	@uipath/gov-tool	Governance – AOps-Richtlinien, Zugriffsrichtlinien, Compliance-Pakete
agenthub	@uipath/agenthub-tool	AgentHub – MCP-Serverregistrierungen, Tools, Remote-A2A-Agents
ah	@uipath/automation-hub-tool	Automation Hub – Ideen, Pipeline, Taxonomie, Benutzer
aops	@uipath/aops-tool	StudioAdmin AOps – Verbindungen, Repositorys, Projekte, Lösungen, Pipelines, Ausführungen
coder	@uipath/coder-tool	Coder – KI-Codierungs-Agent (nur Vorschau-Build)
context-grounding	@uipath/context-grounding-tool	Kontextgrundlage – Python-Bridge
conversational	@uipath/conversational-tool	Konversational – Chat, Agents, Konversationsverlauf, Instanzen
function	@uipath/function-tool	Funktionen – Erstellen, Bereitstellen, Veröffentlichen von JS/TS- und Python-Funktionen
guardrails	@uipath/guardrails-tool	Guardrails – BYO-Leitplankenkonfigurationen, AI Trust Layer
ixp	@uipath/ixp-tool	IXP – Intelligente Dokumentenverarbeitung (Projekte, Taxonomie, Dokumente, Bereitstellungen)
llm-configuration	@uipath/llmgw-tool	LLM-Konfiguration – BYO-LLM-Verbindungen, AI Trust Layer. Beachten Sie, dass der Paketname (llmgw-tool) nicht mit dem Alias übereinstimmt.
llm-gateway	@uipath/llm-gateway-tool	LLM Gateway – Liste der verfügbaren Modelle. Ein separates Paket von llm-configuration oben, trotz des ähnlichen Namens.
model-hub	@uipath/model-hub-tool	Model Hub – Routing-Konfiguration des LLM-Gateways
pm	@uipath/pm-tool	Process Mining – Apps, Transformationen, Datenaufnahme
tasks	@uipath/tasks-tool	Action Center-Aufgaben – Kataloge, Kommentare, Beschriftungen, Metadaten, Daten

Der Host behandelt alles andere als Nicht-a-Tool. Diese Tabelle entspricht genau der aktuellen TOOLS_WHITELIST – jeder Eintrag hat eine Referenzseite auf dieser Site. @uipath/flow-tool und @uipath/case-tool fehlen absichtlich: Sie stehen nicht unabhängig auf der weißen Liste, sondern Abhängigkeiten, die @uipath/maestro-tool direkt importiert, um ihre flow und case -Verzweigungen zu registrieren (siehe Hinweis zu Über UiPath CLI).

Was automatisch installiert wird und was nicht

Es ist nichts vorinstalliert. Ein neues npm install -g @uipath/cli bringt nur den Host auf den Datenträger.

Zwei Möglichkeiten, wie ein Tool auf Ihrer Maschine installiert wird:

1. Automatische Installation bei der ersten Verwendung. Wenn Sie zum ersten Mal einen Befehl aufrufen, dessen Präfix mit einem Whitelist-Eintrag übereinstimmt – z. B. uip or folders list , bevor das Orchestrator-Tool installiert wird –, lädt der Host @uipath/orchestrator-tool von npm herunter und installiert ihn. Dann wird Ihr Befehl ausgeführt. Nachfolgende Aufrufe verwenden das installierte Tool direkt, sodass die zweite Ausführung schnell ist.

2. Explizite Installation. Führen Sie uip tools install <alias> aus (oder den vollständigen Paketnamen). Derselbe Endzustand; schneller zur Runtime, da keine automatische Installation erforderlich ist. Siehe UIP-Tools-Referenz.

Verwenden Sie die explizite Installation in CI-Ausführungen und für Offline-Umgebungen, damit die Erstellungszeiten deterministisch sind und der erste Befehl in einem Auftrag nicht die einmaligen Downloadkosten bezahlt. Den vollständigen Kompromiss finden Sie im Abschnitt zur automatischen Installation der Installationsanleitung .

Hinweis:

CI=true deaktiviert die automatische Installation nicht – diese Variable wird nirgendwo im Pfad für die automatische Installation abgefragt. Die echte Option ist UIPATH_CLI_DISABLE_AUTOINSTALL=true, wodurch implizite Toolinstallationen vollständig deaktiviert werden, einschließlich der täglichen Aktualisierungsprüfung pro Tool (siehe Versionsauflösung unten). Ohne diese Option besteht die praktische Problemumgehung immer noch darin, die Tools vorzuinstallieren, von denen Sie wissen, dass Sie sie verwenden – die automatische Installation ist ein No-Op, wenn das Tool bereits vorhanden ist.

Tools von Drittanbietern werden in der UiPath CLI 1.x nicht unterstützt . Der Host validiert zur Installationszeit anhand der weißen Liste, sodass uip tools install my-company/some-tool mit einem ValidationError fehlschlägt. Ein öffentlicher Erweiterungsmechanismus kann in einer späteren Version angezeigt werden; derzeit lädt uip nur die Tools in der obigen Tabelle.

Wo Tools auf der Festplatte live sind

Tools werden in einem @uipath/ -Ordner unter dem Präfix npm installiert, das das Einstiegsskript der CLI besitzt:

• Wenn Sie @uipath/cli global (npm install -g @uipath/cli) installiert haben, werden Tools global daneben installiert – unter $(npm root -g)/@uipath/<tool-name>/.
• Wenn Sie die CLI in einem lokalen Projekt installiert haben (npm install @uipath/cli innerhalb eines Pakets), werden Tools lokal daneben installiert – auf der node_modules/@uipath/<tool-name>/ dieses Projekts.

Mit anderen Worten: Tools folgen der CLI: globale CLI, globale Tools; lokale CLI, lokale Tools. Dies wird automatisch behandelt – Sie müssen kein Scope-Flag an uip tools install übergeben.

Führen Sie uip tools list aus, um anzuzeigen, welche Tools installiert sind und welche Version. Führen Sie npm root -g aus, um den globalen Installationspfad auf Ihrer Maschine zu finden.

Versionsauflösung – Tools verfolgen den Host

Standardmäßig ist jede Toolversion an die Zeile major.minor der CLI angeheftet. Wenn Sie uip tools install or mit CLI 1.0.x ausführen, löst der Host das neueste @uipath/orchestrator-tool auf, dessen Version mit 1.0. beginnt, und installiert es. Wenn Sie uip tools update ausführen, wird jedes installierte Tool auf die neueste Version übertragen , die sich noch innerhalb der Zeile major.minor der CLI befindet.

Die praktischen Folgen:

• Das Upgrade der CLI auf eine neue Minor-Version ist ein zweistufiger Vorgang. Führen Sie nach npm install -g @uipath/cli@1.1.0 uip tools update aus, um jedes installierte Tool in die Version 1.1.x zu bringen Zeile.
• Das Anheften der CLI heftet effektiv alle Tools an. npm install -g @uipath/cli@1.0.3 und dann uip tools update erzeugt einen deterministischen Satz von Toolversionen auf einer beliebigen Maschine.
• Host und Tools senden zusammen kompatible Protokolländerungen. Ein Tool, das für 1.1.x erstellt wurde kann einen internen Vertrag aufrufen, der 1.0.x ist weiß nichts über – das Zulassen gemischter CLI+Tool-Versionen würde das Laden eines Tools mit sich bringen, das der Host nicht verstehen kann.

Sie können die Standardeinstellung überschreiben und explizit eine bestimmte Toolversion installieren:

uip tools install orchestrator-tool@1.2.3
uip tools update --name @uipath/orchestrator-tool --version 1.2.5

Vorschau-Builds werden nicht mit einem npm dist-Tag wie @beta im Installationsbefehl ausgewählt – diese Syntax ist nicht vorhanden. Stattdessen ist der CLI-weite Versionskanal eine Konfigurationseinstellung, core.updateChannel, die mit uip config verwaltet wird:

uip config set updateChannel preview   # opt into preview tool builds
uip tools install orchestrator-tool    # now resolves the preview line

uip config set updateChannel stable    # switch back

updateChannel ist einer von stable (Standard) oder preview; Ein dritter, nicht angekündigter dev -Kanal ist für CLI-Builds vorhanden, die über main veröffentlicht wurden. Vorschaubefehle innerhalb eines ansonsten stabilen Tools werden unabhängig beschriftet; Siehe Versionierung und Stabilität.

Die CLI hält sich auch und ihre Tools automatisch auf dem neuesten Stand. Einmal pro Tag prüft der erste berechtigte uip -Befehl auf eine neuere CLI-Version auf dem konfigurierten Kanal und führt sich selbst darauf erneut aus, wenn eine vorhanden ist ( niemals eine neue MaJOR-Version unbeaufsichtigt); Separat wird jedes installierte Tool auf die neueste Version auf der eigenen Zeile der CLI aktualisiert, wenn Sie es zum ersten Mal täglich verwenden. Beide Prüfungen schlagen geschlossen auf, anstatt im Hintergrund zu überspringen, wenn sie nicht abgeschlossen werden können. Deaktivieren Sie beide mit UIPATH_CLI_DISABLE_VERSION_SYNC=true. Um die Versionszeile selbst zu sichern, anstatt „neueste“ zu verfolgen, heften Sie sie mit uip config set version <major.minor[.patch]> an – den genauen version/updateChannel -Vertrag finden Sie unter uip config .

Tipp:

Um zu überprüfen, welche Toolversionen sich nach einer Bereitstellung auf einer Maschine befinden, gibt uip tools list --output json den Namen, die Version und das Befehlspräfix jedes installierten Tools aus. Vergleichen Sie dies mit einem bekannt guten Snapshot, um Abweichungen zu erkennen.

Wie der Host Tools lädt

Wenn uip <alias> … ausgeführt wird:

1. Der Host liest argv, entfernt globale Flags (--output, --log-level usw.) und identifiziert das erste Nicht-Flag-Token als potenzielles Tool-Alias.
2. Wenn der Alias mit einem installierten Tool übereinstimmt, lädt der Host dieses Tool bei Bedarf und fordert es auf, seine Unterbefehle zu registrieren.
3. Wenn sich der Alias auf der weißen Liste befindet, das Tool jedoch nicht installiert ist, führt der Host die automatische Installation aus (siehe oben) und fährt dann mit Schritt 2 fort.
4. Wenn sich der Alias nicht auf der weißen Liste befindet und kein erkannter Hostbefehl ist, schlägt der Host mit „Unbekannter Befehl“ fehl und gibt die Nutzung aus.

Das ist das gesamte Lademodell. Es gibt kein Plugin-Manifest, keine Registrierungskonfigurationsdatei, keine vom Benutzer bearbeitbare Liste. Die in das Hostpaket integrierte Whitelist ist die Source of Truth.

Was als Nächstes gelesen werden soll

• UIP-Tools-Referenz – vollständige Syntax und Beispiele für jeden uip tools -Unterbefehl.
• Installing UiPath CLI – Installieren Sie den Host; Tools folgen von dort aus.
• Steuern der automatischen Installation des Tools – UIPATH_CLI_DISABLE_AUTOINSTALL und Problemumgehung vor der Installation für CI.
• Verwalten von Tools und Fähigkeiten – tägliche Workflows (Upgrade, Versionen anheften, Abweichung inspizieren).
• Fähigkeiten – ein paralleles System, um Codierungsagenten die Verwendung uip beizubringen. Fähigkeiten sind keine Tools und uip skills ist eine separate Befehlsgruppe.
• Versionierung und Stabilität – wie Host- und Toolversionen unter Servern koordiniert werden.