- Überblick
- Erste Schritte
- Konzepte
- Verwenden der UiPath CLI
- UiPath für Codierungs-Agents
- Anleitungen
- CI/CD-Rezepte
- Befehlsreferenz
- Überblick
- Exitcodes
- Globale Optionen
- UIP-codierter Agent
- UIP-Dokumentation
- 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-Versionen
- Beispiel für einen Workflow abrufen
- Anwendung anzeigen
- Anzeigeelement
- Inspektionspaket
- install-data-fabric-entities
- Pakete installieren oder aktualisieren
- list-data-fabric-entities
- Beispiele für Listenworkflows
- Packen
- restore
- Ausführungsdatei installieren
- Suchvorlagen
- Studio starten
- Ausführung anhalten
- UIA
- UIP-Ablaufverfolgungen
- Migration
- Referenz und Support
UiPath-CLI-Benutzerhandbuch
uip rpa ist das RPA-Tool – die Brücke zwischen der CLI und einer UiPath Studio-Installation. Es verpackt Studio-Projekte in .nupkg -Archive, führt die Workflow-Analyse und den Compiler aus, erstellt und führt Projekte aus und macht die Studio-Vorgänge verfügbar, die von KI-Codierungs-Agents und dem Fähigkeiten-System verwendet werden.
Installieren Sie es mit uip tools install rpa oder rufen Sie uip rpa … auf und lassen Sie die automatische Installation ausführen. Das Installationsmodell finden Sie unter Tools (Plugins) und unter UIP-Tools finden Sie den Befehl, der die Toolinstallation verwaltet. rpa ist das Befehlspräfix Das zugrunde liegende Paket ist @uipath/rpa-tool.
Before running the packager verbs in CI or on a fresh machine, make sure your runtime and runner OS match the project flavor — see Prerequisites.
Befehle
Jedes uip rpa -Verb hat eine eigene Referenzseite. Für Live-Argumentlisten in Ihrer installierten Toolversion führen Sie uip rpa <verb> --help aus.
| Verb | Beschreibung |
|---|---|
add-test-data-entity | Fügen Sie eine Data Service-Entität als Datenquelle für einen Testfall hinzu. |
add-test-data-queue | Fügen Sie eine Testdatenwarteschlange aus dem Orchestrator als Datenquelle für einen Testfall hinzu. |
add-test-data-variation | Fügen Sie eine CSV-/Excel-Datei mit Datenvarianten zu einem Testfall hinzu. |
analyze | Führen Sie die Workflow-Analyse für ein Projekt mit einer Governance-Richtlinie aus. |
build | Kompilieren Sie ein Studio-Projekt, ohne ein .nupkg zu erstellen. |
create-project | Erstellen Sie ein neues Projekt basierend auf einer Vorlage. |
diff | Unterschiede zwischen zwei Dateien in einem Studio-Diff.-Fenster anzeigen. |
find-activities | Suchen Sie Aktivitäten, die einer Abfrage entsprechen, und optionale Tags. |
get-analyzer-rules | Listen Sie die aktivierten Workflow-Analyse-Regeln für das geöffnete Projekt auf. |
get-default-activity-xaml | Rufen Sie die XAML-Darstellung einer Aktivität mit Standardwerten ab. |
get-errors | Rufen Sie Diagnosen aus einer Datei oder dem gesamten Projekt ab, gefiltert nach Schweregrad. |
get-manual-test-cases | Rufen Sie manuelle Testfälle aus Test Manager ab. |
get-manual-test-steps | Rufen Sie manuelle Testschritte für eine Liste von Testfall-IDs ab. |
get-versions | Listen Sie verfügbare Versionen eines NuGet-Pakets über konfigurierte Feeds hinweg auf. |
get-workflow-example | Rufen Sie die XAML-Datei für ein Workflow-Beispiel nach Schlüssel ab. |
indicate-application | Geben Sie mit Studio eine Anwendung auf dem Bildschirm an. |
indicate-element | Geben Sie mit Studio ein UI-Element auf dem Bildschirm an. |
inspect-package | Überprüfen Sie die öffentliche API eines NuGet-Pakets per Spiegelung. |
install-data-fabric-entities | Fügen Sie Data Fabric-Entitätsbindungen für das aktive Projekt hinzu oder entfernen Sie sie. |
install-or-update-packages | Installieren oder aktualisieren Sie NuGet-Pakete im aktuellen Projekt. |
list-data-fabric-entities | Listen Sie Data Fabric-Entitäten auf, die für das aktive Projekt relevant sind. |
list-workflow-examples | Suchen Sie RPA-Workflow-Beispiele nach Dienst-Tag. |
pack | Verpacken Sie ein Studio-Projekt in ein .nupkg. |
restore | Laden Sie die in project.json deklarierten Abhängigkeiten herunter. |
run-file | Führen Sie einen Workflow/eine codierte Datei aus oder debuggen Sie sie. |
search-templates | Durchsuchen Sie Projektvorlagen in konfigurierten NuGet-Feeds. |
start-studio | Stellen Sie sicher, dass eine Studio-Instanz ausgeführt wird. |
stop-execution | Beenden Sie eine laufende Ausführung, die zuvor mit run-file gestartet wurde. |
uia | CLI-Untergruppe für UI-Automatisierung. |
list-instances ist ebenfalls registriert, ausgeblendet von --help – es listet die ausgeführten Studio-Instanzen auf, die für den Resolver sichtbar sind.
Zusammenfassung
uip rpa pack <project> [options]
uip rpa build <projectDir> [options]
uip rpa analyze <project> --governance-file-path <policy> [options]
uip rpa restore <project> [outputPath] [options]
uip rpa start-studio [options]
uip rpa <verb> [options]
uip rpa pack <project> [options]
uip rpa build <projectDir> [options]
uip rpa analyze <project> --governance-file-path <policy> [options]
uip rpa restore <project> [outputPath] [options]
uip rpa start-studio [options]
uip rpa <verb> [options]
Alle uip rpa -Verben berücksichtigen die globalen Optionen (--output, --output-filter, --log-level, --log-file). Es gelten die Standard -Exitcodes .
Die übergeordnete uip rpa -Gruppe akzeptiert eine kleine Reihe von Optionen, die von jedem Verb geteilt werden:
| Übergeordnete Option | Beschreibung |
|---|---|
--project-dir <path> | Projektverzeichnis, in dem das Verb arbeitet. Standardmäßig das aktuelle Arbeitsverzeichnis. |
--studio-dir <path> | Pfad zu einer Studio-Installation, wenn die Erkennung keinen automatisch finden kann. |
--robot-dir <path> | Pfad zu einem Roboter-Installationsverzeichnis. |
--timeout <seconds> | Maximale Wartezeit für den zugrunde liegenden Vorgang. Standard: 300. |
--verbose | Verbose-Protokollierung. |
Diese können vor oder nach dem Unterbefehlsnamen übergeben werden.
Oberfläche markieren
Die Seiten pro Verb dokumentieren die wichtigsten Optionen. Da rpa-tool den Studio-Packager integriert, folgt eine Handvoll Nischen-Package-Flags (Signaturing, NuGet-Quellenkonfiguration, Ausgabetypfilter) den nativen Flags des zugrunde liegenden Pakets – führen Sie uip rpa <verb> --help für eine Live-Installation aus, um den vollständigen Satz für Ihre Pakete anzuzeigen installierte Toolversion. Die Flag-Namen sind über die Toolversionen innerhalb der Zeile MaJOR.MINOR der CLI hinweg konsistent; Siehe Versionierung und Stabilität.
Nur Windows-Legacy-Wrapper
Ein gleichgeordnetes Tool, @uipath/rpa-legacy-tool (Alias rpa-legacy), umschließt die 2025.10 Legacy-.NET-CLI für Benutzer, die nur Windows-Funktionen benötigen, die noch nicht auf die plattformübergreifende uip rpa portiert wurden. Es macht uip rpa-legacy <verb> für package, validate, debug, find-package, find-activities und type-definition verfügbar. In der Dokumentation zur Legacy-.NET-CLI 2025.10 finden Sie die Flag-Referenz. rpa-legacy ist nur Windows; rpa deckt die moderne Oberfläche ab.
Voraussetzungen
Two environmental constraints govern when and where the packager verbs can run.
.NET runtime
The packager verbs (pack, build, analyze, restore) wrap the Studio packager and the workflow compiler — both .NET-backed. A runner that invokes them must have a .NET runtime available.
For the full context on why rpa-tool keeps a .NET dependency while the rest of the CLI runs on Node.js, see Breaking changes — Runtime change.
Runner OS for Windows projects
Studio projects come in two non-legacy flavors — Cross-platform (targetFramework: "Portable" in project.json) and Windows (targetFramework: "Windows"). The runner OS must match the project flavor:
- Cross-platform projects can be operated on from any OS — Windows, macOS, or Linux.
- Windows projects require a Windows runner, regardless of which verb you are running. The Linux and macOS toolchain cannot resolve the Windows-only references these projects pull in.
- Windows – Legacy-Projekte sind eine separate Kategorie – sie erfordern das Tool
uip rpa-legacy, das von Natur aus nur für Windows verfügbar ist.
Match the runner OS in your CI to the project flavor, or split the pipeline so cross-platform work runs on Linux/macOS and Windows project work runs on a Windows agent.
Siehe auch
- Tools (Plugins) – Modell für
@uipath/rpa-toolinstallieren. - Migration von der.NET CLI – vollständige Befehls-zu-Befehlszuordnung für die Paketerverben.
uip tools– Installieren und Verwalten von Tools.- Versionierung und Stabilität – Serververtrag für Tool-Releases.
- Fähigkeiten – wie KI-Codierungs-Agents
uip rpa-Verben steuern.