UIP-Funktion

Syntax und Optionen für „uip-Funktion“, die UiPath JS/TS- und Python-Funktionen erstellt, bereitstellt und veröffentlicht – Setup, New, Init, Serve, Run, Pack, Push, Veröffentlichen, Runtime-Installation.

uip function erstellt, dient und veröffentlicht UiPath® Functions – 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) funktioniert weiterhin als Abwärtskompatibilitäts-Alias.

Konzepte

• Dies ist ein Verteiler für Sprachen, kein natives Tool. Jedes Verb außer setup ist ein Thin-Forward: Die CLI erkennt die Sprache Ihres Projekts (an uipath.json, package.json oder pyproject.toml im aktuellen Verzeichnis oder --language/-l auf new) und Leitet die unformatierten Argumente entweder an eine JS/TS-CLI (@uipath/coded-functions-js-cli) im Prozess oder eine generierte Python-CLI weiter. uip function <verb> --help zeigt daher für jedes weitergeleitete Verb die eigene Hilfe der zugrunde liegenden CLI an, keine uip-erstellte – die folgenden Optionstabellen werden aus den eigenen Flag-Hinweisen und Beispielen des Weiterleitungs-Wrappers extrahiert, was das Tool dieses Repositorys vor der die nachgelagerte CLI übernimmt.
• Die Sprachauflösung ist für init und new wichtig. init ist nur Python – für JS/TS, Gerüst anstelle von new --empty. new erkennt 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 wird automatisch ausgeführt. Es ist ein ausgeblendeter Befehl (nicht in --help), der Node.js ≥20 vor new überprüft und an die JS/TS-CLI weiterleitet – normalerweise rufen Sie ihn nicht selbst auf, aber uip function setup --force führt die Prüfung erneut aus, wenn der Eine zwischengespeicherte Verifizierung wird veraltet (z. B. nach einer Knoten-Neuinstallation).
• publish vs. push zielen unterschiedliche Ziele ab: publish lädt das gepackte .nupkg in einen Orchestrator-Feed hoch; push synchronisiert das Projekt direkt mit einem Studio Web-Projekt. Beide akzeptieren --url/--org/--token (oder die übereinstimmenden UIPATH_URL/UIPATH_ORGANIZATION_NAME/UIPATH_ACCESS_TOKEN env-Variablen).
• Automatische Registrierung der Lösung. Eine erfolgreiche Python- init registriert das Projekt automatisch in einer übergeordneten .uipx -Lösung, wenn eine vorhanden ist (dasselbe Muster wie agent/case/flow init) – übergeben Sie --skip-solution-registration, um sich abzumelden. Dies meldet über einen separaten FunctionsInitSolutionRegistration -Erfolgsumschlag nach der eigenen Init-Ausgabe der zugrunde liegenden Python-CLI.

Zusammenfassung

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> [--port <port>] [--input <json>]
uip function pack [--nolock]
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>]

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

Datenform (--output json)

{ "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

Datenform (--output json)

{ "Code": "InitComplete", "Data": { "Message": "Project initialized." } }

Gefolgt von einer zweiten Registrierung der Lösung für den Erfolgsumschlag:

{
  "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

Datenform (--output json)

{ "Code": "ServeStarted", "Data": { "Message": "Listening on http://localhost:7070" } }

Ausführung der UIP-Funktion

Rufen Sie eine Funktion für den lokalen serve -Endpunkt auf. Nur JS/TS.

Argumente

Name	Erforderlich	Zweck
<name>	ja	Funktionsname, der aufgerufen werden soll.

Optionen

Long	Wert	Beschreibung
--port <port>	Integer	Port, auf dem sich der lokale Server befindet. Der Standardwert ist 7070.
--input <json>	JSON	Eingabenutzlast eingeben. Der Standardwert ist {}.

Beispiel

uip function run hello --input '{"x":1}'

Datenform (--output json)

{ "Code": "RunComplete", "Data": { "result": 2 } }

Data ist der eigene Rückgabewert der Funktion, dessen Form vollständig von der von Ihnen geschriebenen Funktion bestimmt wird – nicht normalisiert von der CLI.

UIP-Funktionspack

Packen Sie das Projekt in ein .nupkg für die Bereitstellung.

Optionen

Long	Wert	Beschreibung
--nolock	Markieren	Schließen Sie die Sperrdatei aus dem Paket aus. Nur JS/TS.

Beispiel

uip function pack

Datenform (--output json)

{ "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

Datenform (--output json)

{ "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

Datenform (--output json)

{ "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

Datenform (--output json)

{ "Code": "RuntimeInstallComplete", "Data": { "Message": "Runtime installed at .uipath/runner" } }

Fehlerverhalten

• init fü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."), wobei Instructions new --empty/--language benennt.
• new ohne 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.", mit Instructions zur Ausführung aus einem Verzeichnis, das uipath.json/package.json/pyproject.toml enthält, oder --language explizit übergeben.
• Node.js fehlt oder ist unterhalb von v20 (JS/TS-Pfad): ConfigError mit der Benennung der erforderlichen Version und einem Link zu ihrer Installation – diese Prüfung wird automatisch ausgeführt, bevor new an die JS/TS-CLI weitergeleitet wird.

Siehe auch

• Tools (Plugins)
• uip codedapp – Ein ähnlich ausgeschnittener Build-/Pack-/Publish-/Pausierungs-/Pull-Lebenszyklus für codierte Apps.
• Globale Optionen
• Exitcodes