UiPath Documentation
uipath-cli
latest
false
Guía del usuario de UiPath CLI
Importante :
Este contenido se ha traducido mediante traducción automática. La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

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 setup es un reenviador ligero: la CLI detecta el idioma de tu proyecto (de 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. Las marcas que el contenedor no declara se reenvían sin cambios a la CLI subyacente.
  • 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 verifica las cadenas de herramientas. Comprueba Node.js ≥20 para proyectos JS/TS y Python con el paquete uipath para proyectos de Python. La comprobación de Node.js también se ejecuta automáticamente antes de new reenviar a la CLI de JS/TS. Los comandos de funciones de Python fallan con un ConfigError que apunta a uip function setup hasta que se configura Python.
  • 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 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​

LargoValorDescripción
--forceMarcaVuelve 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​

NombreObligatorioPropósito
[name]NoNombre del proyecto/directorio. Predeterminado my-functions. También se puede pasar como --name.

Opciones​

LargoValorDescripción
--name <name>StringAlternativa al argumento posicional.
-l, --language <lang>ts (predeterminado) | js | py/pythonIdioma del proyecto.
--emptyMarcaOmite 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​

LargoValorDescripción
--language pyMarca/valorFuerza la resolución del lenguaje Python cuando la detección sería ambigua.
--skip-solution-registrationMarcaNo 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​

LargoValorDescripción
--port <port>EnteroPuerto en el que escuchar. Predeterminado 7070.
--runtime <runtime>node (Predeterminada) | denoRuntime 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​

NombreObligatorioPropósito
[name]NoNombre de la función que se va a ejecutar.

Opciones​

LargoValorDescripción
--input <json>JSONCarga útil de entrada. Predeterminado {}.
--input-file <path>RutaRuta 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:

  • Data es 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" con ErrorCode: "unknown_error" y el código de salida de la ejecución en Message; 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​

LargoValorObligatorioDescripción
--url <url>urlNoURL de la plataforma UiPath. Vuelve a UIPATH_URL.
--project-id <id>GUIDcondicionalmenteID del proyecto de Studio Web. Obligatorio, pero puede provenir de UIPATH_PROJECT_ID en lugar del marcador.
--org <org>StringNoNombre de la organización. Vuelve a UIPATH_ORGANIZATION_NAME.
--token <token>StringNoToken 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​

LargoValorDescripción
--url <url>urlURL de la plataforma UiPath. Vuelve a UIPATH_URL.
--org <org>StringNombre de la organización. Vuelve a UIPATH_ORGANIZATION_NAME.
--token <token>StringToken de acceso. Vuelve a UIPATH_ACCESS_TOKEN.
--feed-id <id>GUIDFuente 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​

LargoValorDescripción
--path <folder>RutaCarpeta 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​

  • 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 nombrando la versión requerida y un enlace para instalarla. Esta comprobación se ejecuta en setup y automáticamente antes de que new se reenvíe a la CLI de JS/TS.
  • Python o el paquete uipath no configurado (ruta de Python): ConfigError con Instructions para ejecutar uip function setup.

Ver también​

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte(opens in new window)

¿Quiere aprender? UiPath Academy(opens in new window)

¿Tiene alguna pregunta? Foro de UiPath(opens in new window)

Manténgase actualizado