- Visão geral
- Introdução
- Conceitos
- Usando o UiPath CLI
- UiPath para agentes de codificação
- Guias de instruções
- Receitas de CI/CD
- Referência de comando
- Visão geral
- Códigos de saída
- Opções globais
- Agente de código uip
- Documento da UIP
- adicionar-tipo-dados-de-teste
- adicionar-dados-de-teste-fila
- adicionar-teste-variação de dados
- Analisar
- Criar
- criar projeto
- Comparação
- encontrar atividades
- obter-analisador-regras
- obter-padrão-atividade-xaml
- obter-erros
- obter-casos-de-teste-manuais
- obter-etapas-de-teste-manual
- Obter versões
- obter-fluxo-de-trabalho-exemplo
- indicar aplicativo
- indicar elemento
- inspecionar pacote
- instalar-data-fabric-entities
- instalar-ou-atualizar pacotes
- listar-data-fabric-entities
- listar-exemplos-de-fluxo-de-trabalho
- Empacotar
- restore
- arquivo de execução
- modelos-pesquisar
- Iniciar Studio
- interromper a execução
- UIA
- Traces da UIP
- Migração
- Visão geral
- Migração do.NET CLI legado
- Mapa de comando (legado para uip)
- Renomeações de sinalizadores
- Mudanças de impacto
- Referência e suporte
Guia do usuário da UiPath 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 tarefaUiPathCLIdo 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
.nupkgcomuipcli package pack, implanta comuipcli package deployou executa testes do Orchestrator comuipcli 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ões | Legado uipcli (a partir de 2025.10) | uip 1.x |
|---|---|---|
| Nome binário | uipcli.exe / uipcli.dll | uip |
| Distribuição | MSI, NuGet (UiPath.CLI, UiPath.CLI.Windows) | npm (@uipath/cli) |
| Runtime | .NET 6 /.NET Framework | Node.js 18 ou superior |
| Plataforma | Windows (principal), Linux via NuGet multiplataforma | Windows, macOS, Linux, ARM64 |
| Controle de versão | Calendário (2023.10, 2024.10, 2025.10) | Semântica (1.0.0, 1.1.0, 2.0.0) |
| Instalar modelo | Monitorado | Host + plug-ins de ferramenta por superfície (consulte Ferramentas) |
| Saída padrão | Logs de texto para stdout + código de saída | Envelope JSON no stdout, logs no stderr |
| Fluxos de autenticação principais | usuário/senha, token de atualização, app externo | aplicativo externo (CI), OAuth interativo (dev), env-token (contêiner) |
| Configuração | Apenas sinalizadores de CLI | Sinalizadores + 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á executando | Onde 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 uipcli | Destino da migração | Página de detalhes |
|---|---|---|
| Empacotar um projeto do Studio → carregar para o Orchestrator → criar um processo | uip rpa pack → uip or packages upload → uip or processes create | Mapa de comando — pacote |
Empacotar e implantar uma Solução (.uipx) | uip solution pack → uip solution publish → uip solution deploy run | Mapa de comando — solução, primeiro pipeline |
| Iniciar um trabalho do Orchestrator | uip or jobs start <process-key> [--wait-for-completion] | Mapa de comando — trabalho |
| Execute um conjunto de testes do Test Manager | uip tm testsets run → uip tm wait → uip tm report get | Mapa de comando — teste |
| Implantar ativos declarados por CSV | uip resource assets create em um loop (sem implantação única de CSV hoje) | Mapa de comando — ativo |
| Execute o analisador de fluxo de trabalho | uip rpa analyze <project> --governance-file-path <policy> | Mapa de comandos — analisar |
| Autenticar um pipeline de CI | uip 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/Jenkins | Substituir blocos de tarefa UiPathCLI por etapas de shell uip | Exemplos 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.
- 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. UIPATH_CLIENT_ID/UIPATH_CLIENT_SECRETnão são mais lidos implicitamente. Passe-os como--client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET(o prefixoenv.lê a variável sem expô-la na linha de comando).- stdout é JSON por padrão. Os scripts de shell legados que analisaram a saída de texto
uipcliprecisam usarjq(ou--output plain+--output-filter) ou alternar para--output tablepara 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.
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
- O que há de novo — resumo do título da regravação.
- Seu primeiro pipeline — guia passo a passo de
pack → publish → deploy runcom a nova CLI. - Autenticação — os três fluxos de autenticação compatíveis com 1.x.
- Códigos de saída — o contrato reduzido de cinco níveis.
- Ferramentas ( plugins ) — por que a superfície de comando é dividida entre pacotes npm e o que é instalado automaticamente no primeiro uso.
- Para quem é este guia
- O que muda em um piscar de olhos
- Em qual versão da CLI estamos?
- Tabela de decisão — escolha seu ponto de partida
- Alterações significativas mais comuns
- Antes de começar
- 1. Faça backup de seus arquivos do pipeline atuais
- 2. Fixe @uipath/cli em uma versão específica
- 3. Marque os documentos do.NET CLI legados
- 4. Crie um aplicativo externo na UiPath
- As quatro páginas de detalhes
- Mapa de comando
- Renomeações de sinalizadores
- Mudanças de impacto
- Pipelines
- Veja também