- Überblick
- Erste Schritte
- 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 Maestro-Erstellung
- UIP Maestro-Registrierung
- UIP-Modellhub
- Aktivitäten finden
- get-standard-xaml
- Analysieren
- Analyseregeln-Liste
- Erstellen
- Bereinigung
- data-fabric-entities installieren
- data-fabric-entities-Liste
- Dateien differenzieren
- Get-Library-Object-Repository
- Get-Object-Repository
- Init
- Instanzenliste
- Packen
- Pakete überprüfen
- Pakete installieren
- Paketversionen
- Veröffentlichen
- Remote
- restore
- Ausführen, Debuggen & Ausführung enthält
- Einstellungen
- Studio-Start
- Vorlagensuche
- Testdaten-Add-Entität
- Testdaten-Warteschlange hinzufügen
- Testdaten-Hinzufügevariante
- TM
- UIA
- Überprüfen
- Workflow-Beispiele abrufen
- Workflow-Beispiele
- UIP-Aufgaben
- Anhang
- benutzerdefiniertes Feld
- Defects
- Ausführungen
- Exportaufträge
- Migration
- Objektbeschriftung
- Packen
- perf-szenario
- Perf-Szenario-Lastgruppen
- Ausführungsdaten für perf-szenario
- Perf-Szenario-Bericht
- Projekt
- Projektberechtigungen
- Aufforderungen
- Melden
- Anforderungen
- Ergebnis
- Ausführen
- Zeitpläne
- Testfallprotokoll
- Testfälle
- Testsätze
- Testschrittprotokoll
- Benutzer
- Warten
- UIP-Ablaufverfolgungen
- Feedback zu UIP-Ablaufverfolgungen
- Migration
- Referenz und Support
UIP-Funktion
Syntax und Optionen für „uip-Function“, die UiPath JS/TS- und Python-Funktionen erstellt, bereitstellt, ausführt und veröffentlicht.
uip function erstellt, dient und veröffentlicht UiPath-Funktionen – kleine JS/TS- oder Python-Handler, die auf der UiPath-Plattform gepackt und ausgeführt werden. uip function ist der kanonische Gruppenname; uip functions (Plugin) wird als Alias akzeptiert.
Konzepte
- Dies ist ein Verteiler für Sprachen, kein natives Tool. Jedes Verb außer
setupist ein Thin-Forwarder: Die CLI erkennt die Sprache Ihres Projekts (vonuipath.json,package.jsonoderpyproject.tomlim aktuellen Verzeichnis oder--language/-laufnew) und Leitet die unformatierten Argumente entweder an eine JS/TS-CLI (@uipath/coded-functions-js-cli) im Prozess oder eine generierte Python-CLI weiter. Flags, die der Wrapper nicht deklariert, werden unverändert an die zugrunde liegende CLI weitergeleitet. - Die Sprachauflösung ist für
initundnewwichtig.initist nur Python – für JS/TS, Gerüst anstelle vonnew --empty.newerkennt automatisch; Wenn die Erkennung nicht eindeutig ist, wird standardmäßig TypeScript mit einer protokollierten Warnung verwendet, es sei denn, Sie übergeben--language js|ts|py/python. setupüberprüft die Toolketten. Es überprüft Node.js ≥20 für JS/TS-Projekte und Python mit demuipath-Paket für Python-Projekte. Die Node.js-Prüfung wird auch automatisch ausgeführt, bevornewan die JS/TS-CLI weitergeleitet wird. Befehle von Python-Funktionen schlagen mit einemConfigErrorfehl, das aufuip function setupverweist, bis Python konfiguriert ist.publishvs.pushzielen unterschiedliche Ziele ab:publishlädt das gepackte.nupkgin einen Orchestrator-Feed hoch;pushsynchronisiert das Projekt direkt mit einem Studio Web-Projekt. Beide akzeptieren--url/--org/--token(oder die übereinstimmendenUIPATH_URL/UIPATH_ORGANIZATION_NAME/UIPATH_ACCESS_TOKENenv-Variablen).- Automatische Registrierung der Lösung. Eine erfolgreiche Python-
initregistriert das Projekt automatisch in einer übergeordneten.uipx-Lösung, wenn eine vorhanden ist (dasselbe Muster wieagent/case/flowinit) – übergeben Sie--skip-solution-registration, um sich abzumelden. Dies meldet über einen separatenFunctionsInitSolutionRegistration-Erfolgsumschlag nach der eigenen Init-Ausgabe der zugrunde liegenden Python-CLI.
Zusammenfassung
uip function setup [--force]
uip function new [name] [--name <name>] [-l, --language ts|js|py] [--empty]
uip function init [--language py] [--skip-solution-registration]
uip function serve [--port <port>] [--runtime node|deno]
uip function run [name] [--input <json>] [--input-file <path>]
uip function pack
uip function push [--url <url>] [--project-id <id>] [--org <org>] [--token <token>]
uip function publish [--url <url>] [--org <org>] [--token <token>] [--feed-id <id>]
uip function runtime-install [--path <folder>]
uip function setup [--force]
uip function new [name] [--name <name>] [-l, --language ts|js|py] [--empty]
uip function init [--language py] [--skip-solution-registration]
uip function serve [--port <port>] [--runtime node|deno]
uip function run [name] [--input <json>] [--input-file <path>]
uip function pack
uip function push [--url <url>] [--project-id <id>] [--org <org>] [--token <token>]
uip function publish [--url <url>] [--org <org>] [--token <token>] [--feed-id <id>]
uip function runtime-install [--path <folder>]
Einrichtung der UIP-Funktion
Überprüfen Sie die Toolketten, die ein Funktionsprojekt benötigt: Node.js v20 oder höher für JS/TS und Python mit dem Paket uipath für Python. Ein fehlendes oder veraltetes Node.js schlägt den Befehl mit einem ConfigError fehl. Eine fehlende Python-Konfiguration wird gemeldet, schlägt jedoch nicht fehl, sodass der Befehl nicht blockiert wird. Nur JS/TS-Maschinen werden nicht blockiert. Das Ergebnis wird zwischengespeichert und mit uip codedagent setup geteilt, sodass durch Ausführen eines der Befehle Python für beide konfiguriert wird.
Optionen
| Long | Wert | Beschreibung |
|---|---|---|
--force | Markieren | Führen Sie die Überprüfung erneut aus, auch wenn ein zwischengespeichertes Ergebnis vorhanden ist. Standard: false. |
Beispiel
uip function setup --force
uip function setup --force
neue UIP-Funktion
Erstellen Sie ein neues Funktionsprojekt, das standardmäßig eine „Hello-World“-Funktion enthält.
Argumente
| Name | Erforderlich | Zweck |
|---|---|---|
[name] | nein | Projektname/Verzeichnis. Der Standardwert ist my-functions. Kann auch als --name übergeben werden. |
Optionen
| Long | Wert | Beschreibung |
|---|---|---|
--name <name> | string | Alternative zum Positionargument. |
-l, --language <lang> | ts (Standard) | js | py/python | Projektsprache. |
--empty | Markieren | Überspringen Sie die Funktion „Hello-World“ – leeres Projekt. Nur JS/TS. |
Beispiele
uip function new my-fn --language ts
uip function new my-fn --language py
uip function new my-fn --language ts
uip function new my-fn --language py
Datenform (--output json)
{ "Code": "NewComplete", "Data": { "Message": "Project created at ./my-fn" } }
{ "Code": "NewComplete", "Data": { "Message": "Project created at ./my-fn" } }
UIP-Funktion init
Nur Python: Einstiegspunkte erkennen und entry-points.json/bindings.json/project.uiproj (neu) generieren. Muss vor pack/push für ein Python-Projekt ausgeführt werden. Verwenden Sie für JS/TS stattdessen new --empty – init schlägt mit einer expliziten „Nur-Python“-Aktivität fehl Fehler bei einem JS/TS-Projekt oder einer nicht erkannten Sprache.
Optionen
| Long | Wert | Beschreibung |
|---|---|---|
--language py | Flag/Wert | Erzwingen Sie die Python-Sprachauflösung, wenn die Erkennung andernfalls mehrdeutig wäre. |
--skip-solution-registration | Markieren | Registrieren Sie das Projekt nicht automatisch in einer übergeordneten Lösung .uipx. |
Beispiel
uip function init
uip function init
Datenform (--output json)
{ "Code": "InitComplete", "Data": { "Message": "Project initialized." } }
{ "Code": "InitComplete", "Data": { "Message": "Project initialized." } }
Gefolgt von einer zweiten Registrierung der Lösung für den Erfolgsumschlag:
{
"Code": "FunctionsInitSolutionRegistration",
"Data": { "SolutionRegistration": { "Status": "Registered", "...": "..." } }
}
{
"Code": "FunctionsInitSolutionRegistration",
"Data": { "SolutionRegistration": { "Status": "Registered", "...": "..." } }
}
SolutionRegistration.Status ist "NotInSolution", wenn keine übergeordnete Lösung vorhanden ist, oder "OptedOut", wenn --skip-solution-registration übergeben wurde – immer vorhanden, wird nie weggelassen.
UIP-Funktion dienen
Starten Sie den lokalen Funktionsserver mit einem Hot-Reload. Nur JS/TS.
Optionen
| Long | Wert | Beschreibung |
|---|---|---|
--port <port> | Integer | Port, der überwacht werden soll. Der Standardwert ist 7070. |
--runtime <runtime> | node (Standard) | deno | Laufzeit, unter dem bereitgestellt werden soll. |
Beispiel
uip function serve
uip function serve
Datenform (--output json)
{ "Code": "ServeStarted", "Data": { "Message": "Listening on http://localhost:7070" } }
{ "Code": "ServeStarted", "Data": { "Message": "Listening on http://localhost:7070" } }
Ausführung der UIP-Funktion
Führen Sie eine Funktion einmal aus und geben Sie das Ergebnis aus. Der Funktionsname stammt aus der Funktionsliste Ihres Projekts.
Argumente
| Name | Erforderlich | Zweck |
|---|---|---|
[name] | nein | Name der auszuführenden Funktion. |
Optionen
| Long | Wert | Beschreibung |
|---|---|---|
--input <json> | JSON | Eingabenutzlast eingeben. Der Standardwert ist {}. |
--input-file <path> | Pfad | Pfad zu einer JSON-Eingabedatei. Hat bei JS/TS-Projekten Vorrang vor --input. |
Beispiele
# Python project: run the 'hello' function once with a JSON payload and read the result as JSON
uip function run hello --input '{"name":"Ada"}' --output json
# Python project: run a function with a payload kept in a file
uip function run hello --input-file ./payload.json --output json
# Python project: run the 'hello' function once with a JSON payload and read the result as JSON
uip function run hello --input '{"name":"Ada"}' --output json
# Python project: run a function with a payload kept in a file
uip function run hello --input-file ./payload.json --output json
Datenform (--output json)
{ "Code": "RunComplete", "Data": { "message": "Hello, Ada!" } }
{ "Code": "RunComplete", "Data": { "message": "Hello, Ada!" } }
Das strukturierte Ergebnis gilt für Python-Projekte, wenn Sie --output json oder --output yaml explizit übergeben:
Dataist die eigene Ausgabe der Funktion, wobei die Feldnamen genau so beibehalten werden, wie die Funktion sie deklariert.- Wenn die Funktion einen Skalar, ein Array oder nichts zurückgibt, wird der Wert unter einer einzelnen
Output-Taste platziert. - Der Fortschritt und die eigenen Protokolle der Ausführung werden an Stdrr geändert, sodass sdout nur den Umschlag trägt.
- Eine fehlgeschlagene Ausführung gibt
Result: "Failure"mitErrorCode: "unknown_error"und dem Exitcode der Ausführung inMessagezurück; Der eigene Fehler der Ausführung befindet sich auf standardr.
Ohne eine explizite --output json/yaml oder mit table oder plain gibt run die eigene Ausgabe der zugrunde liegenden CLI aus. Bei JS/TS-Projekten wird --output nicht von run unterstützt: Die CLI gibt einen Hinweis aus und die eigene Ausgabe der Funktion folgt unverändert.
UIP-Funktionspack
Packen Sie das Projekt in ein .nupkg für die Bereitstellung. Die Sperrdatei des Projekts ist immer im Paket enthalten.
Beispiel
uip function pack
uip function pack
Datenform (--output json)
{ "Code": "PackComplete", "Data": { "Message": "Package created: my-fn.0.0.1.nupkg" } }
{ "Code": "PackComplete", "Data": { "Message": "Package created: my-fn.0.0.1.nupkg" } }
UIP-Funktion pushen
Synchronisieren des Projekts mit Studio Web – generiert Einstiegspunkte und lädt geänderte Dateien hoch.
Optionen
| Long | Wert | Erforderlich | Beschreibung |
|---|---|---|---|
--url <url> | url | nein | UiPath-Plattform-URL. Greift auf UIPATH_URL zurück. |
--project-id <id> | GUID | bedingt | Studio Web-Projekt-ID. Obligatorisch, kann aber von UIPATH_PROJECT_ID anstelle des Flags stammen. |
--org <org> | string | nein | Name der Organisation. Greift auf UIPATH_ORGANIZATION_NAME zurück. |
--token <token> | string | nein | Zugriffstoken. Greift auf UIPATH_ACCESS_TOKEN zurück. |
Beispiel
uip function push --project-id 1f2a3b4c-0000-0000-0000-000000000001
uip function push --project-id 1f2a3b4c-0000-0000-0000-000000000001
Datenform (--output json)
{ "Code": "PushComplete", "Data": { "Message": "Push complete." } }
{ "Code": "PushComplete", "Data": { "Message": "Push complete." } }
UIP-Funktion veröffentlichen
Laden Sie die neueste Datei .nupkg in einen Orchestrator-Ordner hoch. Ohne --feed-id, Prompts interaktiv für einen Feed (ESC zum Abbrechen) – übergeben Sie --feed-id für CI, um die Auswahl zu überspringen.
Optionen
| Long | Wert | Beschreibung |
|---|---|---|
--url <url> | url | UiPath-Plattform-URL. Greift auf UIPATH_URL zurück. |
--org <org> | string | Name der Organisation. Greift auf UIPATH_ORGANIZATION_NAME zurück. |
--token <token> | string | Zugriffstoken. Greift auf UIPATH_ACCESS_TOKEN zurück. |
--feed-id <id> | GUID | Feed, in dem veröffentlicht werden soll – überspringt die interaktive Auswahl. |
Beispiele
# Interactive feed picker
uip function publish
# CI use — skip the picker
uip function publish --feed-id 9b2c1d4e-0000-0000-0000-000000000001
# Interactive feed picker
uip function publish
# CI use — skip the picker
uip function publish --feed-id 9b2c1d4e-0000-0000-0000-000000000001
Datenform (--output json)
{ "Code": "PublishComplete", "Data": { "Message": "Package published." } }
{ "Code": "PublishComplete", "Data": { "Message": "Package published." } }
UIP-Funktion runtime-installieren
Erstellen Sie einen Ausführungsordner mit seinem eigenen package.json und installieren Sie darin Laufzeitabhängigkeiten. Nur JS/TS.
Optionen
| Long | Wert | Beschreibung |
|---|---|---|
--path <folder> | Pfad | Zielordner, in dem Runtime-Abhängigkeiten erstellt und installiert werden sollen. |
Beispiel
uip function runtime-install --path .uipath/runner
uip function runtime-install --path .uipath/runner
Datenform (--output json)
{ "Code": "RuntimeInstallComplete", "Data": { "Message": "Runtime installed at .uipath/runner" } }
{ "Code": "RuntimeInstallComplete", "Data": { "Message": "Runtime installed at .uipath/runner" } }
Fehlerverhalten
initfür ein JS/TS-Projekt oder eine nicht erkannte Sprache:Failure,Message: "'init' is not applicable to JS/TS projects."(oder"'init' is Python-only."), wobeiInstructionsnew --empty/--languagebenennt.newohne erkennbare Sprache und kein--language: Wird standardmäßig TypeScript mit einer protokollierten Warnung verwendet, anstatt fehlzuschlagen.- Kein Funktionsprojekt für ein anderes Verb erkannt:
Failure,Message: "No Functions project detected in this directory.", mitInstructionszur Ausführung aus einem Verzeichnis, dasuipath.json/package.json/pyproject.tomlenthält, oder--languageexplizit übergeben. - Node.js fehlt oder ist unterhalb von v20 (JS/TS-Pfad):
ConfigErrormit der Benennung der erforderlichen Version und einem Link zum Installieren. Diese Prüfung wird insetupund automatisch ausgeführt, bevornewan die JS/TS-CLI weitergeleitet wird. - Python oder das
uipath-Paket ist nicht konfiguriert (Python-Pfad):ConfigErrormitInstructions, umuip function setupauszuführen.
Siehe auch
- Tools (Plugins)
uip codedapp– Ein ähnlich ausgeschnittener Build-/Pack-/Publish-/Pausierungs-/Pull-Lebenszyklus für codierte Apps.- Globale Optionen
- Exitcodes
- Konzepte
- Zusammenfassung
- Einrichtung der UIP-Funktion
- Optionen
- Beispiel
- neue UIP-Funktion
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- UIP-Funktion init
- Optionen
- Beispiel
- Datenform (--output json)
- UIP-Funktion dienen
- Optionen
- Beispiel
- Datenform (--output json)
- Ausführung der UIP-Funktion
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- UIP-Funktionspack
- Beispiel
- Datenform (--output json)
- UIP-Funktion pushen
- Optionen
- Beispiel
- Datenform (--output json)
- UIP-Funktion veröffentlichen
- Optionen
- Beispiele
- Datenform (--output json)
- UIP-Funktion runtime-installieren
- Optionen
- Beispiel
- Datenform (--output json)
- Fehlerverhalten
- Siehe auch