- Überblick
- Erste Schritte
- Installieren der UiPath CLI
- Erste Befehle (Schnellstart)
- Ihre erste Pipeline
- Konzepte
- Verwenden der UiPath CLI
- Anleitungen
- CI/CD-Rezepte
- Befehlsreferenz
- Überblick
- Exitcodes
- Globale Optionen
- UIP-codierter Agent
- UIP-Coded
- UIP-Kontextgrundlage
- UIP-Dokumentation
- UIP-Funktion
- UIP-Leitplanken
- uip llm-configuration
- uip llm-gateway
- UIP-Modellhub
- Add-Test-Data-Entität
- Add-Test-Data-Queue
- Add-Test-Data-Variation
- Analysieren
- Erstellen
- Ein Projekt erstellen
- Diff
- Suchaktivitäten
- Get-Analyse-Regeln
- get-standard-aktivität-xaml
- Fehler abrufen
- Manuelle-Testfälle erhalten
- Manuelle-Testschritte erhalten
- Get-Library-Object-Repository
- Get-Object-Repository
- Get-Versionen
- Beispiel für einen Workflow abrufen
- Anwendung anzeigen
- Anzeigeelement
- Inspektionspaket
- install-data-fabric-entities
- Pakete installieren oder aktualisieren
- list-data-fabric-entities
- Listeninstanzen
- Beispiele für Listenworkflows
- Packen
- Veröffentlichen
- Remote
- restore
- Ausführen, Debuggen & Ausführung enthält
- Ausführungsdatei installieren
- Suchvorlagen
- Studio starten
- Ausführung anhalten
- TM
- UIA
- UIP-Aufgaben
- UIP-Ablaufverfolgungen
- Feedback zu UIP-Ablaufverfolgungen
- Migration
- Referenz und Support
Installieren der UiPath CLI
Installationsanforderungen und -schritte für UiPath CLI unter Windows, macOS und Linux, einschließlich Node.js-Voraussetzungen und npm-Globalinstallation.
Die UiPath CLI wird auf npm als @uipath/cli verteilt und installiert den Befehl uip global. Es läuft auf jeder Plattform, die von Node.js 22 oder höher unterstützt wird – Windows, macOS und Linux, sowohl auf x64 als auch auf ARM64.
Voraussetzungen
- Node.js 22 oder höher. Node.js wird mit
npmausgeliefert, was ausreicht, umuipzu installieren und auszuführen. - Beliebige Plattform – Windows (x64, ARM64), macOS (x64, ARM64), Linux (x64, ARM64).
Überprüfen Sie Ihre Node-Version:
node --version
node --version
Wenn Node.js älter als 22 ist oder nicht installiert ist, laden Sie es von Nodejs.org herunter oder verwenden Sie einen Versionsmanager wie nvm (macOS/Linux) oder nvm-windows – oder lassen Sie das einzeilige Installationsprogramm unten Node für Sie bereitstellen .
Installieren
Schnellinstallation (Einzeiler)
Der schnellste Weg zu einem funktionierenden uip. Es stellt Node.js sicher, installiert die CLI, führt uip skills install aus (erkennt automatisch, welche Codierungsagents – Claude Code, Cursor, Copilot usw. – auf der Maschine vorhanden sind) und installiert .NET SDK 8.0 und Python. Jeder Schritt ist idempotent, sodass das Skript sicher erneut ausgeführt werden kann – es überspringt alles, was bereits vorhanden ist.
# macOS / Linux
curl -fsSL https://download.uipath.com/uipath-cli/install.sh | bash
# macOS / Linux
curl -fsSL https://download.uipath.com/uipath-cli/install.sh | bash
# Windows (PowerShell)
irm https://download.uipath.com/uipath-cli/install.ps1 | iex
# Windows (PowerShell)
irm https://download.uipath.com/uipath-cli/install.ps1 | iex
Überspringen Sie nicht gewünschte Teile. Jede Option hat eine übereinstimmende Umgebungsvariable, die für die Pipe-Form nützlich ist (bash -s -- --flag funktioniert nicht immer gut mit jeder Shell):
| macOS/Linux-Flag | Windows PowerShell-Schalter | Umgebungsvariable | Auswirkung |
|---|---|---|---|
--dry-run | -DryRun | UIP_DRY_RUN | Gibt aus, was ausgeführt werden würde; ändert nichts. |
--skip-runtimes | -SkipRuntimes | UIP_SKIP_RUNTIMES | Überspringt die Installation von.NET SDK und Python. |
--skip-node | -SkipNode | UIP_SKIP_NODE | Lässt Node.js unberührt. |
--skip-skills | -SkipSkills | UIP_SKIP_SKILLS | Überspringt uip skills install. |
--skip-dotnet | -SkipDotnet | UIP_SKIP_DOTNET | Überspringt die.NET SDK-Installation. |
--skip-python | -SkipPython | UIP_SKIP_PYTHON | Überspringt die Python-Installation. |
# Preview first — prints what it would do, changes nothing
curl -fsSL https://download.uipath.com/uipath-cli/install.sh | bash -s -- --dry-run
# CLI + skills only, no .NET / Python
curl -fsSL https://download.uipath.com/uipath-cli/install.sh | bash -s -- --skip-runtimes
# Preview first — prints what it would do, changes nothing
curl -fsSL https://download.uipath.com/uipath-cli/install.sh | bash -s -- --dry-run
# CLI + skills only, no .NET / Python
curl -fsSL https://download.uipath.com/uipath-cli/install.sh | bash -s -- --skip-runtimes
Manuelle Installation
Wenn Sie Node bereits selbst verwalten oder nur die CLI ohne die Fähigkeiten/.NET-/Python-Bereitstellung des One-Lineners möchten:
npm install -g @uipath/cli
npm install -g @uipath/cli
Oder mit einem anderen Paketmanager:
pnpm add -g @uipath/cli
pnpm add -g @uipath/cli
bun add -g @uipath/cli
bun add -g @uipath/cli
Alle drei Paketmanager installieren dasselbe @uipath/cli -Paket aus der öffentlichen npm-Registrierung. Verwenden Sie diejenige, die Ihr Team bereits vorhanden hat. Wenn Ihr .npmrc den Paket-Namespace @uipath auf einen privaten Feed (GitHub-Pakete, ein Artifact-Proxy, …) begrenzt, gewinnt dieser Scope die Standardregistrierung und Sie erhalten den Build dieses Feeds anstelle des öffentlichen stabilen. Erzwingen Sie die öffentliche Registrierung für diese Installation mit:
npm install -g @uipath/cli --@uipath:registry=https://registry.npmjs.org/
npm install -g @uipath/cli --@uipath:registry=https://registry.npmjs.org/
Homebrew (macOS / Linux)
UiPath behält ein Homebrew-Tap bei. Dies ist ein völlig unabhängiger Installationspfad vom oben genannten Einzeiler und npm/pnpm/bun – Homebrew verwaltet die uip -Binärdatei und ihre Node.js-Abhängigkeit selbst.
brew install uipath/tap/uip
brew install uipath/tap/uip
Oder zuerst explizit darauf tippen:
brew tap uipath/tap
brew install uip
brew tap uipath/tap
brew install uip
Upgrade und Deinstallation folgen den normalen Homebrew-Konventionen:
brew upgrade uip
brew uninstall uip
brew upgrade uip
brew uninstall uip
Über uip tools install <tool> installierte Tools werden in das globale Präfix von npm (npm root -g) geschrieben, nicht in den Kalender von Homebrew – sie bleiben über brew upgrade uip hinweg bestehen. Um alles vollständig zu entfernen: brew uninstall uip && rm -rf "$(npm root -g)/@uipath".
Die Installation platziert die ausführbare Datei uip in Ihrer PATH. Unter Windows befindet sich das uip.cmd / uip.ps1 -Startprogramm unter %APPDATA%\npm\; Unter macOS und Linux befindet sich der uip -Launcher (ein kleines Läufen von node ./dist/index.js) unter dem Präfix, das von npm config get prefix gemeldet wird (normalerweise /usr/local/bin oder ~/.npm-global/bin).
Überprüfen der Installation
uip --version
uip --version
Sie sollten die installierte Versionsnummer sehen (z. B. 1.0.0).
uip --help
uip --help
Sie sollten eine Liste der Kernbefehle sehen – login (mit den Unterbefehlen status, tenant list, tenant set ), logout, tools, skills, mcp, completion – gefolgt von durch die Tools, die auf Ihrer Maschine installiert oder registriert wurden.
So bestätigen Sie, wo der uip -Launcher und seine Tools live sind:
npm root -g # directory holding @uipath/cli and installed tools
npm config get prefix # parent directory whose bin/ folder holds the uip launcher
npm root -g # directory holding @uipath/cli and installed tools
npm config get prefix # parent directory whose bin/ folder holds the uip launcher
Erster Befehl
UiPath CLI enthält nur den Host und einen kleinen Satz von Kernbefehlen. Es sind keine Tools vorinstalliert. Wenn Sie zum ersten Mal einen Befehl aufrufen, dessen Präfix mit einem Tool auf der Zulassungsliste für die automatische Installation übereinstimmt, lädt der Host dieses Tool automatisch von npm herunter und installiert es.
Wenn Sie beispielsweise zum ersten Mal einen Orchestrator-Befehl ausführen, installiert uip @uipath/orchestrator-tool:
uip or folders list
uip or folders list
Installing @uipath/orchestrator-tool...
✓ Installed @uipath/orchestrator-tool
...
Installing @uipath/orchestrator-tool...
✓ Installed @uipath/orchestrator-tool
...
Nachfolgende uip or ... -Aufrufe verwenden das installierte Tool direkt. Sie können Tools auch explizit mit uip tools install installieren – nützlich für CI-Ausführungen und eingeschränkte Netzwerke –
uip tools install @uipath/orchestrator-tool
uip tools install @uipath/solution-tool
uip tools install @uipath/orchestrator-tool
uip tools install @uipath/solution-tool
Die vollständige Zulassungsliste finden Sie unter Tools (Plugins) und unter Verwalten von Tools und Fähigkeiten für die tägliche Toolverwaltung.
Steuern der automatischen Installation des Tools
Die automatische Installation wird ausgeführt, wenn sich das aufgerufene Verb auf der weißen Liste befindet und das Tool noch nicht installiert ist. CI=true hat keine Auswirkungen darauf – diese Variable wird nirgendwo im Pfad für die automatische Installation abgefragt. Die echte Opt-out-Option ist UIPATH_CLI_DISABLE_AUTOINSTALL=true, die implizite Toolinstallationen vollständig deaktiviert, einschließlich der täglichen Aktualisierungsprüfung pro Tool, die in Versionierung und Stabilität beschrieben ist. Bei statuslosen CI-Ausführungen, ohne diese Variable vorzuinstallieren oder festzulegen, lädt der erste Befehl in einem Build sein Tool herunter, und spätere Befehle im selben Auftrag verwenden die bereits installierte Kopie wieder – wodurch der erste Befehl langsamer wird als die nachfolgenden.
Um CI-Erstellungszeiten deterministisch zu halten, installieren Sie die Tools, die Sie als separaten Schritt verwenden, vor, sodass sie bei jedem späteren uip -Aufruf bereits vorhanden sind:
uip tools install @uipath/orchestrator-tool @uipath/solution-tool
uip tools install @uipath/orchestrator-tool @uipath/solution-tool
Die automatische Installation ist ein No-Op, wenn das Tool bereits installiert ist, sodass der Vorinstallationsschritt die einzige Verhaltensänderung ist, die Sie benötigen. Legen Sie bei einem Air-Gap-Ausführungsmodell, bei dem Sie eine festes Namensgarantie möchten, dass nichts versucht, npm mitten im Build zu erreichen, auch UIPATH_CLI_DISABLE_AUTOINSTALL=true fest – ein Befehl für ein Tool, das noch nicht vorhanden ist, schlägt dann sofort fehl, anstatt einen Downloadversuch zu versuchen.
Aktivieren Sie die Shell-Vervollständigung
Die UiPath CLI stellt Registerkartenvervollständigung für bash, zsh, fish und pwsh bereit. Die Vervollständigung wird innerhalb der CLI selbst installiert:
uip completion
uip completion
In einem Terminal erkennt uip completion Ihre Shell von $SHELL / $PSModulePath / platform, gibt die Ziel-RC-Datei aus, die geändert werden soll, und fragt nach der Bestätigung. Akzeptieren Sie die Eingabeaufforderung und öffnen Sie Ihre Shell erneut – uip <TAB> schließt jetzt Unterbefehle und Optionen ab.
Für die skriptbasierte Einrichtung leiten Sie das Vervollständigungsskript direkt in Ihre rc-Datei:
# zsh
uip completion zsh >> ~/.zshrc
# bash
uip completion bash >> ~/.bashrc
# fish
uip completion fish > ~/.config/fish/completions/uip.fish
# PowerShell
uip completion pwsh >> $PROFILE
# zsh
uip completion zsh >> ~/.zshrc
# bash
uip completion bash >> ~/.bashrc
# fish
uip completion fish > ~/.config/fish/completions/uip.fish
# PowerShell
uip completion pwsh >> $PROFILE
Weitere Optionen:
uip completion --print– Zeigen Sie eine Vorschau des Zielpfads und des Blocks an, ohne das Dateisystem zu ändern.uip completion --uninstall– Entfernen Sie den verwalteten Vervollständigungsblock.
Die dynamische Flag-Wert-Vervollständigung (z. B. uip or packages upload --package-name <TAB>) ist nur zsh und erfordert das jq Dienstprogramm auf Ihrem PATH. Ohne jq werden dynamische Kandidaten unterdrückt; Die statische Vervollständigung von Unterbefehlen und Optionsnamen funktioniert weiterhin auf allen vier Shells.
Führen Sie den Abschluss nach jedem CLI- oder Tool-Upgrade erneut aus
Das Vervollständigungsskript ist eine statische Momentaufnahme der Unterbefehle und Optionsnamen, die zum Zeitpunkt der Ausführung von uip completion bekannt sind. Führen Sie nach npm install -g @uipath/cli@<new-version>, uip tools install <new-tool> oder uip tools update uip completion erneut aus, damit neu hinzugefügte Befehle und Flags indiziert werden:
uip completion # interactive — refreshes the existing block
uip completion zsh >> ~/.zshrc # or pipe into the rc file directly
uip completion # interactive — refreshes the existing block
uip completion zsh >> ~/.zshrc # or pipe into the rc file directly
Ohne Aktualisierung werden neue Verben (z. B. ein Verb, das in einer Minor-Version eines Tools hinzugefügt wurde) nicht automatisch vervollständigt, obwohl sie in der Befehlszeile funktionieren.
Plattformhinweise
Windows
Führen Sie Befehle über PowerShell, Windows Terminal oder cmd aus. Wenn uip nach der Installation nicht erkannt wird, öffnen Sie ein neues Terminalfenster, damit das aktualisierte PATH wirksam wird, oder führen Sie Folgendes aus:
npm config get prefix
npm config get prefix
und bestätigen Sie, dass sich das zurückgegebene Verzeichnis auf Ihrem PATH befindet.
macOS und Linux
Die meisten Paketmanager platzieren die ausführbare uip -Datei auf der standardmäßigen PATH. Wenn Sie npm globals in einem benutzerlokalen Verzeichnis installieren (wie empfohlen – vermeidet sudo), stellen Sie sicher, dass sich dieses Verzeichnis auf Ihrem PATH befindet. Beispiel mit einem ~/.npm-global Präfix:
export PATH="$HOME/.npm-global/bin:$PATH"
export PATH="$HOME/.npm-global/bin:$PATH"
Fügen Sie die Zeile zu Ihrem Shell-Profil (~/.zshrc, ~/.bashrc usw.) hinzu, um sie beizubehalten.
Hinter einem Unternehmensproxy
Die UiPath CLI berücksichtigt die standardmäßigen HTTP-Proxy-Umgebungsvariablen sowohl für die CLI selbst als auch für die automatische Installation des Tools:
| Variable | Zweck |
|---|---|
HTTP_PROXY / http_proxy | Proxy für HTTP-Anforderungen |
HTTPS_PROXY / https_proxy | Proxy für HTTPS-Anforderungen |
NO_PROXY / no_proxy | Kommagetrennte Liste der Hosts, die den Proxy umgehen |
Beispiele:
# macOS / Linux
export HTTPS_PROXY=http://proxy.example.com:8080
export NO_PROXY=localhost,127.0.0.1,.internal.corp
uip login
# macOS / Linux
export HTTPS_PROXY=http://proxy.example.com:8080
export NO_PROXY=localhost,127.0.0.1,.internal.corp
uip login
# Windows PowerShell
$env:HTTPS_PROXY = "http://proxy.example.com:8080"
$env:NO_PROXY = "localhost,127.0.0.1,.internal.corp"
uip login
# Windows PowerShell
$env:HTTPS_PROXY = "http://proxy.example.com:8080"
$env:NO_PROXY = "localhost,127.0.0.1,.internal.corp"
uip login
:: Windows cmd
set HTTPS_PROXY=http://proxy.example.com:8080
set NO_PROXY=localhost,127.0.0.1,.internal.corp
uip login
:: Windows cmd
set HTTPS_PROXY=http://proxy.example.com:8080
set NO_PROXY=localhost,127.0.0.1,.internal.corp
uip login
Proxys mit Standardauthentifizierung werden unterstützt, indem Anmeldeinformationen in die URL aufgenommen werden: http://user:password@proxy.example.com:8080.
Die CLI enthält eine proxy-fähige fetch -Implementierung, sodass HTTPS_PROXY / HTTP_PROXY ohne zusätzliche Konfiguration auf Node.js berücksichtigt werden.
Telemetrie
Die UiPath CLI sendet anonyme Nutzungstelemetrie an UiPath, um das Produkt zu verbessern. Es werden keine Befehlsargumente, Dateiinhalte oder Anmeldeinformationen übertragen.
| Variable | Verhalten |
|---|---|
UIPATH_TELEMETRY_DISABLED | Stellen Sie 1 oder true um sich abzumelden. |
UIPATH_AI_CONNECTION_STRING | Überschreiben Sie die Application Insights-Verbindungszeichenfolge – zum Beispiel, um Telemetrie an Ihre eigene Instanz weiterzuleiten. |
# Opt out for the current shell
export UIPATH_TELEMETRY_DISABLED=1
# Or just for one command
UIPATH_TELEMETRY_DISABLED=1 uip login
# Opt out for the current shell
export UIPATH_TELEMETRY_DISABLED=1
# Or just for one command
UIPATH_TELEMETRY_DISABLED=1 uip login
Installieren in CI/CD
Installieren Sie die CLI als Schritt in Ihrer Pipeline. Da für uip keine Tools vorinstalliert sind, lassen Sie die Tools entweder bei der ersten Verwendung automatisch installieren oder installieren Sie sie explizit vor – Letzteres ist bei zustandslosen Ausführungen schneller, da der Download des Tools einmal pro Schritt und nicht bei jedem Befehl erfolgt.
GitHub-Aktionen
steps:
- uses: actions/setup-node@v4
with:
node-version: '22'
- name: Install UiPath CLI
run: npm install -g @uipath/cli
- name: Pre-install tools
run: uip tools install @uipath/orchestrator-tool @uipath/solution-tool
- name: Authenticate
run: uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET
env:
UIPATH_CLIENT_ID: ${{ secrets.UIPATH_CLIENT_ID }}
UIPATH_CLIENT_SECRET: ${{ secrets.UIPATH_CLIENT_SECRET }}
- name: Run CLI commands
run: uip or folders list --output json
steps:
- uses: actions/setup-node@v4
with:
node-version: '22'
- name: Install UiPath CLI
run: npm install -g @uipath/cli
- name: Pre-install tools
run: uip tools install @uipath/orchestrator-tool @uipath/solution-tool
- name: Authenticate
run: uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET
env:
UIPATH_CLIENT_ID: ${{ secrets.UIPATH_CLIENT_ID }}
UIPATH_CLIENT_SECRET: ${{ secrets.UIPATH_CLIENT_SECRET }}
- name: Run CLI commands
run: uip or folders list --output json
Azure DevOps
steps:
- task: NodeTool@0
inputs:
versionSpec: '22.x'
displayName: 'Use Node.js 22'
- script: npm install -g @uipath/cli
displayName: 'Install UiPath CLI'
- script: uip tools install @uipath/orchestrator-tool @uipath/solution-tool
displayName: 'Pre-install UiPath CLI tools'
- script: uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET
displayName: 'Authenticate'
env:
UIPATH_CLIENT_ID: $(UIPATH_CLIENT_ID)
UIPATH_CLIENT_SECRET: $(UIPATH_CLIENT_SECRET)
steps:
- task: NodeTool@0
inputs:
versionSpec: '22.x'
displayName: 'Use Node.js 22'
- script: npm install -g @uipath/cli
displayName: 'Install UiPath CLI'
- script: uip tools install @uipath/orchestrator-tool @uipath/solution-tool
displayName: 'Pre-install UiPath CLI tools'
- script: uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET
displayName: 'Authenticate'
env:
UIPATH_CLIENT_ID: $(UIPATH_CLIENT_ID)
UIPATH_CLIENT_SECRET: $(UIPATH_CLIENT_SECRET)
Jenkins (deklarative Pipeline)
stage('Install UiPath CLI') {
steps {
sh 'npm install -g @uipath/cli'
sh 'uip tools install @uipath/orchestrator-tool @uipath/solution-tool'
}
}
stage('Authenticate') {
steps {
withCredentials([
string(credentialsId: 'UIPATH_CLIENT_ID', variable: 'UIPATH_CLIENT_ID'),
string(credentialsId: 'UIPATH_CLIENT_SECRET', variable: 'UIPATH_CLIENT_SECRET')
]) {
sh 'uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET'
}
}
}
stage('Install UiPath CLI') {
steps {
sh 'npm install -g @uipath/cli'
sh 'uip tools install @uipath/orchestrator-tool @uipath/solution-tool'
}
}
stage('Authenticate') {
steps {
withCredentials([
string(credentialsId: 'UIPATH_CLIENT_ID', variable: 'UIPATH_CLIENT_ID'),
string(credentialsId: 'UIPATH_CLIENT_SECRET', variable: 'UIPATH_CLIENT_SECRET')
]) {
sh 'uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET'
}
}
}
Vollständige Pipeline-Beispiele, einschließlich Pack-, Veröffentlichungs- und Testphasen, finden Sie unter CI/CD-Referenzen .
Zwischenspeichern Sie das globale npm-Verzeichnis zwischen Builds, um zu vermeiden, dass @uipath/cli und seine Tools bei jeder Ausführung neu installiert werden müssen. Verwenden Sie bei GitHub Actions den Schlüssel actions/cache für die CLI-Version, die Sie anheften.
Installieren über die GitHub-npm-Registrierung
Die meisten Benutzer benötigen diesen Abschnitt nicht – die oben genannten Einzeiler- und manuellen Installationen rufen @uipath/cli und jedes auf die weiße Liste gesetzte Tool aus der öffentlichen npm-Registrierung ab. Es ist für zwei begrenzte Fälle vorhanden, die beide von derselben GitHub-npm-Registrierung (https://npm.pkg.github.com) bereitgestellt werden:
- Alpha-/interne Builds von
@uipath/skills(Versionen wie@uipath/skills@<version>-alpha.*), die Transitiv installiert werden, wennuip skills installeinen neueren Build als auf dem öffentlichen NPM benötigt. - Vorschau/interne Builds einer Handvoll Kernpakete –
cli,solution-tool,codedagent-tool,orchestrator-tool– veröffentlicht in GitHub-Paketen vor ihrer öffentlichen npm-Veröffentlichung.
Bevor uip tools install (oder uip skills install) eine davon lösen kann, konfigurieren Sie npm so, dass der @uipath -Scope durch die GitHub-Registrierung weitergeleitet wird.
Erstellen (oder aktualisieren) Sie ~/.npmrc (Benutzerebene) oder ./.npmrc (Projektebene) mit:
@uipath:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GH_NPM_REGISTRY_TOKEN}
@uipath:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GH_NPM_REGISTRY_TOKEN}
GH_NPM_REGISTRY_TOKEN ist ein persönliches GitHub-Zugriffstoken (klassisch) mit mindestens dem Scope read:packages, das für SSO gegenüber der UiPath-Organisation autorisiert ist.
export GH_NPM_REGISTRY_TOKEN=<your-pat>
npm install -g @uipath/cli
export GH_NPM_REGISTRY_TOKEN=<your-pat>
npm install -g @uipath/cli
Nach der Konfiguration nehmen uip tools install und uip tools update von GitHub registrierte Pakete auf die gleiche Weise wie öffentliche Pakete auf.
Dies hat nichts mit @uipath/rpa-tool zu tun, dessen eigentliche Quelle und Verteilung sich in einem separaten Repository (UiPath/Studio) befindet – die hier beschriebene GitHub-npm-Registrierung enthält nur die oben aufgeführten Alpha-/Vorschau-Builds.
Wird ohne globale Installation ausgeführt
Für die Ad-hoc-Verwendung oder Pipelines, die nicht global installiert werden sollen, können Sie die CLI über npx ausführen:
npx -y @uipath/cli <command>
npx -y @uipath/cli <command>
Zum Beispiel:
npx -y @uipath/cli login
npx -y @uipath/cli or folders list
npx -y @uipath/cli login
npx -y @uipath/cli or folders list
Beim ersten Aufruf wird das Paket heruntergeladen; Nachfolgende Aufrufe verwenden den npm-Cache wieder.
Upgrades
Die CLI aktualisiert sich automatisch, einmal pro Tag. Der erste in Frage kommenden uip Befehl jeden Tag sucht nach einer neueren Version auf Ihrem konfigurierten Kanal (standardmäßig stable – siehe core.updateChannel in uip config), installiert sie, wenn eine vorhanden ist, und führt Ihren ursprünglichen Befehl auf der neuen erneut aus werden. Es erkennt, wie Sie uip (Homebrew keg, npm, pnpm oder bun global) installiert haben, und gibt den entsprechenden Upgrade-Befehl automatisch aus – brew upgrade uip für eine Homebrew-Installation, der entsprechende add/install -Befehl andernfalls. Diese Selbstaktualisierung wird nie von selbst in eine neue MaJOR-Version übergehen – das erfordert immer ein explizites uip update oder einen Versionsheft. Pro Tool wird bei der ersten Verwendung dieses Tools an jedem Tag eine separate Prüfung ausgeführt, wobei es auf der eigenen Zeile der CLI auf die neueste Version aktualisiert wird. Beide Prüfungen werden durch Festlegen von UIPATH_CLI_DISABLE_VERSION_SYNC=true vollständig deaktiviert – nützlich für Air-Gap-Ausführungen oder Pipelines, die einen vollständig deterministischen, netzwerkfreien uip -Aufruf erfordern.
Die folgenden manuellen Befehle funktionieren weiterhin – um sofort zu einer bestimmten Version zu springen, zum Anheften oder mit deaktivierter täglichen Synchronisierung. Verwenden Sie diejenige, die mit der Installation von uip übereinstimmt:
# npm
npm install -g @uipath/cli@latest # latest release
npm install -g @uipath/cli@1.0.0 # pinned version
# pnpm
pnpm add -g @uipath/cli@latest
# bun
bun add -g @uipath/cli@latest
# Homebrew
brew upgrade uip
# npm
npm install -g @uipath/cli@latest # latest release
npm install -g @uipath/cli@1.0.0 # pinned version
# pnpm
pnpm add -g @uipath/cli@latest
# bun
bun add -g @uipath/cli@latest
# Homebrew
brew upgrade uip
Homebrew wird immer auf die Version aktualisiert, die der Tap gerade veröffentlicht – das Anheften einer genauen Version ist kein Homebrew-Konzept, also verwenden Sie eine der anderen Methoden, wenn Sie anheften müssen.
Heften Sie eine genaue Version in CI an. @uipath/cli folgt der semantischen Versionierung, aber die Form von Data in der JSON-Ausgabe ist befehlsspezifisch und kann sich zwischen minor-Versionen ändern (siehe Versionierung und Stabilität). Durch das Anheften werden Überraschungen während der Erstellung bei Pipelines vermieden, die JSON analysieren. Wenn Sie eine Erhöhung erfahren, validieren Sie Skripts, die von bestimmten Feldnamen abhängen, erneut.
Was sich zwischen Versionen geändert hat, erfahren Sie in den Versionshinweisen .
Beim Upgraden des Hosts werden installierte Tools nicht automatisch aktualisiert. So aktualisieren Sie Tools:
uip tools update # update all installed tools
uip tools update --name <package> # update a single tool
uip tools update --name <package> --version <version> # pin to a specific version
uip tools update # update all installed tools
uip tools update --name <package> # update a single tool
uip tools update --name <package> --version <version> # pin to a specific version
Standardmäßig verfolgt jede Toolversion die MaJOR.MINOR-Zeile der CLI, sodass bei Ausführung von uip tools update nach einem CLI-Upgrade jedes installierte Tool in Schritt ausgeführt wird. Für den Anheftvertrag siehe Tools (Plugins) .
Deinstallieren
Entfernen Sie die CLI mit der Methode, die Sie zum Installieren verwendet haben:
npm uninstall -g @uipath/cli
# or
pnpm remove -g @uipath/cli
# or
bun remove -g @uipath/cli
# or, if installed via Homebrew
brew uninstall uip
npm uninstall -g @uipath/cli
# or
pnpm remove -g @uipath/cli
# or
bun remove -g @uipath/cli
# or, if installed via Homebrew
brew uninstall uip
Dadurch wird die ausführbare Datei uip entfernt. Installierte Tools (@uipath/orchestrator-tool und ähnliche) live im globalen Präfix von npm, unabhängig von der Methode, die der Host installiert hat, und werden nicht automatisch entfernt – führen Sie uip tools uninstall <tool> zuerst aus oder löschen Sie $(npm root -g)/@uipath anschließend, um alles auf einmal zu löschen.
Entfernen Sie Anmeldeinformationen und Daten
Die Deinstallation des Pakets lässt mehrere Teile des Status auf dem Datenträger zurück. Bereinigen Sie sie manuell, wenn Sie einen Neustart möchten oder eine Maschine außer Betrieb nehmen müssen.
Sitzungsanmeldeinformationen
uip login behält die Sitzung standardmäßig innerhalb von ~/.uipath/ in Ihrem Basisverzeichnis bei. Wenn die CLI gestartet wird, verlässt sie das aktuelle Verzeichnis und sucht zuerst nach einem Ordner .uipath/ – damit ein Projektordner seine eigene Sitzung übertragen kann, ohne das Basisverzeichnis des Benutzers zu ändern. Überprüfen Sie beide Speicherorte beim Bereinigen:
# macOS / Linux
rm -rf ~/.uipath
# Windows PowerShell
Remove-Item -Recurse -Force "$env:USERPROFILE\.uipath"
# macOS / Linux
rm -rf ~/.uipath
# Windows PowerShell
Remove-Item -Recurse -Force "$env:USERPROFILE\.uipath"
Überprüfen Sie auch jedes Projekt, an dem Sie gearbeitet haben, für ein lokales .uipath/ . Das vollständige Layout finden Sie unter Sitzungen und Anmeldeinformationen .
Shell-Vervollständigung
Wenn Sie uip completion ausgeführt haben, befindet sich der Vervollständigungsblock nach der Deinstallation immer noch in Ihrer Shell-RC-Datei. Entfernen Sie es, bevor Sie @uipath/cli deinstallieren, oder bereinigen Sie es manuell über ~/.zshrc, ~/.bashrc oder $PROFILE:
# Before uninstalling, while uip is still available:
uip completion --uninstall
# Before uninstalling, while uip is still available:
uip completion --uninstall
npm: globaler Cache
npm speichert einen lokalen Cache heruntergeladener Tarballs an dem von npm config get cache gemeldeten Pfad. Dies muss für die meisten Benutzer nicht bereinigt werden; bereinigen, um Speicherplatz wiederherzustellen oder einen beschädigten Download zu beheben:
npm cache clean --force
npm cache clean --force
Fehlersuche und ‑behebung
uip: Befehl nach der Installation nicht gefunden
Das globale Verzeichnis „npm“ befindet sich nicht auf Ihrem PATH. Führen Sie npm config get prefix aus, um zu sehen, wo npm das uip -Startprogramm platziert hat, und fügen Sie dann den bin -Unterordner dieses Verzeichnisses zu Ihrem PATH hinzu und öffnen Sie ein neues Terminal.
ECCES- oder Berechtigungsfehler bei der Installation
Vermeiden Sie unter macOS und Linux sudo npm install. Konfigurieren Sie npm so, dass einmal ein benutzerlokales Präfix verwendet wird:
mkdir -p ~/.npm-global
npm config set prefix ~/.npm-global
export PATH="$HOME/.npm-global/bin:$PATH"
mkdir -p ~/.npm-global
npm config set prefix ~/.npm-global
export PATH="$HOME/.npm-global/bin:$PATH"
Dann neu installieren: npm install -g @uipath/cli.
Die automatische Installation des Tools hängt sich auf oder Zeitüberschreitung
Möglicherweise befinden Sie sich hinter einem Proxy, der npm blockiert. Konfigurieren Sie HTTPS_PROXY wie unter einem Unternehmensproxy beschrieben oder installieren Sie die Tools auf einer Maschine mit Internetzugang vor und kopieren Sie die globale node_modules auf die Zielmaschine.
Knotenversion zu alt
uip erfordert Node.js 22 oder höher. Aktualisieren Sie Node.js oder wechseln Sie die Versionen mit nvm use 22.
Weitere Fehler und deren Lösungen finden Sie unter Fehlerbehebung .
Nächste Schritte
- Schnellstart – Melden Sie sich an, listen Sie die Orchestrator-Ordner auf und führen Sie einen Auftrag in fünf Minuten aus.
- Ihre erste Pipeline – Packen Sie ein Projekt und stellen Sie es über CI bereit.
- Authentifizierung – Interaktive Anmeldung, Anmeldeinformationen des externen App-Clients, Verbund-/Workload-Identität und Umgebungsvariablenauthentifizierung für CI.
- Verwenden von UiPath CLI mit Codierungs-Agents – Installieren Sie Fähigkeiten in Claude Code, Cursor, GitHub Copilot und anderen unterstützten KI-Codierungs-Agents.
- Voraussetzungen
- Installieren
- Schnellinstallation (Einzeiler)
- Manuelle Installation
- Homebrew (macOS / Linux)
- Überprüfen der Installation
- Erster Befehl
- Steuern der automatischen Installation des Tools
- Aktivieren Sie die Shell-Vervollständigung
- Plattformhinweise
- Windows
- macOS und Linux
- Hinter einem Unternehmensproxy
- Telemetrie
- Installieren in CI/CD
- GitHub-Aktionen
- Azure DevOps
- Jenkins (deklarative Pipeline)
- Installieren über die GitHub-npm-Registrierung
- Wird ohne globale Installation ausgeführt
- Upgrades
- Deinstallieren
- Entfernen Sie Anmeldeinformationen und Daten
- Sitzungsanmeldeinformationen
- Shell-Vervollständigung
- npm: globaler Cache
- Fehlersuche und ‑behebung
- uip: Befehl nach der Installation nicht gefunden
- ECCES- oder Berechtigungsfehler bei der Installation
- Die automatische Installation des Tools hängt sich auf oder Zeitüberschreitung
- Knotenversion zu alt
- Nächste Schritte