- Vue d'ensemble (Overview)
- Démarrer
- Concepts
- Utilisation de la UiPath CLI
- Guides pratiques
- Revenus CI/CD
- Référence de commande
- Vue d'ensemble (Overview)
- Codes de sortie
- Options globales
- agent codé uip
- encodeur UIP
- uip ancrage dans le contexte
- UiPath Docsai
- Fonction UiP
- garde-fous UiP
- configuration llm uip
- uip llm-passerelle
- Création uip maestro
- Registre Maestro uip
- uip model-hub
- Tâches (Jobs)
- Dossiers
- Processus
- ROI du processus
- Paquets
- Machines
- Utilisateurs
- Rôles
- Licences
- Flux
- Pièces jointes (Attachments)
- Sessions
- Calendriers
- magasins d'informations d’identification
- journaux-audit
- paramètres
- Actifs
- Compartiments
- Compartiment-fichiers
- Bibliothèques
- Files d'attente (Queues)
- ROI de la file d'attente
- éléments de la file d'attente
- Déclencheurs (Triggers)
- Webhooks
- Activités - Rechercher
- activités get-Default-xaml
- Analyser
- liste règles-analyseurs
- Construire
- Nettoyage
- Installation de entités data-fabrics
- liste des entités data-fabrics
- Diff de fichiers
- Get-Library-Object-Repository
- Récupérer le référentiel d'objets
- Init
- liste des instances
- Créer un package
- Vérification des paquets
- Installation des paquets
- Versions de paquets
- Publier
- Distant
- restore
- exécuter, déboguer et amp; Exécution
- paramètres
- Début de Studio
- Recherche de modèles
- entité ajoutée aux données de test
- Ajouter une file d'attente de données de test
- variation d'ajout de données de test
- TM
- UIA
- Valider
- exemples de workflow - Obtenir
- liste d'exemples de workflow
- tâches UIP
- pièce jointe
- Champ personnalisé
- Défauts (Defects)
- Exécutions
- exporter-tâches
- Migration
- Libellé Objet
- Créer un package
- scénarios-perf
- groupes-de-charge-scénarios-perf
- données d’exécution de perf-scenario
- rapport de scénarios de performances
- Projet
- autorisations-projet
- Invites
- Rapport
- Prérequis
- Résultat
- Exécuter
- Planifications (Schedules)
- Journaux de cas de test
- Cas de test
- Ensembles de tests
- Journal des étapes de test
- Utilisateur (User)
- Attendre
- Traçages UIP
- Commentaires sur les traces UIP
- Migration
- Référence et assistance
Fonction UiP
Syntax and options for `uip function`, which builds, serves, runs, and publishes UiPath JS/TS and Python Functions.
uip function builds, serves, and publishes UiPath Functions — small JS/TS or Python handlers packaged and run on the UiPath platform. uip function is the canonical group name; uip functions (plural) is accepted as an alias.
Concepts
- This is a language dispatcher, not a native tool. Every verb except
setupis a thin forwarder: the CLI detects your project's language (fromuipath.json,package.json, orpyproject.tomlin the current directory, or--language/-lonnew) and routes the raw arguments to either an in-process JS/TS CLI (@uipath/coded-functions-js-cli) or a spawned Python CLI. Flags the wrapper does not declare are forwarded unchanged to the underlying CLI. - La résolution linguistique est importante pour
initetnew.initest Python uniquement — pour JS/TS, élaboration à la place avecnew --empty.newdé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. setupvérifie les chaînes d'outils. Il vérifie Node.js ≥ 20 pour les projets JS/TS et Python avec le packageuipathpour les projets Python. La vérification Node.js s'exécute également automatiquement avant quenewne soit transmis à la CLI JS/TS. Les commandes des fonctions Python échouent avec uneConfigErrorqui pointe versuip function setupjusqu'à ce que Python soit configuré.publishvs.pushcibles:publishtélécharge le fichier.nupkgcompressé dans un flux Orchestrator;pushsynchronise le projet directement dans un projet Studio Web. Les deux acceptent--url/--org/--token(ou les variables d’environnementUIPATH_URL/UIPATH_ORGANIZATION_NAME/UIPATH_ACCESS_TOKENcorrespondantes).- Enregistrement automatique de la solution. Un Python
initréussit à enregistrer automatiquement le projet dans une solution.uipxparente lorsqu’il en existe une (même modèle que pour l’initialisation deagent/case/flow) — transmettre--skip-solution-registrationpour se désinscrire. Cela assure le rapport via une enveloppe de réussiteFunctionsInitSolutionRegistrationdistincte après la sortie d’initialisation de la CLI Python sous-jacente.
Synthèse
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>]
uip function setup
Verify the toolchains a Functions project needs: Node.js v20 or later for JS/TS, and Python with the uipath package for Python. A missing or outdated Node.js fails the command with a ConfigError. A missing Python configuration is reported but does not fail the command, so JS/TS-only machines are not blocked. The result is cached and shared with uip codedagent setup, so running either command configures Python for both.
Options
| Long | Valeur (Value) | Description |
|---|---|---|
--force | Drapeau | Re-run the verification even when a cached result exists. Default: false. |
Exemple
uip function setup --force
uip function setup --force
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
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" } }
{ "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
uip function init
Format des données (--sortie json)
{ "Code": "InitComplete", "Data": { "Message": "Project initialized." } }
{ "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", "...": "..." } }
}
{
"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
uip function serve
Format des données (--sortie json)
{ "Code": "ServeStarted", "Data": { "Message": "Listening on http://localhost:7070" } }
{ "Code": "ServeStarted", "Data": { "Message": "Listening on http://localhost:7070" } }
Exécution de la fonction UIP
Run one function once and print its result. The function name comes from your project's function list.
Arguments
| Nom | Requis | Objectif |
|---|---|---|
[name] | non | Name of the function to run. |
Options
| Long | Valeur (Value) | Description |
|---|---|---|
--input <json> | JSON | Charge utile d'entrée. Par défaut {}. |
--input-file <path> | Chemin d'accès | Path to a JSON input file. On JS/TS projects, takes precedence over --input. |
Exemples
# 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
Format des données (--sortie json)
{ "Code": "RunComplete", "Data": { "message": "Hello, Ada!" } }
{ "Code": "RunComplete", "Data": { "message": "Hello, Ada!" } }
The structured result applies to Python projects when you pass --output json or --output yaml explicitly:
Datais the function's own output, with its field names kept exactly as the function declares them.- When the function returns a scalar, an array, or nothing, the value is placed under a single
Outputkey. - Progress and the run's own logs go to stderr, so stdout carries only the envelope.
- A failed run returns
Result: "Failure"withErrorCode: "unknown_error"and the run's exit code inMessage; the run's own error is on stderr.
Sans --output json/yaml explicite, ou avec table ou plain, run imprime la sortie de la CLI sous-jacente. Sur les projets JS/TS, --output n'est pas pris en charge par run: la CLI imprime un avis et la sortie de la fonction reste inchangée.
module de fonctions uip
Pack the project into a .nupkg for deployment. The project's lock file is always included in the package.
Exemple
uip function pack
uip function pack
Format des données (--sortie 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" } }
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
uip function push --project-id 1f2a3b4c-0000-0000-0000-000000000001
Format des données (--sortie json)
{ "Code": "PushComplete", "Data": { "Message": "Push complete." } }
{ "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
# 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." } }
{ "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
uip function runtime-install --path .uipath/runner
Format des données (--sortie json)
{ "Code": "RuntimeInstallComplete", "Data": { "Message": "Runtime installed at .uipath/runner" } }
{ "Code": "RuntimeInstallComplete", "Data": { "Message": "Runtime installed at .uipath/runner" } }
Comportement des erreurs
initpar 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."), avecInstructionsnommantnew --empty/--language.newsans 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.", avecInstructionsà exécuter à partir d’un répertoire contenantuipath.json/package.json/pyproject.toml, ou transmettre--languageexplicitement. - Node.js manquant ou inférieur à v20 (chemin JS/TS):
ConfigErrornommant la version requise et un lien pour l'installer. Cette vérification s'exécute danssetupet automatiquement avant quenewne transfère à la CLI JS/TS. - Python or the
uipathpackage not configured (Python path):ConfigErrorwithInstructionsto runuip function setup.
Voir également
- Outils (extensions)
uip codedapp— un cycle de vie de forme similaire pour les applications codées.- Options globales
- Codes de sortie
- Concepts
- Synthèse
- uip function setup
- Options
- Exemple
- Fonction UIP nouvelle
- Arguments
- Options
- Exemples
- Format des données (--sortie json)
- Initialisation de la fonction UIP
- Options
- Exemple
- Format des données (--sortie json)
- fonction uip service
- Options
- Exemple
- Format des données (--sortie json)
- Exécution de la fonction UIP
- Arguments
- Options
- Exemples
- Format des données (--sortie json)
- module de fonctions uip
- Exemple
- Format des données (--sortie json)
- Fonction UIP push
- Options
- Exemple
- Format des données (--sortie json)
- publication de la fonction UiP
- Options
- Exemples
- Format des données (--sortie json)
- Fonction UIP runtime-install
- Options
- Exemple
- Format des données (--sortie json)
- Comportement des erreurs
- Voir également