Fonction UiP

Syntaxe et options pour `uip fonction`, qui crée, sert et publie UiPath JS/TS et les fonctions Python — configuration, nouveau, init, service, exécuter, compresser, transmettre, publier, runtime-installer.

uip function crée, sert et publie UiPath Functions - petits gestionnaires JS/TS ou Python packagés et exécutés sur la plate-forme UiPath. uip function est le nom canonique du groupe; uip functions fonctionne toujours comme alias de rétrocompatibilité.

Concepts

• Il s’agit d’un répartiteur de langue, et non d’un outil natif. Chaque verbe, à l'exception de setup, est un transmetteur léger: la CLI détecte la langue de votre projet (à partir de uipath.json, package.json ou pyproject.toml dans le répertoire actuel, ou --language/-l sur new) et achemine les arguments bruts vers une CLI JS/TS en cours (@uipath/coded-functions-js-cli) ou une CLI Python générée. uip function <verb> --help pour tout verbe transféré affiche donc la propre aide de la CLI sous-jacente, et non une création de uip- les tables d'options ci-dessous sont extraites des propres suggestions et exemples d'indicateurs du wrapper de transfert, ce qui est le plus que l'outil de ce référentiel expose avant le la CLI en aval prend le relais.
• La résolution linguistique est importante pour init et new. init est Python uniquement — pour JS/TS, élaboration à la place avec new --empty. new détections automatiques; lorsque la détection est incertaine, elle utilise par défaut TypeScript avec un avertissement consigné, sauf si vous réussissez --language js|ts|py/python.
• setup s'exécute automatiquement. Il s'agit d'une commande masquée (pas dans --help) qui vérifie Node.js ≥ 20 avant new vers la CLI JS/TS — vous ne l'appelez normalement pas vous-même, mais uip function setup --force réexécute la vérification si le la vérification mise en cache devient obsolète (par exemple, après une réinstallation de nœud).
• publish vs. push cibles: publish télécharge le fichier .nupkg compressé dans un flux Orchestrator; push synchronise le projet directement dans un projet Studio Web. Les deux acceptent --url/--org/--token (ou les variables d’environnement UIPATH_URL/UIPATH_ORGANIZATION_NAME/UIPATH_ACCESS_TOKEN correspondantes).
• Enregistrement automatique de la solution. Un Python init réussit à enregistrer automatiquement le projet dans une solution .uipx parente lorsqu’il en existe une (même modèle que pour l’initialisation de agent/case/flow) — transmettre --skip-solution-registration pour se désinscrire. Cela assure le rapport via une enveloppe de réussite FunctionsInitSolutionRegistration distincte après la sortie d’initialisation de la CLI Python sous-jacente.

Synthèse

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>]

Fonction UIP nouvelle

Élaborez un nouveau projet Fonctions, y compris une fonction bonjour-monde par défaut.

Arguments

Nom	Requis	Objectif
[name]	non	Nom/répertoire du projet. Par défaut my-functions. Peut également être transmis sous la forme --name.

Options

Long	Valeur (Value)	Description
--name <name>	string	Alternative à l’argument de position.
-l, --language <lang>	ts (par défaut) | js | py/python	Langage du projet.
--empty	Drapeau	Ignorez la fonction bonjour-monde — projet vide. JS/TS uniquement.

Exemples

uip function new my-fn --language ts
uip function new my-fn --language py

Format des données (--sortie json)

{ "Code": "NewComplete", "Data": { "Message": "Project created at ./my-fn" } }

Initialisation de la fonction UIP

Python uniquement: découvrez les points d'entrée et (régénérez) entry-points.json/bindings.json/project.uiproj. Doit s’exécuter avant pack/push pour un projet Python. Pour JS/TS, utilisez new --empty à la place — init échoue avec un explicite et quota;Python uniquement comme erreur dans un projet JS/TS ou dans un langage non détecté.

Options

Long	Valeur (Value)	Description
--language py	indicateur/valeur	Forcer la résolution du langage Python lors de la détection serait autrement ambiguë.
--skip-solution-registration	Drapeau	Ne pas enregistrer automatiquement le projet dans une solution .uipx parente.

Exemple

uip function init

Format des données (--sortie json)

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

Suivi d’un deuxième enregistrement de solution de rapport par enveloppe réussie:

{
  "Code": "FunctionsInitSolutionRegistration",
  "Data": { "SolutionRegistration": { "Status": "Registered", "...": "..." } }
}

SolutionRegistration.Status est "NotInSolution" lorsqu'aucune solution parente n'existe, ou "OptedOut" lorsque --skip-solution-registration a été transmis - toujours présent, jamais omis.

fonction uip service

Démarrez le serveur de fonctions local avec le rechargement rapide. JS/TS uniquement.

Options

Long	Valeur (Value)	Description
--port <port>	Integer	Port sur lequel écouter. Par défaut 7070.
--runtime <runtime>	node (par défaut) | deno	Runtime sous lequel servir.

Exemple

uip function serve

Format des données (--sortie json)

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

Exécution de la fonction UIP

Appelez une fonction par rapport au point de terminaison serve local. JS/TS uniquement.

Arguments

Nom	Requis	Objectif
<name>	oui	Nom de la fonction à invoquer.

Options

Long	Valeur (Value)	Description
--port <port>	Integer	Le port du serveur local est activé. Par défaut 7070.
--input <json>	JSON	Charge utile d'entrée. Par défaut {}.

Exemple

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

Format des données (--sortie json)

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

Data est la propre valeur de retour de la fonction, la forme étant entièrement déterminée par la fonction que vous avez écrite et non normalisée par la CLI.

module de fonctions uip

Compressez le projet dans un .nupkg pour le déploiement.

Options

Long	Valeur (Value)	Description
--nolock	Drapeau	Excluez le fichier de verrouillage du package. JS/TS uniquement.

Exemple

uip function pack

Format des données (--sortie json)

{ "Code": "PackComplete", "Data": { "Message": "Package created: my-fn.0.0.1.nupkg" } }

Fonction UIP push

Synchroniser le projet avec Studio Web: génère des points d'entrée et télécharge les fichiers modifiés.

Options

Long	Valeur (Value)	Requis	Description
--url <url>	url	non	URL de la plate-forme UiPath. Revient à UIPATH_URL.
--project-id <id>	GUID	Conditionnel	ID de projet Studio Web. Obligatoire, mais peut provenir de UIPATH_PROJECT_ID au lieu de l'indicateur.
--org <org>	string	non	Nom de l'organisation. Revient à UIPATH_ORGANIZATION_NAME.
--token <token>	string	non	Jeton d’accès. Revient à UIPATH_ACCESS_TOKEN.

Exemple

uip function push --project-id 1f2a3b4c-0000-0000-0000-000000000001

Format des données (--sortie json)

{ "Code": "PushComplete", "Data": { "Message": "Push complete." } }

publication de la fonction UiP

Chargez le dernier .nupkg dans un dossier Orchestrator. Sans --feed-id, invite interactive pour un flux (Échap pour annuler) — saisissez --feed-id pour Utilisation CI pour ignorer le sélecteur.

Options

Long	Valeur (Value)	Description
--url <url>	url	URL de la plate-forme UiPath. Revient à UIPATH_URL.
--org <org>	string	Nom de l'organisation. Revient à UIPATH_ORGANIZATION_NAME.
--token <token>	string	Jeton d’accès. Revient à UIPATH_ACCESS_TOKEN.
--feed-id <id>	GUID	Flux vers lequel publier — ignore le sélecteur interactif.

Exemples

# Interactive feed picker
uip function publish

# CI use — skip the picker
uip function publish --feed-id 9b2c1d4e-0000-0000-0000-000000000001

Format des données (--sortie json)

{ "Code": "PublishComplete", "Data": { "Message": "Package published." } }

Fonction UIP runtime-install

Créez un dossier de runtime avec son propre package.json et installez-y les dépendances du runtime. JS/TS uniquement.

Options

Long	Valeur (Value)	Description
--path <folder>	Chemin d'accès	Dossier cible dans lequel créer et installer les dépendances du runtime.

Exemple

uip function runtime-install --path .uipath/runner

Format des données (--sortie json)

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

Comportement des erreurs

• init par rapport à un projet JS/TS ou à une langue non détectée: Failure, Message: "'init' is not applicable to JS/TS projects." (ou "'init' is Python-only."), avec Instructions nommant new --empty/--language.
• new sans langage détectable et sans --language: la valeur par défaut est TypeScript avec un avertissement consigné plutôt que d'échouer.
• Aucun projet Fonctions détecté pour tout autre verbe: Failure, Message: "No Functions project detected in this directory.", avec Instructions à exécuter à partir d’un répertoire contenant uipath.json/package.json/pyproject.toml, ou transmettre --language explicitement.
• Node.js manquant ou inférieur à v20 (chemin JS/TS): ConfigError attribuant la version requise et un lien pour l'installer — cette vérification s'exécute automatiquement avant que new ne redirige vers la CLI JS/TS.

Voir également

• Outils (extensions)
• uip codedapp — un cycle de vie de forme similaire pour les applications codées.
• Options globales
• Codes de sortie