UiPath Documentation
uipath-cli
latest
false
Wichtig :
Dieser Inhalt wurde maschinell übersetzt. Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

UiPath-CLI-Benutzerhandbuch

Ihre erste Pipeline

Auf dieser Seite wird gezeigt, wie Sie eine UiPath-Lösung auf der Festplatte nehmen und sie durchgängig an Orchestrator versenden: Packen Sie sie lokal, veröffentlichen Sie sie im Lösungsfeed Ihres Mandanten und stellen Sie sie in einem Ordner bereit. Es verwendet das Tool solution , das über einen Entwickler-Laptop und eine CI-Pipeline identisch funktioniert.

Was Sie benötigen

  • UiPath CLI installiert und eine angemeldete Sitzung. Siehe Installieren von UiPath CLI und Authentifizierung.
  • Eine UiPath -Lösung auf dem Datenträger. uip solution pack akzeptiert eine von zwei Formen (entsprechend der eigenen solution pack --help der CLI):
    • ein Lösungsverzeichnis, das einen .uipx -Lösungsdeskriptor enthält (der häufigste Fall – was Studio schreibt und was uip solution new erstellt), oder
    • eine eigenständige .uis -Datei (ein vorab gebündeltes Lösungsartefakt).
  • Ein Orchestrator-Ordnerpfad, in dem die Lösung bereitgestellt werden soll (z. B. Shared/MySolutionFolder).

Der Fluss

Drei Befehle, jeweils ein separater Schritt, sodass Sie sie unabhängig in einer CI-Pipeline ausführen können:

  1. uip solution pack – erstellen Sie ein versioniertes .zip -Paket aus dem Lösungsverzeichnis.
  2. uip solution publish – Laden Sie die .zip in den Lösungsfeed des Mandanten hoch.
  3. uip solution deploy run – Erstellen Sie einen Ordner und stellen Sie das veröffentlichte Paket in Orchestrator bereit.

Schritt 1. Packen der Lösung

uip solution pack ./my-solution ./dist \
  --name my-solution \
  --version 1.0.0
uip solution pack ./my-solution ./dist \
  --name my-solution \
  --version 1.0.0

Argumente:

  • Das erste Positionsargument ist das Lösungsverzeichnis (oder eine .uis -Datei).
  • Das zweite ist das Ausgabeverzeichnis. uip erstellt ihn, wenn er fehlt.

Flaggen:

  • --name überschreibt den Paketnamen (Standard: der Lösungsverzeichnisname).
  • --version Legt die Paketversion fest (Standard: 1.0.0). Verwenden Sie die semantische Versionierung für die Lesbarkeit und damit die Versionen im Orchestrator korrekt sortiert werden.

Bei Erfolg wird ./dist/my-solution.1.0.0.zip geschrieben. Die JSON-Antwort gibt Data.Package (formatiert als name@version) und Data.Packages (die inneren .nupkg -Dateinamen) zurück. Der .zip -Pfad selbst folgt der Konvention {outputDir}/{name}.{version}.zip, sodass Pipelines ihn erstellen können, ohne JSON zu analysieren:

NAME=my-solution
VERSION=1.0.0
uip solution pack ./my-solution ./dist --name "$NAME" --version "$VERSION"
PACKAGE="./dist/${NAME}.${VERSION}.zip"
NAME=my-solution
VERSION=1.0.0
uip solution pack ./my-solution ./dist --name "$NAME" --version "$VERSION"
PACKAGE="./dist/${NAME}.${VERSION}.zip"

Schritt 2. Für den Mandanten veröffentlichen

uip solution publish ./dist/my-solution.1.0.0.zip
uip solution publish ./dist/my-solution.1.0.0.zip

Das Paket wird in den Lösungsfeed des Mandanten hochgeladen. Der Orchestrator weist eine PackageVersionKey – die Identität dieser bestimmten Version auf dem Mandanten zu. publish ist idempotent für (name, version) – das erneute Ausführen mit derselben Version gibt die vorhandene Version zurück, anstatt ein Duplikat zu erstellen.

Tipp:

Wenn Sie für einen bestimmten Mandanten aus einer Organisation mit mehreren Mandanten ausgeführt werden, übergeben Sie --tenant <tenant-name> an publish. pack ist mandantenagnostisch. Im Zweifelsfall zeigt uip login status den Mandanten an, an den die CLI derzeit gebunden ist.

Schritt 3. Im Orchestrator bereitstellen

uip solution deploy run \
  --name MyFirstDeployment \
  --package-name my-solution \
  --package-version 1.0.0 \
  --folder-name MySolutionFolder \
  --folder-path Shared
uip solution deploy run \
  --name MyFirstDeployment \
  --package-name my-solution \
  --package-version 1.0.0 \
  --folder-name MySolutionFolder \
  --folder-path Shared

Flags (erforderlich, sofern nicht angegeben):

  • --name – der Bereitstellungsname (nicht der Paketname). Verwenden Sie etwas Aussagekräftiges; Dadurch wird die Bereitstellung für zukünftige deploy status / deploy activate -Aufrufe identifiziert.
  • --package-name, --package-version – stimmen mit dem überein, was Sie in Schritt 2 veröffentlicht haben.
  • --folder-name – der Orchestrator-Ordner, der für diese Bereitstellung erstellt werden soll.
  • --folder-path – Der Pfad des übergeordneten Ordners. Shared ist der Mandantenstamm.
  • --folder-key – die GUID des übergeordneten Ordners Verwenden Sie dies anstelle von --folder-path wenn Sie die Bindung nach ID bevorzugen.

deploy run ruft Orchestrator ab, bis die Bereitstellung einen Endstatus erreicht (standardmäßiges Abruf-Timeout 360 Sekunden, anpassbar mit --timeout). Die Antwort enthält den Pfad des neuen Ordners und den Bereitstellungsschlüssel.

Hinweis:

--name und --folder-name sind zwei verschiedene Dinge. --name benennt den Bereitstellungsdatensatz; --folder-name benennen den neuen Orchestrator-Ordner, den die Bereitstellung erstellt. Es ist in Ordnung und üblich, für beide den gleichen Wert zu wählen.

Zusammenstellen in CI

#!/usr/bin/env bash
set -euo pipefail

uip login \
  --client-id env.UIPATH_CLIENT_ID \
  --client-secret env.UIPATH_CLIENT_SECRET \
  --tenant "$UIPATH_TENANT"

uip solution pack ./my-solution ./dist --version "$BUILD_VERSION"
uip solution publish "./dist/my-solution.$BUILD_VERSION.zip"
uip solution deploy run \
  --name "my-solution-$GIT_SHA" \
  --package-name my-solution \
  --package-version "$BUILD_VERSION" \
  --folder-name MySolutionFolder \
  --folder-path Shared
#!/usr/bin/env bash
set -euo pipefail

uip login \
  --client-id env.UIPATH_CLIENT_ID \
  --client-secret env.UIPATH_CLIENT_SECRET \
  --tenant "$UIPATH_TENANT"

uip solution pack ./my-solution ./dist --version "$BUILD_VERSION"
uip solution publish "./dist/my-solution.$BUILD_VERSION.zip"
uip solution deploy run \
  --name "my-solution-$GIT_SHA" \
  --package-name my-solution \
  --package-version "$BUILD_VERSION" \
  --folder-name MySolutionFolder \
  --folder-path Shared

Das Skript wird beim ersten Status ungleich Null beendet, sodass ein Fehler in einem Schritt den Build abbricht. uip gibt 0 bei Erfolg und 1 bei Fehler zurück; Befehle mit domänenspezifischer Semantik (z. B. uip tm wait, das 2 für das Timeout wiederverwendet) können andere Codes zurückgeben – siehe Exitcodes.

Nach der Bereitstellung

Wenn die Lösung bereitgestellt wird, verfügt der Orchestrator über einen Ordner (Shared/MySolutionFolder), einen Prozess pro bereitstellbarem Projekt in der Lösung und alle zugehörigen Ressourcen (Assets, Warteschlangen, Trigger). Sie können jetzt:

# confirm the folder exists
uip or folders list --all --path "Shared/MySolutionFolder"

# find the processes that were created
uip or processes list --folder-path "Shared/MySolutionFolder"

# start a job
uip or jobs start <process-key>

# inspect the deployment
uip solution deploy status --deployment-key <deployment-key>
# confirm the folder exists
uip or folders list --all --path "Shared/MySolutionFolder"

# find the processes that were created
uip or processes list --folder-path "Shared/MySolutionFolder"

# start a job
uip or jobs start <process-key>

# inspect the deployment
uip solution deploy status --deployment-key <deployment-key>

Was ist mit einem einzelnen Studio-Projekt?

Für ein einzelnes Studio-Projekt (ein Verzeichnis mit project.jsonkeine Lösung) ist die klassische Pipeline pack a .nupkgupload to a feedcreate a process. Dieser Flow verwendet Befehle von den Tools rpa und or :

uip rpa pack ./MyStudioProject ./dist
uip or packages upload ./dist/MyStudioProject.1.0.0.nupkg
uip or processes create \
  --name MyProcess \
  --package-key MyStudioProject \
  --package-version 1.0.0 \
  --folder-path Shared
uip rpa pack ./MyStudioProject ./dist
uip or packages upload ./dist/MyStudioProject.1.0.0.nupkg
uip or processes create \
  --name MyProcess \
  --package-key MyStudioProject \
  --package-version 1.0.0 \
  --folder-path Shared

Vollständige Flag-Listen finden Sie unter uip rpa und in den Orchestrator -Paketen und Prozessreferenzen .

Nächste Schritte

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support

Möchten Sie lernen? UiPath Academy

Haben Sie Fragen? UiPath-Forum

Auf dem neuesten Stand bleiben