Ferramentas da UIP

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>] [--version <version>]
uip tools uninstall <package>

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

Data shape (--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/ na lista de permissões (incluindo flow e rpa-legacy, que exigem 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 incluídas na lista de permissões são listadas.

Opções

Nenhum.

Exemplo

uip tools search orchestrator

Data shape (--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 incluída na 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, orchestrator-tool@beta.

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

# preview channel (npm dist-tag)
uip tools install orchestrator-tool@beta

Version resolution

• Com uma versão explícita (@1.0.2 ou @beta), essa versão é usada como está.
• Sem uma versão, o host seleciona a versão publicada mais recente que corresponde à linha MAJOR.MINOR atual da CLI — para que a CLI 1.0.x instale a ferramenta 1.0.*. Isso mantém o host e a ferramenta compatíveis com o protocolo. Consulte Controle de versão e estabilidade.

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 ser resolvido 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.

Data shape (--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.
• --version <version> — versão de destino. O padrão é latest, que resolve da mesma maneira que install faz (fixado na linha MAJOR.MINOR da CLI). Passe uma versão exata (1.0.3) ou uma dist-tag (beta) para substituir.

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

# pin a specific tool to an exact version
uip tools update --name orchestrator-tool --version 1.0.3

# switch a tool to a preview channel
uip tools update --name flow-tool --version beta

Data shape (--output json)

{
  "Code": "UpdateResult",
  "Data": [
    {
      "name": "@uipath/orchestrator-tool",
      "status": "updated",
      "from": "1.0.1",
      "to": "1.0.2"
    },
    {
      "name": "@uipath/solution-tool",
      "status": "up-to-date",
      "from": "1.0.1",
      "to": "1.0.1"
    }
  ]
}

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 .

desinstalação das ferramentas uip

Remove uma ferramenta instalada.

Argumentos

• ( <package> ) — alias, nome abreviado ou nome completo do npm.

Opções

Nenhum.

Exemplos

uip tools uninstall or
uip tools uninstall @uipath/solution-tool

Data shape (--output json)

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

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).

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.