Installieren der UiPath CLI

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 18 oder höher unterstützt wird – Windows, macOS und Linux, sowohl auf x64 als auch auf ARM64.

Voraussetzungen

• Node.js 18 oder höher. Node.js wird mit npm ausgeliefert, was ausreicht, um uip zu installieren und auszuführen.
• Beliebige Plattform – Windows (x64, ARM64), macOS (x64, ARM64), Linux (x64, ARM64).

Überprüfen Sie Ihre Node-Version:

node --version

Wenn Node.js älter als 18 oder nicht installiert ist, laden Sie es von Nodejs.org herunter oder verwenden Sie einen Versionsmanager wie nvm (macOS/Linux) oder nvm-windows.

Installieren

NPM

npm install -g @uipath/cli

pnpm

pnpm add -g @uipath/cli

Hinweis:

Beide Paketmanager installieren dasselbe @uipath/cli -Paket aus der öffentlichen npm-Registrierung. Verwenden Sie diejenige, die Ihr Team bereits vorhanden hat.

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

Sie sollten die installierte Versionsnummer sehen (z. B. 1.0.0).

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

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

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

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. Es gibt kein Opt-out-Flag oder keine Umgebungsvariable – insbesondere deaktiviert CI=true nicht die automatische Installation. Bei zustandslosen CI-Ausführungen bedeutet dies, dass der erste Befehl in einem Build sein Tool herunterlädt und spätere Befehle im selben Auftrag die bereits installierte Kopie wiederverwenden. Das macht den ersten Befehl langsamer als die folgenden, es sei denn, Sie installieren ihn vor.

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

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.

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

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

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.

Hinweis:

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.

Warnung:

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

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

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"

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

# 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

Proxys mit Standardauthentifizierung werden unterstützt, indem Anmeldeinformationen in die URL aufgenommen werden: http://user:[e-mail]:8080.

Tipp:

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

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: '20'

  - 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: '20.x'
    displayName: 'Use Node.js 20'

  - 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'
    }
  }
}

Vollständige Pipeline-Beispiele, einschließlich Pack-, Veröffentlichungs- und Testphasen, finden Sie unter CI/CD-Referenzen .

Tipp:

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

Eine Teilmenge von @uipath/* Toolpaketen – derzeit @uipath/rpa-tool und @uipath/flow-tool – wird in der GitHub-npm-Registrierung (https://npm.pkg.github.com) und nicht in der öffentlichen npm-Registrierung veröffentlicht. Bevor uip tools install sie auflö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=${GITHUB_TOKEN}

GITHUB_TOKEN benötigt mindestens den Scope read:packages ; Für einen nicht authentifizierten Pull eines öffentlichen GitHub-Pakets kann die Tokenzeile weggelassen werden (Verhalten variiert je nach Paket – überprüfen Sie die Sichtbarkeit des Repositorys).

export GITHUB_TOKEN=<your-pat>
npm install -g @uipath/cli
uip tools install @uipath/rpa-tool

Nach der Konfiguration nehmen uip tools install und uip tools update von GitHub registrierte Pakete auf die gleiche Weise wie öffentliche Pakete auf.

Hinweis:

Das Hostpaket @uipath/cli selbst befindet sich in der öffentlichen npm-Registrierung. Nur die Tools, die in den Versionshinweisen als GitHub-registriert gekennzeichnet sind, benötigen das zusätzliche .npmrc.

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>

Zum Beispiel:

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

Installieren Sie das Paket mit demselben Befehl, den Sie für die Installation verwendet haben, neu und wählen Sie entweder die neueste Version oder eine angeheftete Version aus:

# latest release
npm install -g @uipath/cli@latest

# pinned version
npm install -g @uipath/cli@1.0.0

Der entsprechende pnpm-Befehl ist pnpm add -g @uipath/cli@latest.

Tipp:

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

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 dem Paketmanager, den Sie zum Installieren verwendet haben:

npm uninstall -g @uipath/cli
# or
pnpm remove -g @uipath/cli

Dadurch werden die ausführbare Datei uip und die installierten Tools entfernt.

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"

Ü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

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

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"

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 18 oder höher. Aktualisieren Sie Node.js oder wechseln Sie die Versionen mit nvm use 20.

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, externe App-Client-Anmeldeinformationen und Umgebungsvariablen-Authentifizierung für CI.
• Verwenden von UiPath CLI mit Codierungs-Agents – Installieren Sie Fähigkeiten in Claude Code, Cursor, GitHub Copilot oder Gemini CLI.