UiPath Documentation
uipath-cli
latest
false
Guia do usuário da UiPath CLI
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.

RPA UiPath

Comandos para empacotar projetos do Studio, executar o analisador e compilador e expor as operações do Studio para agentes de IA usando a ferramenta "uip rpa".

uip rpa a ferramenta RPA — a ponte entre a CLI e uma instalação do UiPath Studio. Ele empacota projetos do Studio em arquivos .nupkg , executa o analisador e compilador de fluxo de trabalho, estrutura e executa projetos e expõe as operações do Studio usadas por agentes de codificação de IA e pelo sistema de habilidades.

Instale-o com ou invoque uip tools install rpa e deixe uip rpa … instalação automática ser executada. Consulte Ferramentas ( plugins ) para ver o modelo de instalação e ferramentas uip para o comando que gerencia a instalação da ferramenta. rpa é o prefixo do comando; o pacote subjacente é @uipath/rpa-tool.

Antes de executar os verbos do empacotador no CI ou em uma máquina nova, certifique-se de que seu runtime e seu SO de executor correspondam à versão do projeto — consulte Pré-requisitos.

Commands

uip rpa verbo tem sua própria página de referência. Para listas de argumentos ao vivo em sua versão da ferramenta instalada, execute uip rpa <verb> --help.

TextoDescription
add-test-data-entityAdicionar uma entidade do Data Service como origem de dados para um caso de teste.
add-test-data-queueAdicione uma Test Data Queue do Orchestrator como fonte de dados para um caso de teste.
add-test-data-variationAdicionar um arquivo de variação de dados do Excel/CSV a um caso de teste.
analyzeExecute o analisador de fluxo de trabalho em um projeto com uma política de governança.
buildCompile um projeto do Studio sem produzir um .nupkg.
create-projectEstruture um novo projeto a partir de um modelo.
diffMostre as diferenças entre dois arquivos em uma janela de comparação do Studio.
find-activitiesPesquise atividades correspondentes a uma consulta e tags opcionais.
get-analyzer-rulesListe as regras do analisador de fluxo de trabalho habilitadas para o projeto aberto.
get-default-activity-xamlRecupere a representação XAML de uma atividade com valores padrão.
get-errorsRecupere diagnósticos de um arquivo ou de todo o projeto, filtrados por gravidade.
get-manual-test-casesObtenha casos de teste manuais do Test Manager.
get-manual-test-stepsObtenha etapas de teste manuais para uma lista de IDs de casos de teste.
get-versionsListar as versões disponíveis de um pacote NuGet nos feeds configurados.
get-workflow-exampleRecupere o XAML de um exemplo de fluxo de trabalho por chave.
indicate-applicationIndique um aplicativo na tela usando o Studio.
indicate-elementIndique um elemento de interface gráfica na tela usando o Studio.
inspect-packageInspecione a API pública de um pacote NuGet por meio de consequência.
install-data-fabric-entitiesAdicionar ou remover associações de entidades do Data Fabric no projeto ativo.
install-or-update-packagesInstale ou atualize pacotes NuGet no projeto atual.
list-data-fabric-entitiesListar entidades do Data Fabric relevantes para o projeto ativo.
list-workflow-examplesPesquise exemplos de fluxo de trabalho de RPA por tag de serviço.
packEmpacote um projeto do Studio em um .nupkg.
restoreBaixe as dependências declaradas em project.json.
run-fileExecute ou depure um fluxo de trabalho/arquivo codificado.
search-templatesPesquise modelos de projeto em feeds NuGet configurados.
start-studioCertifique-se de que uma instância do Studio esteja em execução.
stop-executionInterrompa uma execução em execução iniciada anteriormente com run-file.
uiaSubgrupo da CLI de Automação de Interface Gráfica.

list-instances também está registrado, oculto de --help — ele lista instâncias em execução do Studio visíveis para o resolvedor.

Resumo

uip rpa pack <project> [options]
uip rpa build <projectDir> [options]
uip rpa analyze <project> --governance-file-path <policy> [options]
uip rpa restore <project> [outputPath] [options]
uip rpa start-studio [options]
uip rpa <verb> [options]
uip rpa pack <project> [options]
uip rpa build <projectDir> [options]
uip rpa analyze <project> --governance-file-path <policy> [options]
uip rpa restore <project> [outputPath] [options]
uip rpa start-studio [options]
uip rpa <verb> [options]

Todos os verbos uip rpa respeitam as opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída padrão se aplicam.

O grupo uip rpa aceita um pequeno conjunto de opções compartilhadas por cada verbo:

Opção paiDescription
--project-dir <path>Diretório do projeto no qual o verbo opera. O padrão para o diretório de trabalho atual.
--studio-dir <path>Caminho para uma instalação do Studio quando a descoberta não puder encontrar uma automaticamente.
--robot-dir <path>Caminho para um diretório de instalação do Robô.
--timeout <seconds>Espera máxima para a operação subjacente. Padrão: 300.
--verboseRegistro em log Verbose.

Estes podem ser passados antes ou depois do nome do subcomando.

Observação:

Superfície da sinalização

As páginas por verbo documentam as opções principais. Como o rpa-tool integra o empacotador do Studio, um pequeno conjunto de sinalizadores de empacotadores de canto ( Agenta de assinatura, configuração de fontes do NuGet, filtros de tipo de saída) seguem os sinalizadores nativos do empacotador subjacente — execute uip rpa <verb> --help em uma instalação ativa para ver o conjunto completo para seu versão da ferramenta instalada. Os nomes dos sinalizadores são consistentes entre as versões da ferramenta dentro da linha MAJOR.MINOR da CLI; consulte Controle de versão e estabilidade.

Observação:

wrapper legado somente do Windows

Uma ferramenta irmã, @uipath/rpa-legacy-tool (alias rpa-legacy), encapsula a.NET CLI .NET legada 2025.10 para usuários que precisam de funcionalidades somente do Windows que ainda não foram transferidas para a uip rpa multiplataforma . Ele expõe uip rpa-legacy <verb> para package, validate, debug, find-package, find-activities e type-definition. Consulte a documentação da.NET CLI 2025.10 legada para ver sua referência de sinalizador. rpa-legacy é somente Windows; rpa cobre a superfície moderna.

Pré-requisitos

Duas restrições ambientais governam quando e onde os verbos do empacotador podem ser executados.

Runtime do.NET

Os verbos do empacotador (pack, build, analyze, restore) encapsulam o empacotador do Studio e o compilador de fluxo de trabalho — ambos com suporte do.NET. Um executor que os invoca deve ter um runtime.NET disponível.

Para obter o contexto completo sobre por que rpa-tool mantém uma dependência.NET enquanto o restante da CLI é executada no Node.js, consulte Alterações significativas — Alteração de runtime.

Sistema operacional Runner para projetos Windows

Os projetos do Studio vêm em duas variantes não legadas — multiplataforma (targetFramework: "Portable" em project.json) e Windows (targetFramework: "Windows"). O sistema operacional do executor deve corresponder à versão do projeto:

  • Os projetos multiplataforma podem ser operados a partir de qualquer sistema operacional — Windows, macOS ou Linux.
  • Os projetos do Windows exigem um executor do Windows, independentemente de qual verbo você está executando. A cadeia de ferramentas do Linux e macOS não pode resolver as referências somente do Windows que esses projetos obtêm.
  • Os projetos do Windows - Legado são uma categoria separada — eles exigem a ferramenta uip rpa-legacy , que é somente do Windows por design.

Faça correspondência entre o sistema operacional do executor em seu CI com a versão do projeto ou divida o pipeline para que o trabalho multiplataforma seja executado no Linux/macOS e o trabalho do Windows seja executado em um agente do Windows.

Veja também

  • Commands
  • Resumo
  • Pré-requisitos
  • Runtime do.NET
  • Sistema operacional Runner para projetos Windows
  • 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