Ferramentas da UIP

Sintaxe e opções para "ferramentas uip", que instala, atualiza e remove as ferramentas baseadas em npm que estendem o UiPath CLI.

uip tools gerencia as ferramentas instaláveis que estendem a CLI. Consulte Ferramentas ( plugins ) para entender o conceito.

Para saber como controlar a instalação automática em executores de CI, consulte Controle da instalação automática da ferramenta.

Resumo

uip tools list
uip tools search [<query>]
uip tools install <package-spec>
uip tools update [--name <package>]
uip tools uninstall [<package>] [--all]

Todos os subcomandos uip tools respeitam as opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato padrão.

lista de ferramentas do uip

Liste as ferramentas instaladas atualmente junto com a CLI.

Argumentos

Nenhum.

Opções

Nenhum.

Exemplo

uip tools list --output table

Formato dos dados (--output json)

{
  "Code": "ToolList",
  "Data": [
    {
      "name": "@uipath/orchestrator-tool",
      "version": "1.0.2",
      "commandPrefix": "or"
    },
    {
      "name": "@uipath/solution-tool",
      "version": "1.0.1",
      "commandPrefix": "solution"
    }
  ]
}

commandPrefix o alias de nível superior que você digita — por exemplo, or para o Orchestrator. Use-o para confirmar o que uip <prefix> … será realmente executado.

pesquisa de ferramentas uip

Pesquise o catálogo de ferramentas da UiPath para ferramentas que você pode instalar. Os resultados são filtrados para as ferramentas @uipath/ da lista de permissões (incluindo rpa-legacy, que requer instalação explícita). Os pacotes de terceiros não são retornados.

Argumentos

• <query> opcional) — correspondência de substring com o nome e a descrição do pacote. Sem ele, todas as ferramentas com permissão são listadas.

Opções

Nenhum.

Exemplo

uip tools search orchestrator

Formato dos dados (--output json)

{
  "Code": "SearchResult",
  "Data": [
    {
      "name": "@uipath/orchestrator-tool",
      "latestVersion": "1.0.2",
      "description": "Orchestrator jobs, folders, processes, packages, and resources",
      "availableVersions": ["1.0.0", "1.0.1", "1.0.2"]
    }
  ]
}

A pesquisa lê o registro npm configurado para o escopo @uipath (normalmente https://registry.npmjs.org/ por meio da configuração padrão do npm ou um registro substituído definido em seu .npmrc). Os resultados são filtrados do lado do cliente em relação à lista de permissões, portanto, qualquer pacote @uipath/ que não esteja na lista de permissões será omitido.

Instalação de ferramentas uip

Instale uma ferramenta com lista de permissões do npm.

Argumentos

• <package-spec> necessário) — a ferramenta a ser instalada. Qualquer um destes:
  • Alias de comando: or, solution, tm, is, vss, df,…
  • Nome curto: orchestrator-tool, solution-tool,…
  • Nome completo do npm: @uipath/orchestrator-tool, @uipath/solution-tool,…
  • Com versão explícita: orchestrator-tool@1.0.2, @uipath/orchestrator-tool@1.0.2. O valor após @ deve ser uma string semver válida (por exemplo 1.0.2 ou 1.0.0-preview.1) — um nome de canal simples, como @beta, é rejeitado com um ValidationError.

Opções

Nenhum.

Exemplos

# by alias — simplest
uip tools install or

# by short name
uip tools install orchestrator-tool

# by full npm name
uip tools install @uipath/orchestrator-tool

# specific version
uip tools install orchestrator-tool@1.0.2

# exact preview build
uip tools install orchestrator-tool@1.0.0-preview.1

# preview channel — switch the channel, then install normally
uip config set updateChannel preview
uip tools install orchestrator-tool

Resolução da versão

• Com uma versão semver explícita (por exemplo @1.0.2 ou @1.0.0-preview.1), essa versão é usada como está. Não há atalhos no npm-dist-tag como @beta — o valor após @ deve ser analisado como semver, ou o comando falha com um ValidationError.
• Sem uma versão, o host resolve usando o canal de atualização da CLI (stable por padrão, ou preview/dev por meio de uip config set updateChannel <channel>) e sua linha MAJOR.MINOR atual — então, uma stable CLI 1.0.x é instalada a ferramenta estável de correspondência mais recente 1.0.*. Isso mantém o host e a ferramenta compatíveis com o protocolo. Consulte Controle de versão e estabilidade e configuração do uip.

Destino de instalação: a ferramenta é instalada ao lado do pacote npm da CLI — globalmente se a CLI for uma instalação global, localmente se a CLI for uma instalação com escopo do projeto. Você não passa um sinalizador de escopo. Execute npm root -g para encontrar o caminho de instalação global em sua máquina.

Aplicação da lista de permissões: <package-spec> deve resolver para um dos pacotes @uipath/ na lista de permissões (ou rpa-legacy). Qualquer outro valor falha com ValidationError e código de saída 3 — as ferramentas de terceiros não são compatíveis com a versão 1.x.

Formato dos dados (--output json)

{
  "Code": "Message",
  "Data": { "Message": "Successfully installed @uipath/orchestrator-tool@1.0.2" }
}

Atualização de ferramentas da uip

Atualize uma ou mais ferramentas instaladas para a versão compatível mais recente.

Argumentos

Nenhum.

Opções

• --name <package> atualizar uma única ferramenta. Aceita alias, nome abreviado ou nome completo do npm. Sem --name, cada ferramenta instalada é atualizada.

Importante:

Não há sinalizador --version em uip tools update — apenas --name está registrado. Cada ferramenta é atualizada para a versão mais recente permitida pela política de versão ativa (normalmente fixada na linha MAJOR.MINOR da CLI); para fixar uma versão específica, use uip config set version <line> ou reinstale com uma versão explícita por meio de uip tools install <package>@<version>.

Exemplos

# update every installed tool to the latest version within the CLI's major.minor line
uip tools update

# update just the Orchestrator tool
uip tools update --name or

Formato dos dados (--output json)

{
  "Code": "UpdateResult",
  "Data": [
    {
      "name": "orchestrator-tool",
      "status": "updated",
      "from": "1.2.2",
      "to": "1.2.3"
    },
    {
      "name": "agent-tool",
      "status": "up-to-date",
      "from": "1.2.3",
      "to": "1.2.3"
    }
  ]
}

Os resultados por ferramenta sempre são emitidos, mesmo em caso de falha parcial. Se alguma ferramenta falhar ao atualizar, o comando sairá com um código de saída diferente de zero e as entradas com falha carregarão um campo error .

Se core.version estiver fixado em uma versão exata (não uma linha MAJOR.MINOR), a atualização será ignorada totalmente — o comando ainda sai de 0 com uma matriz Data vazia e uma nota Instructions explicando a prefixação, desde uma instalação fixada intencionalmente nunca se move.

desinstalação das ferramentas uip

Remova uma ferramenta instalada ou todas as ferramentas instaladas de uma vez.

Argumentos

• [package-name] opcional) — alias, nome abreviado ou nome completo do npm. Mutualmente exclusivo com --all. Forneça exatamente um dos argumentos ou --all — omitir ambos ou passar ambos é um ValidationError.

Opções

• --all — desinstale todas as ferramentas instaladas. Mutualmente exclusivo com [package-name].

Exemplos

# uninstall a single tool
uip tools uninstall orchestrator
uip tools uninstall @uipath/solution-tool

# uninstall every installed tool
uip tools uninstall --all

Formato dos dados (--output json)

A desinstalação de uma única ferramenta emite Code: "Message":

{
  "Code": "Message",
  "Data": { "Message": "Successfully uninstalled @uipath/orchestrator-tool" }
}

--all emite Code: "UninstallResult" com uma linha por ferramenta:

{
  "Code": "UninstallResult",
  "Data": [
    { "name": "orchestrator-tool", "status": "uninstalled" },
    { "name": "agent-tool", "status": "uninstalled" }
  ]
}

Se alguma ferramenta falhar ao desinstalar no caminho --all, sua linha carrega um campo error e o comando sai com um código de saída diferente de zero — o detalhamento completo por ferramenta ainda é emitido.

Após a desinstalação, invocar uip or … instalará automaticamente a ferramenta do Orchestrator novamente no próximo uso, a menos que a instalação automática esteja bloqueada (por exemplo, em um executor sem acesso à rede). Instale explicitamente para evitar isso.

Códigos de saída

• 0 sucesso.
• 1 — falha (instalação, atualização, desinstalação ou um erro no nível da ferramenta). Para update com várias ferramentas, pelo menos uma falhou.
• 3 — erro de validação (alias desconhecido, pacote não incluído na lista de permissões, string de versão inválida) em install e update.

Os próprios erros de validação de argumentos do uninstall (nome do pacote ausente ou --all combinado com um nome de pacote) resultam em 1 em vez de 3, mesmo que o corpo da resposta ainda relata Result: "ValidationError" — ramificação em Result/ErrorCode no corpo do JSON em vez do código de saída se você precisar distinguir esse caso de outros falhas.

Consulte Códigos de saída para obter a tabela completa.

Veja também

• Ferramentas ( Não
• Instalação do UiPath CLI — instale o host e, em seguida, traga ferramentas.
• Controle da instalação automática de ferramentas — por que não há desativação e como manter os tempos de compilação de CI determinísticos.
• Controle de versão e estabilidade — sem contrato entre host e ferramentas.