- 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
- Referência e suporte
Guia do usuário da UiPath CLI
A UiPath CLI é uma reescrita fundamental das ferramentas de linha de comando, substituindo a uipcli.exe usada por meio de. 2025.10 Se você estiver migrando de um pipeline 2025.10, leia o guia de migração — esta página é o resumo do título do que mudou e por que.
Uma ferramenta diferente
A UiPath CLI é uma TypeScript CLI distribuída no npm como @uipath/cli e invocada como uip. Ele é executado no Node.js 18+ no Windows, macOS e Linux. O host e a maioria das ferramentas não têm dependência do.NET; o rpa-tool é a exceção — ele encapsula o empacotador do Studio e o compilador de fluxo de trabalho, ambos os quais ainda exigem um runtime.NET. Instale o host da mesma maneira em todos os ambientes:
npm install -g @uipath/cli
npm install -g @uipath/cli
A CLI é um host de plug-in. Comandos para cada superfície da UiPath — Orchestrator, Soluções, Agentes, Fluxos, Maestro, Test Manager e assim por diante — são enviados como pacotes npm separados que uip instalam automaticamente na primeira vez que você os usa. Consulte Ferramentas ( plugins ).
Controle de versão semântico
A versão baseada em calendário (2023.10, 2024.10, 2025.10) desapareceu. 1.0.0 é o ponto de partida de um contrato semver :
- MAJOR — quebra de alterações com um ciclo de descontinuação completo primeiro.
- MINOR — novos comandos, novos sinalizadores, apenas cumulativo. A forma
Datapode evoluir. - PATCH — apenas correções de bugs.
Coordenada de versões de host e ferramenta: cada ferramenta rastreia a linha MAJOR.MINOR da CLI por padrão. Consulte Controle de versão e estabilidade.
Mais que CI/CD
A CLI legada era uma ferramenta de CI/CD: empacotar, analisar, implantar, executar testes. O UiPath CLI 1.x abrange a plataforma completa — construir, gerenciar, operar, implantar — e foi projetado para ser usado interativamente por desenvolvedores, bem como programaticamente por pipelines. Agora você pode:
- Estruturar e validar projetos (
uip solution new,uip agent init,uip flow init,uip maestro init). - Gerencie recursos do Orchestrator (pastas, processos, pacotes, máquinas, usuários, funções, licenças, filas, ativos, buckets, webhooks).
- Iniciar e monitorar trabalhos (
uip or jobs start,uip or jobs get), com--wait-for-completionopcional. - Conduza o ciclo de vida completo do agente, incluindo a avaliação (
uip agent eval). - Inspecione instâncias e incidentes de Flow e Maestro.
- Gerenciar entidades do Data Fabric e conexões do Integration Service.
Cada comando retorna o mesmo envelope JSON estruturado, portanto, qualquer coisa que você possa fazer manualmente é executável.
JSON por padrão
A saída é JSON no stdout por padrão, com um envelope estável (Result, Code, Data, Message, Instructions). Os humanos aceitam a visualização de tabela com --output table; os pipelines e os agentes de IA recebem dados limpos e estruturados sem sinalizadores extras. Consulte Formatos de saída.
Login interativo amigável
uip login um navegador, faz login no UiPath e persiste a sessão atualizada dentro de ~/.uipath/. As credenciais do cliente não precisam mais ser incorporadas em uma estação de trabalho do desenvolvedor. Os pipelines de CI ainda usam credenciais do cliente de Aplicativo externo (agora passadas por --client-id env.UIPATH_CLIENT_ID), e os contêineres podem usar autenticação de variável de ambiente com um token de acesso opaco. Consulte Autenticação.
Criado para agentes de codificação de IA
O sistema uip skills ensina ao Claude Code, Cursor, GitHub Copilot, Gemini CLI, Codex e OpenCode como usar uip. As habilidades são publicadas pela UiPath e instaladas por agente. Após instalado, o agente pode direcionar um fluxo completo de empacotar-publicar-implantar sem exigir que você digite cada comando. Consulte Uso do UiPath CLI com Agentes de codificação.
Conclusão do shell
uip completion instala a conclusão de guia para bash, zsh, object e PowerShell. A conclusão de valor de sinalizador dinâmico (por exemplo, uip or packages upload --package-name <TAB>) está disponível no zsh quando jq está no PATH; o subcomando estático e a conclusão do nome da opção funcionam em todos os quatro shells.
Outras mudanças significativas
- Nenhuma leitura de autenticação env-var implícita.
UIPATH_CLIENT_IDeUIPATH_CLIENT_SECRETnão são mais lidos automaticamente. Passe-os por meio de--client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET(o prefixoenv.pesquisa a variável no runtime sem expô-la na linha de comando). - Códigos de saída reduzidos a cinco valores (0/1/2/3/4, mais 130 para cancelamento do usuário). O contrato é estável dentro de uma versão MAJOR — script contra eles. Consulte Códigos de saída.
- Filtragem do JmesPath (
--output-filter) em cada comando, no tempo de análise, com código de saída3nos erros de sintaxe para que um erro de digitação não descarte uma chamada de API. - Multiplataforma. ARM64 Windows, macOS e Linux são compatíveis — um exemplo do runtime Node.js.
- Variável de exclusão de telemetria renomeada de
UIPATH_EXTENSIONS_CLI_TELEMETRY_ENABLED=FalseparaUIPATH_TELEMETRY_DISABLED=1. Ambas as geração são desativadas por padrão — atualize os executores de CI que dependiam do nome antigo.
Por onde começar
- Novo usuário? Início rápido.
- Migrando da 2025.10? Guia de migração.
- Configurando o CI? Seu primeiro pipeline → escolha uma receita de CI/CD.
- Trabalhando com agentes de IA? Uso do UiPath CLI com Agentes de Codificação.
Consulte as notas de versão para obter a lista completa de alterações e qualquer coisa enviada depois.