UiPath Documentation
uipath-cli
latest
false
Guia do usuário da UiPath CLI
Importante :
Este conteúdo foi traduzido com auxílio de tradução automática. A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

Função 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.

Conceitos​

  • This is a language dispatcher, not a native tool. Every verb except setup is a thin forwarder: the CLI detects your project's language (from uipath.json, package.json, or pyproject.toml in the current directory, or --language/-l on new) 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.
  • 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 verifica as cadeias de ferramentas. Ele verifica o Node.js ≥ 20 para projetos JS/TS e o Python com o pacote uipath para projetos do Python. A verificação do Node.js também é executada automaticamente antes do new encaminhar para a CLI do JS/TS. Os comandos de funções do Python falham com um ConfigError que aponta para uip function setup até que o Python seja configurado.
  • 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 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.

Opções​

LongValorDescription
--forceBandeiraRe-run the verification even when a cached result exists. Default: false.

Exemplo​

uip function setup --force
uip function setup --force

nova função uipath​

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

Argumentos​

NameRequiredFinalidade
[name]nãoNome/diretório do projeto. my-functionsPadrão. Também pode ser passado como --name.

Opções​

LongValorDescription
--name <name>StringAlternativa ao argumento posicional.
-l, --language <lang>ts (padrão) | js | py/pythonIdioma do projeto.
--emptyBandeiraIgnore a função Olá — projeto vazio. Apenas JS/TS.

Exemplos​

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

Formato dos dados (--output json)​

{ "Code": "NewComplete", "Data": { "Message": "Project created at ./my-fn" } }
{ "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​

LongValorDescription
--language pySinalizador/valorForçar a resolução da linguagem Python quando a detecção seria ambígua.
--skip-solution-registrationBandeiraNão registre automaticamente o projeto em uma .uipx solução pai.

Exemplo​

uip function init
uip function init

Formato dos dados (--output json)​

{ "Code": "InitComplete", "Data": { "Message": "Project initialized." } }
{ "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", "...": "..." } }
}
{
  "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​

LongValorDescription
--port <port>Número inteiroPorta para ouvir. 7070Padrão.
--runtime <runtime>node (Padrão) | denoRuntime para servir em.

Exemplo​

uip function serve
uip function serve

Formato dos dados (--output json)​

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

Execução da função UIP​

Run one function once and print its result. The function name comes from your project's function list.

Argumentos​

NameRequiredFinalidade
[name]nãoName of the function to run.

Opções​

LongValorDescription
--input <json>JSONCarga de entrada. {}Padrão.
--input-file <path>PathPath to a JSON input file. On JS/TS projects, takes precedence over --input.

Exemplos​

# 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

Formato dos dados (--output 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:

  • Data is 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 Output key.
  • Progress and the run's own logs go to stderr, so stdout carries only the envelope.
  • A failed run returns Result: "Failure" with ErrorCode: "unknown_error" and the run's exit code in Message; the run's own error is on stderr.

Sem um --output json/yaml explícito, ou com table ou plain, run imprime a própria saída da CLI subjacente. Em projetos JS/TS, --output não é compatível com run: a CLI imprime um aviso e a própria saída da função segue inalterada.

pacote de funções uiip​

Pack the project into a .nupkg for deployment. The project's lock file is always included in the package.

Exemplo​

uip function pack
uip function pack

Formato dos dados (--output 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" } }

Push da função uiip​

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

Opções​

LongValorRequiredDescription
--url <url>urlnãoURL da UiPath Platform. Realiza o fallback para UIPATH_URL.
--project-id <id>GUIDcondicionalmenteID do projeto do Studio Web. Obrigatório, mas pode vir de UIPATH_PROJECT_ID em vez do sinalizador.
--org <org>StringnãoNome da organização. Realiza o fallback para UIPATH_ORGANIZATION_NAME.
--token <token>StringnãoToken de acesso. Realiza o fallback para UIPATH_ACCESS_TOKEN.

Exemplo​

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

Formato dos dados (--output json)​

{ "Code": "PushComplete", "Data": { "Message": "Push complete." } }
{ "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​

LongValorDescription
--url <url>urlURL da UiPath Platform. Realiza o fallback para UIPATH_URL.
--org <org>StringNome da organização. Realiza o fallback para UIPATH_ORGANIZATION_NAME.
--token <token>StringToken de acesso. Realiza o fallback para UIPATH_ACCESS_TOKEN.
--feed-id <id>GUIDFeed 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
# 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." } }
{ "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​

LongValorDescription
--path <folder>PathPasta de destino na qual criar e instalar dependências de runtime.

Exemplo​

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

Formato dos dados (--output json)​

{ "Code": "RuntimeInstallComplete", "Data": { "Message": "Runtime installed at .uipath/runner" } }
{ "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 abaixo da v20 (caminho JS/TS): ConfigError nomear a versão necessária e um link para instalá-la. Essa verificação é executada em setup e automaticamente antes de new encaminhar para a CLI do JS/TS.
  • Python or the uipath package not configured (Python path): ConfigError with Instructions to run uip function setup.

Veja também​

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte(opens in new window)

Quer aprender? Academia UiPath(opens in new window)

Tem perguntas? Fórum do UiPath(opens in new window)

Fique por dentro das novidades