UiPath Documentation
uipath-cli
latest
false
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.

Guia do usuário da UiPath CLI

Migração do.NET CLI

UiPath CLI 1.x (uip, distribuído no npm como @uipath/cli) substitui o .NET CLI legado (uipcli.exe, distribuído como UiPath.CLI por meio das versões do calendário 2023.10, 2024.10 e 2025.10) . Esta página explica quem deve migrar, quais alterações no nível das ferramentas e como navegar pelas quatro páginas de detalhes abaixo.

Se você quiser apenas a resposta de sinalizador para sinalizador para "o que devo digitar em vez de uipcli <verb>?", Pule para Mapa de comando e Renomeações de sinalizador.

Para quem é este guia

Você deve migrar se alguma das seguintes situações se aplicar:

  • Seu pipeline chama uipcli.exe — diretamente, por meio da tarefa UiPathCLI do Azure DevOps ou de uma etapa de shell do Jenkins/GitHub Actions.
  • Você fixou a CLI legada a uma versão do calendário (2023.10, 2024.10, 2025.10) e tem rastreado sua cadência anual.
  • Você usa a autenticação de usuário/senha (-u/-p) ou a autenticação do token de atualização (-t/-a) no Orchestrator.
  • Você cria um .nupkg com uipcli package pack, implanta com uipcli package deploy ou executa testes do Orchestrator com uipcli test run.

Você pode permanecer na CLI legada por enquanto se precisar de uma funcionalidade somente do Windows que ainda não foi portada para a ferramenta multiplataforma uip rpa (integração do depurador do Studio, validate, find-package, find-activities, type-definition). Uma ferramenta irmã uip rpa-legacy encapsula o binário 2025.10 no Windows; consulte uip rpa — wrapper legado somente do Windows. Todo o resto — empacotamento no Linux/macOS, operações do Orchestrator, Soluções, Test Manager, Agentes, Fluxos, Maestro — está no uip hoje.

O que muda em um piscar de olhos

DimensõesLegado uipcli (a partir de 2025.10)uip 1.x
Nome bináriouipcli.exe / uipcli.dlluip
DistribuiçãoMSI, NuGet (UiPath.CLI, UiPath.CLI.Windows)npm (@uipath/cli)
Runtime.NET 6 /.NET FrameworkNode.js 18 ou superior
PlataformaWindows (principal), Linux via NuGet multiplataformaWindows, macOS, Linux, ARM64
Controle de versãoCalendário (2023.10, 2024.10, 2025.10)Semântica (1.0.0, 1.1.0, 2.0.0)
Instalar modeloMonitoradoHost + plug-ins de ferramenta por superfície (consulte Ferramentas)
Saída padrãoLogs de texto para stdout + código de saídaEnvelope JSON no stdout, logs no stderr
Fluxos de autenticação principaisusuário/senha, token de atualização, app externoaplicativo externo (CI), OAuth interativo (dev), env-token (contêiner)
ConfiguraçãoApenas sinalizadores de CLISinalizadores + variáveis de ambiente (consulte Configuração)

Consulte O que há de novo para o resumo de reescrita.

Em qual versão da CLI estamos?

Execute uipcli --version (ou dotnet uipcli.dll --version). A saída é semelhante a 23.10.8817.35919, 24.10.9248.xxxxx ou 25.10.xxxx.xxxxx. Os caminhos de migração abaixo abrangem todos os três.

Você está executandoOnde ir
uipcli 23.10.*Leia esta página inteira e, em seguida, Mapa de comando + Renomeações de sinalizador. Os verbos deploy e asset deploy que você usa são todos mapeados.
uipcli 24.10.*Igual ao 23.10 — a superfície de comando quase não mudou. Se você adota o solution adicionado em 24.10, cada subcomando é mapeado.
uipcli 25.10.*Igual ao acima. test parallel e o formulário de implantação de vários pontos de entrada --processNames <csv> têm notas de migração específicas no Mapa de comando.
Usando uipcli run <args.json>Consulte o mapa de comando — executar — a nova CLI não tem equivalente direto; o padrão recomendado é um script de shell com uma invocação de uip por etapa.

Tabela de decisão — escolha seu ponto de partida

Seu caso de uso em uipcliDestino da migraçãoPágina de detalhes
Empacotar um projeto do Studio → carregar para o Orchestrator → criar um processouip rpa packuip or packages uploaduip or processes createMapa de comando — pacote
Empacotar e implantar uma Solução (.uipx)uip solution packuip solution publishuip solution deploy runMapa de comando — solução, primeiro pipeline
Iniciar um trabalho do Orchestratoruip or jobs start <process-key> [--wait-for-completion]Mapa de comando — trabalho
Execute um conjunto de testes do Test Manageruip tm testsets runuip tm waituip tm report getMapa de comando — teste
Implantar ativos declarados por CSVuip resource assets create em um loop (sem implantação única de CSV hoje)Mapa de comando — ativo
Execute o analisador de fluxo de trabalhouip rpa analyze <project> --governance-file-path <policy>Mapa de comandos — analisar
Autenticar um pipeline de CIuip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant <name>Renomeações de sinalizadores — auth
Portar um pipeline do Azure DevOps/JenkinsSubstituir blocos de tarefa UiPathCLI por etapas de shell uipExemplos de pipeline

Alterações significativas mais comuns

Esses três aparecem em quase todas as migrações. Consulte Mudanças de impacto para a lista completa.

  1. As autenticação básica (-u/-p) e de atualização do token (-t/-a) não foram mais. Apenas credenciais de cliente de Aplicativo Externo, OAuth2 interativo e tokens de acesso de variável de ambiente são compatíveis. Consulte Autenticação.
  2. UIPATH_CLIENT_ID / UIPATH_CLIENT_SECRET não são mais lidos implicitamente. Passe-os como --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET (o prefixo env. lê a variável sem expô-la na linha de comando).
  3. stdout é JSON por padrão. Os scripts de shell legados que analisaram a saída de texto uipcli precisam usar jq (ou --output plain + --output-filter) ou alternar para --output table para leitura humana.

Antes de começar

Conclua estas quatro etapas antes de começar a portar um pipeline.

1. Faça backup de seus arquivos do pipeline atuais

Confirme uma cópia conhecida de cada azure-pipelines.yml, Jenkinsfile, .github/workflows/*.yml ou .gitlab-ci.yml em uma ramificação (ou tag). A porta é mais fácil de revisar como uma comparação.

2. Fixe @uipath/cli em uma versão específica

Sempre instale com uma versão explícita durante a migração para que o comportamento do pipeline não mude inesperadamente:

npm install -g @uipath/cli@1.0.0
npm install -g @uipath/cli@1.0.0

As ferramentas fixadas implicitamente à linha da CLI (consulte MAJOR.MINOR de versão), portanto, uma CLI fixada também fixará cada ferramenta a um intervalo secundário conhecido. Para reprodutibilidade rigorosa no nível de patch, fixe também ferramentas — consulte a seção "Fixar versões no CI" de Padrões de script.

3. Marque os documentos do.NET CLI legados

Comportamento do sinalizador de referência cruzada durante a porta. A referência 2025.10 reside em docs.uipath.com — Interface de linha de comando da UiPath (2025.10). Mantenha-o aberto em uma guia.

4. Crie um aplicativo externo na UiPath

A CLI legada aceita vários modos de autenticação; a nova CLI recolhe a autenticação de CI para credenciais de clientes de Aplicativos Externos. Crie o aplicativo agora para que a porta tenha algo para apontar. Consulte Autenticação — Fluxo 2.

Dica:

Conceda ao aplicativo externo os mesmos escopos que sua CLI legada usou — OR.Folders, OR.Jobs, OR.Execution, OR.Assets, OR.Users.Read, OR.Machines.Read, OR.TestSets, OR.TestSetExecutions abrange o caso de CI comum. Consulte o valor --applicationScope de suas chamadas uipcli existentes para obter a lista exata de que você precisa.

As quatro páginas de detalhes

Cada página abaixo está focada o suficiente para revisar de uma só vez. Trabalhe com eles para obter a porta se de um pipeline completo; vá diretamente para aquela de que você precisa se quiser apenas uma resposta específica.

Mapa de comando

Cada verbo legado — package pack, package analyze, package deploy, package restore, job run, test run, test parallel, asset deploy, asset delete, solution pack, solution deploy, run — com seu uip equivalente, uma classificação 1:1 / multi-etapas / removida e um fragmento de shell antes/depois para cada linha não trivial.

Renomeações de sinalizadores

Mapeamento no nível do sinalizador com o bloco de autenticação na parte superior. Legado -u/-p/-t/-a/-A/-I/-S/-o/--applicationScope/--identityUrl/--outputType/--traceLevel mapeado para suas contrapartes uip (ou chamadas como removidas, com a substituição). Leia isso junto com o mapa de comando — o mapa de comando mostra o verbo, sinalizador renomeia mostra o sinalizador.

Mudanças de impacto

Cobertura proativa das alterações que interrompem pipelines sem aviso. Remoções de modo de autenticação, remoção de leitura automática de env-var, strings de contrato de código de saída, padrão JSON-stdout, pastas NuGet com versão de calendário foram removidas, runtime.NET encerrado. Um parágrafo por alteração com uma correção "o que fazer".

Pipelines

Fragmentos antes/depois para o Azure DevOps e Jenkins (obrigatório), com Actions mais curtas do GitHub e fragmentos de CI do GitLab. Vinculação cruzada às fórmulas completas de CI/CD para pipelines completos.

Veja também

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades