- Información general
- Comience ya
- Conceptos
- Uso de UiPath CLI
- Guías prácticas
- Recetas de CI/CD
- Referencia de los comandos
- Información general
- Códigos de salida
- Opciones globales
- agente de código UIP
- codificador UIP
- Contextualización de UIP
- UIP Docsai
- Función uip
- barreras de seguridad de UIP
- Configuración de UIP llm
- puerta de enlace llm de uip
- Creación de UIP Maestro
- Registro maestro de UIP
- UIP model-hub
- Actividades Buscar
- actividades get-default-xaml
- Analizar
- lista de reglas del analizador
- Crear
- Limpieza
- instalación de data-fabric-entities
- lista de entidades de data-fabric
- diferencia de archivos
- obtener-repositorio-de-objetos-de-biblioteca
- obtener-objeto-repositorio
- Init
- lista de instancias
- Paquete
- inspeccionar paquetes
- instalación de paquetes
- versiones de paquetes
- Publicar
- Remoto
- restore
- ejecutar, depurar & Ejecución
- Configuración
- Inicio de Studio
- Búsqueda de plantillas
- entidad de adición de datos de prueba
- añadir-cola de datos de prueba
- añadir-variación de los datos de prueba
- TM
- UIA
- Validar
- ejemplos-de-flujo-de-flujo-obtener
- lista de ejemplos de flujo de trabajo
- Tareas de UIP
- Archivo adjunto
- Campo personalizado
- Defects
- Ejecuciones
- exportar-trabajos
- Migración
- EtiquetaDeObjeto
- Paquete
- escenario de rendimiento
- grupos de carga de escenarios de rendimiento
- datos de ejecución de perf-scenario
- informe de escenario de rendimiento
- Proyecto
- permisos del proyecto
- Solicitudes
- Informar
- Requisitos
- Resultado
- Iniciar
- Programaciones
- Registro de casos de prueba
- Casos de prueba
- Conjuntos de prueba
- registro de pasos de prueba
- Usuario
- Esperar
- Seguimientos de UIP
- Comentarios de seguimientos de UIP
- Migración
- Referencia y soporte
Función uip
Sintaxis y opciones para la `función uip`, que crea, sirve, ejecuta y publica funciones UiPath JS/TS y Python.
uip function , sirve y publica 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) se acepta como alias.
Conceptos
- Este es un distribuidor de idiomas, no una herramienta nativa. Cada verbo excepto
setupes un reenviador ligero: la CLI detecta el idioma de tu proyecto (deuipath.json,package.jsonopyproject.tomlen el directorio actual, o--language/-lennew) 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. Las marcas que el contenedor no declara se reenvían sin cambios a la CLI subyacente. - La resolución del idioma es importante para
initynew.inites solo para Python : para JS/TS, andamio en su lugar connew --empty.newdetecciones 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. setupverifica las cadenas de herramientas. Comprueba Node.js ≥20 para proyectos JS/TS y Python con el paqueteuipathpara proyectos de Python. La comprobación de Node.js también se ejecuta automáticamente antes denewreenviar a la CLI de JS/TS. Los comandos de funciones de Python fallan con unConfigErrorque apunta auip function setuphasta que se configura Python.publishfrente apushdestinos diferentes:publishcarga el.nupkgempaquetado a una fuente de Orchestrator;pushsincroniza el proyecto directamente en un proyecto de Studio Web. Ambos aceptan--url/--org/--token(o lasUIPATH_URL/UIPATH_ORGANIZATION_NAME/UIPATH_ACCESS_TOKENenv vars coincidentes).- Registro automático de la solución. Un Python
initexitoso registra automáticamente el proyecto en una solución.uipxprincipal cuando existe (el mismo patrón queagent/case/flowinit): introduzca--skip-solution-registrationpara cancelar la suscripción. Esto informa a través de un sobre de éxitoFunctionsInitSolutionRegistrationindependiente después de la propia salida init de la CLI de Python subyacente.
Sinopsis
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>]
configuración de la función uip
Verifica las cadenas de herramientas que necesita un proyecto de Functions: Node.js v20 o posterior para JS/TS, y Python con el paquete uipath para Python. Un Node.js faltante o desactualizado falla el comando con un ConfigError. Se informa de una configuración de Python que falta, pero no falla el comando, por lo que las máquinas solo JS/TS no se bloquean. El resultado se almacena en caché y se comparte con uip codedagent setup, por lo que ejecutar cualquiera de los comandos configura Python para ambos.
Opciones
| Largo | Valor | Descripción |
|---|---|---|
--force | Marca | Vuelve a ejecutar la verificación incluso cuando exista un resultado en caché. Predeterminado: false. |
Ejemplo
uip function setup --force
uip function setup --force
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
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" } }
{ "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
uip function init
Forma de datos (--json de salida)
{ "Code": "InitComplete", "Data": { "Message": "Project initialized." } }
{ "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", "...": "..." } }
}
{
"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
uip function serve
Forma de datos (--json de salida)
{ "Code": "ServeStarted", "Data": { "Message": "Listening on http://localhost:7070" } }
{ "Code": "ServeStarted", "Data": { "Message": "Listening on http://localhost:7070" } }
ejecución de la función uip
Ejecuta una función una vez e imprime su resultado. El nombre de la función proviene de la lista de funciones de tu proyecto.
Argumentos
| Nombre | Obligatorio | Propósito |
|---|---|---|
[name] | No | Nombre de la función que se va a ejecutar. |
Opciones
| Largo | Valor | Descripción |
|---|---|---|
--input <json> | JSON | Carga útil de entrada. Predeterminado {}. |
--input-file <path> | Ruta | Ruta a un archivo de entrada JSON. En proyectos JS/TS, tiene prioridad --input. |
Ejemplos
# 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
Forma de datos (--json de salida)
{ "Code": "RunComplete", "Data": { "message": "Hello, Ada!" } }
{ "Code": "RunComplete", "Data": { "message": "Hello, Ada!" } }
El resultado estructurado se aplica a los proyectos de Python cuando pasas --output json o --output yaml explícitamente:
Dataes la propia salida de la función, con sus nombres de campo mantenidos exactamente como los declara la función.- Cuando la función devuelve un escalar, una matriz o nada, el valor se coloca bajo una sola clave
Output. - Progress and the run's own logs go to stderr, so stdout carries only the envelope.
- Una ejecución fallida devuelve
Result: "Failure"conErrorCode: "unknown_error"y el código de salida de la ejecución enMessage; el propio error de la ejecución está en stderr.
Sin un --output json/yaml explícito, o con table o plain, run imprime la propia salida de la CLI subyacente. En los proyectos JS/TS, --output no es compatible con run: la CLI imprime un aviso y la propia salida de la función sigue sin cambios.
paquete de funciones uip
Empaqueta el proyecto en un .nupkg para la implementación. El archivo de bloqueo del proyecto siempre se incluye en el paquete.
Ejemplo
uip function pack
uip function pack
Forma de datos (--json de salida)
{ "Code": "PackComplete", "Data": { "Message": "Package created: my-fn.0.0.1.nupkg" } }
{ "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
uip function push --project-id 1f2a3b4c-0000-0000-0000-000000000001
Forma de datos (--json de salida)
{ "Code": "PushComplete", "Data": { "Message": "Push complete." } }
{ "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
# 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." } }
{ "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
uip function runtime-install --path .uipath/runner
Forma de datos (--json de salida)
{ "Code": "RuntimeInstallComplete", "Data": { "Message": "Runtime installed at .uipath/runner" } }
{ "Code": "RuntimeInstallComplete", "Data": { "Message": "Runtime installed at .uipath/runner" } }
Comportamiento de error
initcontra un proyecto JS/TS o un lenguaje no detectado:Failure,Message: "'init' is not applicable to JS/TS projects."(o"'init' is Python-only."), conInstructionsnombresnew --empty/--language.newsin 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.", conInstructionspara ejecutar desde un directorio que contengauipath.json/package.json/pyproject.toml, o pasar--languageexplícitamente. - Falta Node.js o es inferior a la versión v20 (ruta JS/TS):
ConfigErrornombrando la versión requerida y un enlace para instalarla. Esta comprobación se ejecuta ensetupy automáticamente antes de quenewse reenvíe a la CLI de JS/TS. - Python o el paquete
uipathno configurado (ruta de Python):ConfigErrorconInstructionspara ejecutaruip function setup.
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
- Conceptos
- Sinopsis
- configuración de la función uip
- Opciones
- Ejemplo
- nueva función uip
- Argumentos
- Opciones
- Ejemplos
- Forma de datos (--json de salida)
- inicialización de la función uip
- Opciones
- Ejemplo
- Forma de datos (--json de salida)
- Servicio de función UIP
- Opciones
- Ejemplo
- Forma de datos (--json de salida)
- ejecución de la función uip
- Argumentos
- Opciones
- Ejemplos
- Forma de datos (--json de salida)
- paquete de funciones uip
- Ejemplo
- Forma de datos (--json de salida)
- inserción de función uip
- Opciones
- Ejemplo
- Forma de datos (--json de salida)
- publicación de la función uip
- Opciones
- Ejemplos
- Forma de datos (--json de salida)
- Función UIP runtime-install
- Opciones
- Ejemplo
- Forma de datos (--json de salida)
- Comportamiento de error
- Ver también