Função UIP

Sintaxe e opções para a "função uip", que cria, serve e publica as funções UiPath JS/TS e Python — configuração, novo, init, servir, executar, empacotar, enviar por push, publicar, runtime-install.

uip function , serve e publica UiPath Functions — pequenos manipuladores JS/TS ou Python empacotados e executados na UiPath Platform. uip function é o nome do grupo canônico; uip functions (plual) ainda funciona como um alias de compatibilidade retroativa.

Conceitos

• Este é um dispatcher de idiomas, não uma ferramenta nativa. Cada verbo, exceto setup, é um encaminhador fino: a CLI detecta a linguagem do seu projeto (de uipath.json, package.json, ou pyproject.toml no diretório atual, ou --language/-l em new) e roteia os argumentos brutos para um JS/TS CLI em processo (@uipath/coded-functions-js-cli) ou um Python CLI gerado. uip function <verb> --help para qualquer verbo encaminhado, portanto, mostra a própria ajuda da CLI subjacente, não uma criada por uip— as tabelas de opções abaixo são extraídas das dicas e exemplos de sinalizador do próprio wrapper de encaminhamento, que é o máximo que as ferramentas desse repositório expõem antes do a CLI downstream assume.
• A resolução do idioma é importante para init e new. init é somente Python — para JS/TS, use framework ao invés de new --empty. new detecta automaticamente; quando a detecção é inconclusiva, o padrão é o TypeScript com um aviso registrado, a menos que você passe --language js|ts|py/python.
• setup é executado automaticamente. É um comando oculto (não em --help) que verifica o Node.js ≥ 20 antes de new encaminhar para o JS/TS CLI — você normalmente não o chama por conta própria, mas uip function setup --force executa novamente a verificação se o verificação em cache fica obsoleta (por exemplo, após a reinstalação de um nó).
• publish vs. push segmentar diferentes destinos: publish carrega o .nupkg empacotado para um feed do Orchestrator; push sincroniza o projeto diretamente em um projeto do Studio Web. Ambos aceitam --url/--org/--token (ou as variáveis de ambiente UIPATH_URL/UIPATH_ORGANIZATION_NAME/UIPATH_ACCESS_TOKEN correspondentes).
• Registro automático da solução. Um Python init bem-sucedido registra automaticamente o projeto em uma solução pai .uipx quando uma existir (mesmo padrão que a init agent/case/flow) — passe --skip-solution-registration para cancelar. Isso relata por meio de um envelope de sucesso FunctionsInitSolutionRegistration separado após a saída init da própria CLI do Python subjacente.

Resumo

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

nova função uipath

Estruture um novo projeto de Funções, incluindo uma função Olá, mundo por padrão.

Argumentos

Name	Required	Finalidade
[name]	não	Nome/diretório do projeto. my-functionsPadrão. Também pode ser passado como --name.

Opções

Long	Valor	Description
--name <name>	String	Alternativa ao argumento posicional.
-l, --language <lang>	ts (padrão) | js | py/python	Idioma do projeto.
--empty	Bandeira	Ignore a função Olá — projeto vazio. Apenas JS/TS.

Exemplos

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

Formato dos dados (--output json)

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

Inicialização da função uiip

Somente Python: descubra pontos de entrada e (re)gere entry-points.json/bindings.json/project.uiproj. Deve ser executado antes de pack/push para um projeto do Python. Para JS/TS, use new --empty em vez disso — init falha com um aviso explícito "somente Python" erro em um projeto JS/TS ou um idioma não detectado.

Opções

Long	Valor	Description
--language py	Sinalizador/valor	Forçar a resolução da linguagem Python quando a detecção seria ambígua.
--skip-solution-registration	Bandeira	Não registre automaticamente o projeto em uma .uipx solução pai.

Exemplo

uip function init

Formato dos dados (--output json)

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

Seguido de um segundo registro de solução de relatórios de envelope bem-sucedido:

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

SolutionRegistration.Status é "NotInSolution" quando não existe nenhuma solução pai ou "OptedOut" quando --skip-solution-registration foi passado — sempre presente, nunca omitido.

serviço da função uiip

Inicie o servidor de função local com recarregamento dinâmico. Apenas JS/TS.

Opções

Long	Valor	Description
--port <port>	Número inteiro	Porta para ouvir. 7070Padrão.
--runtime <runtime>	node (Padrão) | deno	Runtime para servir em.

Exemplo

uip function serve

Formato dos dados (--output json)

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

Execução da função UIP

Invoque uma função no ponto de extremidade serve local. Apenas JS/TS.

Argumentos

Name	Required	Finalidade
<name>	sim	Nome da função a ser invocada.

Opções

Long	Valor	Description
--port <port>	Número inteiro	Porta na qual o servidor local está. 7070Padrão.
--input <json>	JSON	Carga de entrada. {}Padrão.

Exemplo

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

Formato dos dados (--output json)

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

Data é o próprio valor de retorno da função, forma determinada inteiramente pela função que você escreve — não normalizada pela CLI.

pacote de funções uiip

Empacote o projeto em um .nupkg para implantação.

Opções

Long	Valor	Description
--nolock	Bandeira	Exclua o arquivo de bloqueio do pacote. Apenas JS/TS.

Exemplo

uip function pack

Formato dos dados (--output json)

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

Push da função uiip

Sincronizar o projeto com o Studio Web — gera pontos de entrada e carrega arquivos alterados.

Opções

Long	Valor	Required	Description
--url <url>	url	não	URL da UiPath Platform. Realiza o fallback para UIPATH_URL.
--project-id <id>	GUID	condicionalmente	ID do projeto do Studio Web. Obrigatório, mas pode vir de UIPATH_PROJECT_ID em vez do sinalizador.
--org <org>	String	não	Nome da organização. Realiza o fallback para UIPATH_ORGANIZATION_NAME.
--token <token>	String	não	Token de acesso. Realiza o fallback para UIPATH_ACCESS_TOKEN.

Exemplo

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

Formato dos dados (--output json)

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

função uip publicar

Carregue o .nupkg mais recente para uma pasta do Orchestrator. Sem --feed-id, solicita interativamente um feed ( ESC para cancelar) — passe --feed-id para uso de CI para ignorar o seletor.

Opções

Long	Valor	Description
--url <url>	url	URL da UiPath Platform. Realiza o fallback para UIPATH_URL.
--org <org>	String	Nome da organização. Realiza o fallback para UIPATH_ORGANIZATION_NAME.
--token <token>	String	Token de acesso. Realiza o fallback para UIPATH_ACCESS_TOKEN.
--feed-id <id>	GUID	Feed para publicar — ignora o seletor interativo.

Exemplos

# Interactive feed picker
uip function publish

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

Formato dos dados (--output json)

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

runtime-instalação da função uip

Crie uma pasta executora com seu próprio package.json e instale dependências de runtime nela. Apenas JS/TS.

Opções

Long	Valor	Description
--path <folder>	Path	Pasta de destino na qual criar e instalar dependências de runtime.

Exemplo

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

Formato dos dados (--output json)

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

Comportamento de erro

• init em relação a um projeto JS/TS ou uma linguagem não detectada:, Failure (ou), Message: "'init' is not applicable to JS/TS projects." "'init' is Python-only."com Instructions nomenclatura new --empty--language/.
• new sem idioma detectável e --language sem: padrão para o TypeScript com um warning registrado em vez de falhar.
• Nenhum projeto de funções detectado para qualquer outro verbo: Failure, Message: "No Functions project detected in this directory.", com Instructions para ser executado a partir de um diretório contendo uipath.json/package.json/pyproject.toml, ou passar --language explicitamente.
• Node.js ausente ou anterior à v20 (caminho JS/TS): ConfigError nomear a versão necessária e um link para instalá-la — essa verificação é executada automaticamente antes de new encaminhar para o JS/TS CLI.

Veja também

• Ferramentas ( plugins )
• uip codedapp — um ciclo de vida de compilação/empacotar/publicar/empurrar/puxar de formato semelhante para aplicativos codificados.
• Opções globais
• Códigos de saída