Función uip

Sintaxis y opciones para la `función uip`, que crea, sirve y publica funciones UiPath JS/TS y Python: configuración, nueva, init, servir, ejecutar, empaquetar, insertar, publicar, runtime-install.

uip function builds, serves, and publishes UiPath Functions — pequeños controladores JS/TS o Python empaquetados y ejecutados en UiPath Platform. uip function es el nombre del grupo canónico; uip functions (plural) sigue funcionando como alias de retrocompatibilidad.

Conceptos

• Este es un distribuidor de idiomas, no una herramienta nativa. Cada verbo excepto setup es un reenviador ligero: la CLI detecta el idioma de tu proyecto (desde uipath.json, package.json o pyproject.toml en el directorio actual, o --language/-l en new) y enruta los argumentos sin procesar a una CLI JS/TS en proceso (@uipath/coded-functions-js-cli) o a una CLI de Python generada. uip function <verb> --help para cualquier verbo reenviado, por lo tanto, muestra la propia ayuda de la CLI subyacente, no una creada por uip: las siguientes tablas de opciones se extraen de las propias sugerencias y ejemplos de marcadores del contenedor de reenvío, que es lo máximo que exponen las herramientas de este repositorio antes de CLI descendente se hace cargo.
• La resolución del idioma es importante para init y new. init es solo para Python : para JS/TS, andamio en su lugar con new --empty. new detecciones automáticas; cuando la detección no es concluyente, el valor predeterminado es TypeScript con una advertencia registrada, a menos que pases --language js|ts|py/python.
• setup se ejecuta automáticamente. Es un comando oculto (no en --help) que verifica Node.js ≥20 antes de new reenviar a JS/TS CLI; normalmente no lo llamas tú mismo, pero uip function setup --force vuelve a ejecutar la comprobación si el la verificación en caché se vuelve obsoleta (por ejemplo, después de una reinstalación de Node).
• publish frente a push destinos diferentes: publish carga el .nupkg empaquetado a una fuente de Orchestrator; push sincroniza el proyecto directamente en un proyecto de Studio Web. Ambos aceptan --url/--org/--token (o las UIPATH_URL/UIPATH_ORGANIZATION_NAME/UIPATH_ACCESS_TOKEN env vars coincidentes).
• Registro automático de la solución. Un Python init exitoso registra automáticamente el proyecto en una solución .uipx principal cuando existe (el mismo patrón que agent/case/flow init): introduzca --skip-solution-registration para cancelar la suscripción. Esto informa a través de un sobre de éxito FunctionsInitSolutionRegistration independiente después de la propia salida init de la CLI de Python subyacente.

Sinopsis

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

nueva función uip

Aplica andamios a un nuevo proyecto de funciones, incluida una función hola-mundo de forma predeterminada.

Argumentos

Nombre	Obligatorio	Propósito
[name]	No	Nombre del proyecto/directorio. Predeterminado my-functions. También se puede pasar como --name.

Opciones

Largo	Valor	Descripción
--name <name>	String	Alternativa al argumento posicional.
-l, --language <lang>	ts (predeterminado) | js | py/python	Idioma del proyecto.
--empty	Marca	Omite la función hello-world: proyecto vacío. Solo JS/TS.

Ejemplos

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

Forma de datos (--json de salida)

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

inicialización de la función uip

Solo Python: descubre puntos de entrada y (re)genera entry-points.json/bindings.json/project.uiproj. Debe ejecutarse antes de pack/push para un proyecto de Python. Para JS/TS, utiliza new --empty en su lugar: init falla con un explícito "Solo Python" contra un proyecto JS/TS o un idioma no detectado.

Opciones

Largo	Valor	Descripción
--language py	Marca/valor	Fuerza la resolución del lenguaje Python cuando la detección sería ambigua.
--skip-solution-registration	Marca	No registres automáticamente el proyecto en una solución .uipx principal.

Ejemplo

uip function init

Forma de datos (--json de salida)

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

Seguido de un segundo registro de solución de informes de sobres de éxito:

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

SolutionRegistration.Status es "NotInSolution" cuando no existe una solución principal, o "OptedOut" cuando se pasó --skip-solution-registration: siempre presente, nunca se omite.

Servicio de función UIP

Inicia el servidor de funciones local con recarga en caliente. Solo JS/TS.

Opciones

Largo	Valor	Descripción
--port <port>	Entero	Puerto en el que escuchar. Predeterminado 7070.
--runtime <runtime>	node (Predeterminada) | deno	Runtime bajo el que servir.

Ejemplo

uip function serve

Forma de datos (--json de salida)

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

ejecución de la función uip

Invoca una función en el punto final serve local. Solo JS/TS.

Argumentos

Nombre	Obligatorio	Propósito
<name>	Sí	Nombre de la función que se va a invocar.

Opciones

Largo	Valor	Descripción
--port <port>	Entero	Puerto en el que se encuentra el servidor local. Predeterminado 7070.
--input <json>	JSON	Carga útil de entrada. Predeterminado {}.

Ejemplo

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

Forma de datos (--json de salida)

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

Data es el propio valor devuelto de la función, forma determinada completamente por la función que escribiste, no normalizada por la CLI.

paquete de funciones uip

Empaqueta el proyecto en un .nupkg para la implementación.

Opciones

Largo	Valor	Descripción
--nolock	Marca	Excluye el archivo de bloqueo del paquete. Solo JS/TS.

Ejemplo

uip function pack

Forma de datos (--json de salida)

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

inserción de función uip

Sincroniza el proyecto con Studio Web: genera puntos de entrada y carga los archivos modificados.

Opciones

Largo	Valor	Obligatorio	Descripción
--url <url>	url	No	URL de la plataforma UiPath. Vuelve a UIPATH_URL.
--project-id <id>	GUID	condicionalmente	ID del proyecto de Studio Web. Obligatorio, pero puede provenir de UIPATH_PROJECT_ID en lugar del marcador.
--org <org>	String	No	Nombre de la organización. Vuelve a UIPATH_ORGANIZATION_NAME.
--token <token>	String	No	Token de acceso. Vuelve a UIPATH_ACCESS_TOKEN.

Ejemplo

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

Forma de datos (--json de salida)

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

publicación de la función uip

Carga el último .nupkg en una carpeta de Orchestrator. Sin --feed-id, solicita de forma interactiva una fuente (ESC para cancelar): introduzca --feed-id para que el uso de CI omita el selector.

Opciones

Largo	Valor	Descripción
--url <url>	url	URL de la plataforma UiPath. Vuelve a UIPATH_URL.
--org <org>	String	Nombre de la organización. Vuelve a UIPATH_ORGANIZATION_NAME.
--token <token>	String	Token de acceso. Vuelve a UIPATH_ACCESS_TOKEN.
--feed-id <id>	GUID	Fuente en la que publicar: omite el selector interactivo.

Ejemplos

# Interactive feed picker
uip function publish

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

Forma de datos (--json de salida)

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

Función UIP runtime-install

Crea una carpeta del ejecutor con su propia package.json e instala las dependencias de runtime en ella. Solo JS/TS.

Opciones

Largo	Valor	Descripción
--path <folder>	Ruta	Carpeta de destino para crear e instalar dependencias de runtime.

Ejemplo

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

Forma de datos (--json de salida)

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

Comportamiento de error

• init contra un proyecto JS/TS o un lenguaje no detectado: Failure, Message: "'init' is not applicable to JS/TS projects." (o "'init' is Python-only."), con Instructions nombres new --empty/--language.
• new sin idioma detectable y sin --language: el valor predeterminado es TypeScript con una advertencia registrada en lugar de fallar.
• No se ha detectado ningún proyecto de funciones para ningún otro verbo: Failure, Message: "No Functions project detected in this directory.", con Instructions para ejecutar desde un directorio que contenga uipath.json/package.json/pyproject.toml, o pasar --language explícitamente.
• Falta Node.js o es inferior a la versión v20 (ruta JS/TS): ConfigError nombra la versión requerida y un enlace para instalarla. Esta comprobación se ejecuta automáticamente antes de new reenviar a la CLI de JS/TS.

Ver también

• Herramientas (complementos)
• uip codedapp : un ciclo de vida de creación/empaquetado/publicación/inserción/extracción de forma similar para aplicaciones codificadas.
• Opciones globales
• Códigos de salida