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

Migration: Flag-Umbenennungen

Auf dieser Seite werden einzelne uipcli -Flags ihren uip -Gegenstücken zugeordnet. Verwenden Sie es zusammen mit der Befehlszuordnung – die Befehlszuordnung zeigt, welches Verb aufgerufen werden soll; Auf dieser Seite wird gezeigt, was mit den einzelnen Flags in diesem Verb zu tun ist.

Flags sind nach Domäne gruppiert. Die Authentifizierung ist zuerst , da sie sich für jeden Befehl gleichzeitig ändert. Der Rest der Seite behandelt die Flags, die sich pro Verb unterscheiden – Paket-/Lösungsausgabe, Auftragsausführung, Testausführungsausgabe, Ablaufverfolgung und so weiter.

Legacy-Flag-Einträge spiegeln die öffentliche uipcli -Flag-Oberfläche wider, die für 2025.10 und früher dokumentiert wurde. Die Spalte uip entspricht den aktuellen Referenzseiten.

So lesen Sie die Spalte „Wo sie sich befindet“.

uip bietet Ihnen drei Stellen, an denen Sie einen Wert platzieren können, der ein Flag in uipcli war:

  • Flag bei jedem Befehl – übergeben Sie ihn jedes Mal wörtlich (--tenant <name>, --folder-path Shared).
  • Sitzungsstatus von uip login – das Flag ist zu etwas wurde, das Sie einmal mit uip login festgelegt haben; nachfolgende Befehle übernehmen sie automatisch. Überschreiben Sie pro Aufruf mit dem entsprechenden Flag.
  • Umgebungsvariable – wird zur Laufzeit von der CLI gelesen. Verwenden Sie gegebenenfalls die Form des Präfixes --client-id env.VARNAME / --client-secret env.VARNAME auf uip login , um das Geheimnis aus der Befehlszeile herauszuhalten.

In der Spalte „Wo es existiert“ erfahren Sie, welche davon zutrifft.

Authentication

Dies ist der Block, der sich am meisten ändert. Die Legacy-CLI akzeptierte drei Anmeldeinformationsmodi pro Befehl (Benutzer/Übergeben, Aktualisierungstoken, externe App). Die neue CLI akzeptiert nur externe Anmeldeinformationen und interaktives OAuth – Benutzer/Pass- und Aktualisierungstoken-Authentifizierung wurden entfernt. Siehe Durchschlagende Änderungen – Authentifizierungsmodi entfernt.

Externe Anwendung (der CI-Flow)

Legacy-FlagLegacy-Zweckuip MarkierenWo es existiertHinweise
-A, --accountForApp <name>Organisationsname für die externe App--organization <name>Markieren uip loginOft optional – die Organisation wird aus dem externen App-Datensatz abgeleitet. Übergeben Sie sie, wenn Sie mehrdeutig machen müssen.
-I, --applicationId <id>ID des externen App-Clients--client-id <id> (oder --client-id env.VARNAME )Markieren uip loginLesen Sie nach Möglichkeit env.VARNAME aus einer Umgebungsvariable.
-S, --applicationSecret <secret>Geheimer Clientschlüssel der externen App--client-secret <secret> (oder --client-secret env.VARNAME )Markieren uip loginVerwenden Sie immer das Präfix env. in CI, um zu vermeiden, dass das Geheimnis in den Shell-Verlauf und die ps -Ausgabe aufgenommen wird.
--applicationScope "<space-separated>"OAuth-Scopes--scope "<space-separated>" / -s, --scopeMarkieren uip loginDasselbe durch Leerzeichen getrennte Format. Legacy-Aufrufe listen in der Regel alle OR.* -Scopes auf; die gleiche Liste beibehalten.
--identityUrl <url>Benutzerdefinierte Identitätsautorität (Automation Suite /PaaS)--authority <url>Markieren uip loginUmbenannt; Semantik identisch. Für Automation Cloud auslassen.
(positional) <orchestrator_url>OrchestratorBaseURL(Implizit aus Sitzung)Das Flag auf uip login ist nicht erforderlich – die CLI löst die Orchestrator-URL aus dem Mandanten/der Organisation auf, der bei der Anmeldung ausgewählt wurde.
(positional) <orchestrator_tenant>Name des Mandanten-t, --tenant <name>Flag bei uip login (Standard) oder per Befehl -tEinmal bei der Anmeldung festgelegt, verwendet jeder nachfolgende Befehl diesen Mandanten; -t bei jedem Befehl überschreibt ihn für diesen einen Aufruf.
-o, --organizationUnit <folder>Standardordner für den Befehl--folder-path <path> oder --folder-key <guid>Kennzeichnen Sie den Befehl, der sie benötigtKein Konzept auf Sitzungsebene in uip; Übergeben Sie sie bei jedem jobs/processes/resource * -Aufruf. Konfigurationsdatei kann Standardeinstellungen anheften.

Benutzer-/Pass-Authentifizierung – entfernt

Legacy-FlagStatus in uip
-u, --username <user>Entfernt. Erstellen Sie eine externe Anwendung und verwenden Sie --client-id.
-p, --password <pass>Entfernt. Verwenden Sie --client-secret.

Die Legacy-CLI unterstützte die Benutzer-/Kennwort-Authentifizierung gegen den Orchestrator für Umgebungen, in denen eine externe App noch nicht bereitgestellt wurde. uip nicht; siehe Durchschlagende Änderungen – Authentifizierungsmodi entfernt.

Refresh-Token-Authentifizierung – entfernt

Legacy-FlagStatus in uip
-t, --token <refresh-token>Entfernt. Legacy -t war die Kurzform für --token; In uip ist -t die Kurzform für --tenant.
-a, --accountName <name>Entfernt. Verwenden Sie stattdessen --organization mit einer externen Anwendung.

Wenn eine Legacy-Pipeline die Refresh-Token-Authentifizierung verwendet hat, migrieren Sie zur Externen Anwendung. Die Automation Cloud stellt keinen Aktualisierungstoken-Flow mehr für neue Workloads bereit.

Token-in-Hand (neu – kein Legacy-Äquivalent)

Für Container oder Ausführungen, die bereits ein UiPath-Zugriffstoken enthalten und keine Anmeldeinformationen austauschen müssen, unterstützt uip die Authentifizierung mit Umgebungsvariablen: Legen Sie UIPATH_CLI_ENABLE_ENV_AUTH=true fest und übergeben Sie das Token + Organisation + Mandant über env vars. Siehe Authentifizierung – Flow 3. Es wird keine Datei geschrieben; Das Token wird nicht aktualisiert.

env.VAR_NAME-Präfix

uip login akzeptiert ein Literalgeheimnis in --client-id / --client-secret oder der env.VAR_NAME -Präfixform, die den Wert aus einer Umgebungsvariablen zur Laufzeit liest:

# Resolves at runtime from $UIPATH_CLIENT_SECRET; the secret never appears on the command line.
uip login \
  --client-id env.UIPATH_CLIENT_ID \
  --client-secret env.UIPATH_CLIENT_SECRET \
  --tenant "$UIPATH_TENANT"
# Resolves at runtime from $UIPATH_CLIENT_SECRET; the secret never appears on the command line.
uip login \
  --client-id env.UIPATH_CLIENT_ID \
  --client-secret env.UIPATH_CLIENT_SECRET \
  --tenant "$UIPATH_TENANT"

Im Gegensatz zu uipcli liest uip UIPATH_CLIENT_ID / UIPATH_CLIENT_SECRET nicht implizit; müssen Sie über das Präfix env. darauf verweisen (oder Literalwerte übergeben). Siehe Authentifizierung – Präfix env.VAR_NAME und Wichtige Änderungen – Implizites env-var-Lesen entfernt.

Ausgabe, Protokollierung und Ablaufverfolgung

Gilt für jedes uipcli -Verb.

Legacy-FlagLegacy-Zweckuip MarkierenWo es existiertHinweise
--traceLevel <None|Critical|Error|Warning|Information|Verbose>Protokollieren Sie die Ausführlichkeit--log-level <debug|info|warn|error>Globales Flag für jeden BefehlWertbereich auf vier Ebenen eingeschränkt; Standardmäßig info. Verbosedebug, Informationinfo, Warningwarn, alles andere → error. Siehe Globale Optionen.
(Legacy-Text standardmäßig; kein Flag)Strukturierte Ausgabe--output <json|table|yaml|plain>Globales FlagDer Standardwert ist json für jeden Befehl. gedruckter, visuell lesbarer Text der Vorgängerversion; uip gibt JSON aus. Verwenden Sie --output table für die menschliche Ansicht. Siehe Ausgabeformate.
(kein Äquivalent)Ausgabe nach dem Filtern--output-filter "<JMESPath>"Globales FlagNeu in uip. Ermöglicht es Pipelines, bestimmte Felder ohne Piping durch jq zu extrahieren.
(kein Äquivalent)Duplizieren Sie Protokolle in einer Datei--log-file <path>Globales FlagNeu in uip. Fügt JSON-Zeilen an.
-l, --language <locale>Protokollsprache(kein Äquivalent)Entfernt.Die Protokollausgabe ist Englisch in uip.
--captureCommandToJsonFile <path>Serialisieren Sie den Aufruf in JSON(kein Äquivalent)Entfernt.Wird für das Laufwerk uipcli run verwendet, das auch entfernt wird. Siehe Befehlszuordnung – Ausführen.

Paket-Flags

Legacy-PascalCase-Flags werden in uip rpa zu ke Anmelde-Case. Für jede Zeile unten ist das entsprechende uip rpa pack -Flag der Legacy-Name mit BinnenMajuskel, aufgeteilt in Wörter und verbunden mit - (z. B. --autoVersion--auto-version). Führen Sie uip rpa pack --help für die vollständige Liste Ihrer installierten Toolversion aus.

Paket packen

Legacy-Flaguip rpa packHinweise
<workspace_path> (positional)<project> (positional)Pfad zu project.json oder mit Verzeichnis.
-o, --output <dir>-o, --output <dir>Dieselbe Form. Ausgabeverzeichnis für die generierte .nupkg.
-v, --version <semver>-v, --version <semver>Legt die Paketversion fest.
--autoVersion--auto-versionVersion aus Datums-/Zeitstempel automatisch generieren.
--outputType <Process|Library|Tests|Objects>--output-type <Process|Library|Tests|Objects>Erzwingen Sie den Ausgabetyp.
--splitOutput--split-outputAufteilen von Runtime- und Designbibliotheken.
--releaseNotes <text>--release-notes <text>Eingebettet in die .nupkg -Metadaten.
--repositoryUrl, --repositoryCommit, --repositoryBranch, --repositoryType--repository-url, --repository-commit, --repository-branch, --repository-typeVCS-Metadaten.
--projectUrl <url>--project-url <url>URL der Automation Hub-Idee.
--certificatePath, --certificatePassword, --timestampServerUrl--certificate-path, --certificate-password, --timestamp-server-urlCodesignierung.
--author <name>--author <name>Paketautor.
--governanceFilePath <policy>--governance-file-path <policy>Analyse als Teil des Pakets ausführen.
Bibliotheksauthentifizierung (--libraryOrchestratorUrl, --libraryOrchestratorTenant, -u/-p/-t/-a/-A/-I/-S, --libraryOrchestratorApplicationScope, --libraryOrchestratorFolder, --libraryIdentityUrl, --libraryOrchestratorAccountForApp, --libraryOrchestratorAccountName, --libraryOrchestratorApplicationId, --libraryOrchestratorApplicationSecret, --libraryOrchestratorUsername, --libraryOrchestratorPassword, --libraryOrchestratorAuthToken)Sitzung aus uip loginAlle library* -Authentifizierungs-Flags werden in der einzigen Sitzung zusammengefasst, die von uip login konfiguriert wird. Das Paket ist offline, es sei denn, es muss Bibliotheksabhängigkeiten aus einem privaten Feed auflösen; In diesem Fall verwendet die CLI die aktive Sitzung.

Paketanalyse

Legacy-Flaguip rpa analyze
<workspace_path> (positional)<project> (positional)
--governanceFilePath <policy>--governance-file-path <policy>
--analyzerTraceLevel <Off|Error|Warning|Info|Verbose>(noch nicht dokumentiert)
--stopOnRuleViolation(noch nicht dokumentiert – wahrscheinlich ein Schwellenwert für den Schweregrad)
--treatWarningsAsErrors(noch nicht dokumentiert)
--resultPath <path>(noch nicht dokumentiert)
--ignoredRules <id1,id2>(noch nicht dokumentiert)

Paketbereitstellung

Legacy deploy besteht jetzt aus zwei uip -Aufrufen; siehe Befehlszuordnung – Paketbereitstellung. Pro-Flag:

Legacy-Flaguip gleichwertig istHinweise
<packages_path> (positional)<file> (positional auf uip or packages upload)Einzelne Datei. Führen Sie für einen Ordner mit .nupkgeine Schleife in der Shell durch.
<orchestrator_url> (positional)(Sitzung)Ablegen; bereitgestellt von uip login.
<orchestrator_tenant> (positional)-t, --tenant auf uip login oder dem BefehlStandardmäßig Sitzung.
-c, --createProcess <true|false>(implizit)uip or packages upload erstellt nie den Prozess. Rufen Sie uip or processes create nach dem Hochladen auf, wenn Sie einen Prozess möchten.
--processName <name>--name <name> ein uip or processes createUmbenannt; Hinweis: --process <name> ist auf der neuen CLI nicht vorhanden.
--processNames <csv>(Schleife in Shell – kein direktes Äquivalent)Skript der CSV-Iteration; Aufruf processes create pro Zeile.
--processDescription <text>-d, --description <text> ein uip or processes create
--use-package-description(Standardverhalten)processes create erbt die Paketbeschreibung beim Erstellen standardmäßig.
--ignoreLibraryDeployConflict(kein Äquivalent)Bibliotheksuploads über uip resource libraries upload schlagen bei einer doppelten Version fehl; Passen Sie die Pipelinelogik zum Überspringen an, wenn die Version bereits vorhanden ist.
-e, --environments <csv>(kein Äquivalent; nur moderne Ordner)Das Konzept der Legacy-Ordner „Umgebungen“ wird im Modell des modernen Ordners nicht dargestellt.
-h, --entryPointsPath <csv>--entry-point <path> ein uip or processes createEin einziger Einstiegspunkt pro Anruf; für Pakete mit mehreren Einstiegspunkten.

Paketwiederherstellung

Legacy-Flaguip rpa restore
<workspace_path> (positional)<project> (positional)
--restoreFolder <dir>[outputPath] (positional)
--nugetConfigFilePath <path>(noch nicht dokumentiert)
Authentifizierungs-Flags der BibliothekSitzung aus uip login

Auftrags-Flags (uipcli-Auftragsausführung → uip oder Jobs-Start)

Legacy-Flaguip or jobs startHinweise
<process_name> (positional)<process-key> (positional)GUID, nicht Name. Lösen Sie mit uip or processes list --name <name> --output-filter 'Data[0].Key' --output plain.
<orchestrator_url> (positional)(Sitzung)
<orchestrator_tenant> (positional)-t, --tenantStandardmäßig Sitzung.
-i, --input_path <file>--input-file <path> (Datei) oder --input-arguments '<json>' (inline)Zwei Alternativen, die sich gegenseitig ausschließen.
-P, --priority <Low|Normal|High>--job-priority <Low|Normal|High>
-j, --jobscount <n>--jobs-count <n>
-r, --robots <csv>(kein direktes Äquivalent)Nur klassischer Ordner in der Legacy-Version. Verwenden Sie --machine-keys oder --user-keys (GUIDs) für moderne Ordner.
-U, --user <user>--user-keys <guid[,guid]>Zuerst muss der Benutzername in eine Benutzer-GUID aufgelöst werden (uip or users list).
-M, --machine <hostname>--machine-keys <guid[,guid]>Zuerst muss der Hostname in eine Maschinen-GUID aufgelöst werden (uip or machines list).
-R, --result_path <file>(stdout umleiten oder --output-filter verwenden)uip Gibt den Auftragsumschlag in der Standardausgabe aus. uip or jobs start <key> --wait-for-completion > result.json schreibt den vollständigen Umschlag.
-W, --timeout <seconds>--timeout <seconds>Erfordert --wait-for-completion.
-f, --fail_when_job_fails <true|false>(immer an)Bei --wait-for-completion ist der Exitcode 1 , wenn der Auftrag Faulted endet. Keine Änderung möglich.
-w, --wait <true|false>--wait-for-completion (Flag)Das neue Formular ist ein boolesches Flag (kein Wert).
-b, --job_type <Unattended|NonProduction>--runtime-type <Unattended|Headless|Serverless|NonProduction|Development|TestAutomation>Breitere Aufzählung.
-o, --organizationUnit <folder>--folder-path <path> oder --folder-key <guid>Oder weglassen – uip leitet den Ordner aus dem Prozessschlüssel ab.

Test-Flags

uipcli-Testausführung → uip tm-Testsets ausführen + uip tm Wait + uip tm Report Get

Legacy-Flaguip targetHinweise
-s, --testset <name>--test-set-key <key> ein uip tm testsets runSchlüssel, nicht Name. Formatieren Sie PROJECT:NN. Lösen Sie mit uip tm testsets list --project-key <key>.
-t, --testsetkey <key>--test-set-key <key>Derselbe Wert. Hinweis: Legacy- -t konflikt mit -t, --tenant der neuen CLI; Verwenden Sie die lange Form.
-P, --project-path <project.json>(Nacharbeit)Der Legacy-Flow „Pack-and-Test-on-the-Fly“ ist aufgeteilt: uip rpa packuip or packages upload → Autorentestsatz im Test Manager → uip tm testsets run. Das Erstellen des Testsatzes ist ein einmaliges Setup.
-a, --projectKey <key>--project-key <key> unter uip tm wait / uip tm report getUnterschiedlich projectKey: der Legacy-Flag-Set projectKey für Test Manager; Das neue Flag beschränkt die Wartezeit/den Bericht auf ein Test Manager-Projekt. Derselbe zugrunde liegende Wert.
-e, --environment <name>(kein Äquivalent)Konzept des klassischen Ordners.
-o, --organizationUnit <folder>--folder-path <path> ein uip tm testsets listWird verwendet, um den Testsatz zu finden; nicht auf execute.
--out <junit|uipath>--output-format <junit|uipath> ein uip tm result downloadNach der Ausführung herunterladen.
-r, --result_path <file>--destination <path> ein uip tm result downloadNach der Ausführung herunterladen.
-w, --timeout <seconds>--timeout <seconds> ein uip tm waitDieselbe Semantik, anderes Verb.
-i, --input_path <file>--input-path <file> ein uip tm testsets runGenau das gleiche Flag; Das Schema für die JSON-Datei ist unverändert.
--attachRobotLogs( uip tm attachment download nach der Ausführung verwenden)
--retryCount <n>uip tm executions retry --execution-id <id>Führt fehlgeschlagene Fälle erneut aus. Keine automatische Wiederholung beim Start.
--repositoryUrl, --repositoryCommit, --repositoryBranch, --repositoryType, --projectUrl, --releaseNotes, --disableBuiltInNugetFeeds, --nugetConfigFilePath, --author(nicht auf uip tm)Dies waren Eingaben auf der Seite, wenn test run zuerst gepackt werden musste. Sie gehören zu uip rpa pack.

uicli-Test parallel

Legacy-Flaguip gleichwertig ist
--testsConfigurationFilePath <file>(kein Äquivalent) – schreibe eine Shell-Schleife über uip tm testsets run
--projectsRootDirectoryPath <dir>(kein Äquivalent)
--executionArtifactsDirectoryPath <dir>--destination <path> auf uip tm result download und uip tm attachment download, pro Ausführung ausführen
--cliDirectoryPath <uipcli.dll>(kein Äquivalent)
--out <junit|uipath>--output-format ein uip tm result download
--disableBuiltInNugetFeeds(Nicht auf uip tm; verwenden Sie uip rpa pack beim Packen von Testprojekten)
--projectKey <key>--project-key <key>
--author <name>(nicht auf uip tm)

Asset-Flags

Beide Legacy-Verben (asset deploy und asset delete) verbrauchen eine CSV-Datei; Die neue CLI hat keine Massenbereitstellung – Schleife über CSV-Zeilen und Aufruf uip resource assets create / delete pro Zeile. Siehe Befehlszuordnung – Asset.

Legacy-Flaguip gleichwertig istHinweise
<assets_file> (positional)(CSV in der Shell parsen)
<orchestrator_url> (positional)(Sitzung)
<orchestrator_tenant> (positional)-t, --tenant
CSV-Spalte name<name> (positional) auf uip resource assets create
CSV-Spalte value<value> (positional)
CSV-Spalte type--type <Text|Bool|Integer|Credential|Secret>Groß-/Kleinschreibung wird nicht beachtet.
CSV-Spalte description-d, --description <text>

Lösungs-Flags

Die Verbstruktur ist großteils erhalten; Flag-Namen wurden auf ke Kupität mit Groß- und Kleinschreibung normalisiert und der Authentifizierungsblock wurde auf die Sitzung reduziert.

Legacy-Flag (über Verben hinweg)uip gleichwertig istHinweise
-o, --output <dir> ein solution pack(positionelle <outputPath>)
-v, --version <semver> ein solution pack--version <semver>
-n, --name <name> ein solution pack--name <name>
Authentifizierungsblock (für jedes solution Verb, das den Orchestrator erreicht)Sitzung aus uip login
--packageName <n> ein solution deploy--package-name <n> ein uip solution deploy run
--packageVersion <v> ein solution deploy--package-version <v>
--folderName <n> ein solution deploy--folder-name <n>
Positional <deploymentName> auf solution deploy-activate / solution deploy-uninstall<deployment-name> unter uip solution deploy activate / uip solution deploy uninstall

Telemetrie und ausgeblendete Flags

Legacy-FlagStatus
-y, --disableTelemetry (Ausgeblendet)Ersetzt durch env var UIPATH_TELEMETRY_DISABLED=1. Siehe Neuigkeiten – Telemetrie.
--origin (Ausgeblendet)Entfernt.
--captureCommandToJsonFile (Ausgeblendet)Zusammen mit uipcli run entfernt.

Siehe auch

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