Interface de Linha de comando

A Interface de Linha de Comando do Robô (UiRobot.exe) é um aplicativo de console que pode solicitar o início de trabalhos, e aguardar os resultados. É um cliente direto do serviço do Robô, e a comunicação é feita por meio de um canal WCF.

Para fazer uso dos argumentos de linha de comando compatíveis com Robôs, certifique-se de que o Serviço de Robôs UiPath^® esteja em execução. Se não, inicie-o a partir do snap-in do Console de Gerenciamento de Serviços da Microsoft.

Para facilitar o seu trabalho com os argumentos da linha de comando, navegue até o diretório no qual o Robô está instalado, usando o comando de mudança de diretório. Por exemplo, se você não alterou o local padrão do Robô, você pode usar o seguinte: cd C:\Program Files\UiPath\Studio.

Todos os exemplos exibidos no capítulo Descrição dos Argumentos são construídos a partir do pressuposto de que você realizou essa ação.

Descrição dos Argumentos

Para facilitar o seu trabalho com os argumentos da linha de comando, navegue até o diretório no qual o Robô está instalado, usando o comando de mudança de diretório. Por exemplo, se você não alterou a localização padrão do Robô, use o seguinte comando:

cd C:\Program Files\UiPath\Studio.

Todos os exemplos exibidos aqui são construídos a partir da suposição de que você executou primeiro o comando acima.

Os Robôs Assistidos devem ser executados apenas sob supervisão humana.

O Comando Execute

• UiRobot.exe execute [--process <Package_ID> | --file <File_Path>] [--folder <Orchestrator_Folder_ID>] [--input <Input_Parameters>]

Esse comando é usado para iniciar a execução de um processo ou um arquivo (.json, .xaml ou .nupkg). Observe que os argumentos --process (-p) e --file (-f) não podem ser usados simultaneamente com o comandoexecute. Ele suporta os seguintes argumentos:

Observação: a partir da versão v2023.4, A lista de processos é atualizada em paralelo com a execução dos processos. Antes disso, a lista de processos era atualizada antes do início do processo. Isso significa que, ao executar um processo para o qual há uma atualização disponível, o trabalho pode ser executado com a versão mais antiga do processo.

Argumento	Description
-p--process <Package_ID>	Obrigatório. Inicia a execução de um processo local ou do Orchestrator. Exemplos: UiRobot.exe execute --process UiPathDemoProcess UiRobot.exe execute -p UiPathDemoProcess
-f--file <File_Path>	Obrigatório. Inicia a execução de um arquivo de projeto local. O arquivo de destino pode ser .json, .xaml ou .nupkg. Exemplos: UiRobot.exe execute --file "C:\UiPath\Automation\Project.json" UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml" UiRobot.exe execute --file "C:\UiPath\Automation\Notepad.1.0.6682.21636.nupkg"
--folder <Orchestrator_Folder_ID>	Opcional. Permite que você especifique a pasta do Orchestrator a partir da qual instalar e executar o processo de destino. Só pode ser usado em conjunto com o argumento do --processo. Exemplo: UiRobot.exe -Execute --process UiPathDemoProcess --folder OrchFolder1
--input <Input_Parameters>	Opcional. Permite que você especifique argumentos de entrada para execução. Pode ser usado com os argumentos de --processo ou --arquivo. Exemplos: UiRobot.exe execute --process UiPathDemoProcess --input "{'inArg' : 'value' , 'Integer' : 3}" UiRobot.exe execute --process UiPathDemoProcess --folder OrchFolder1 --input "{'inArg' : 'value' , 'Integer' : 3}" UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml" --input "{'inArg' : 'value' , 'Integer' : 3}"
--entry <entrypoint>	Permite que você selecione o ponto de entrada de um processo ao iniciá-lo pela linha de comando. Exemplo: UiRobot execute --file "C:\UiPath\Project\project.1.0.3.nupkg" --input "{'inArg':'value','integer':3}" --entry "OtherEntryPoint.xaml"

Importante: os comandos a seguir não são compatíveis com projetos do Windows ou Portable:

• UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml"

• UiRobot.exe execute --file "C:\UiPath\Automation\Project.json"

O comando Instalar processo

• UiRobot.exe installprocess [--process-name <process_name>] [--folder <orchestrator_folder>]

O comando installprocess é usado para instalar um processo. Quando o Robot é conectado ao Orchestrator, o Robot só olha para o processo no feed do Orchestrator. Quando o Robot não está conectado ao Orchestrator, o feed local é usado.

Os seguintes argumentos são compatíveis:

Argumento	Description
--process-name <process_name>	Obrigatório. O nome do processo a ser instalado. Exemplo: UiRobot installprocess --process-name MyProcess
--folder <orchestrator_folder>	Opcional.O nome da pasta do Orchestrator na qual o processo a ser instalado é encontrado. Esse argumento só pode ser usado quando o Robot estiver conectado ao Orchestrator. Se o processo a ser instalado for encontrado em apenas uma pasta, o parâmetro não será necessário. Exemplo: UiRobot installprocess -p MyProcess --folder MyOrchestratorFolder

O Comando Pack

Observação: Para as versões do Studio v2018.4.4 e posterior, recomendamos a publicação usando o comando UiPath.Studio.CommandLine.exe publish ao invés do UiRobot.exe pack. Para mais informações, consulte Parâmetros de Linha de Comando de Atualização em Massa no guia do Studio.

• UiRobot.exe pack <Project_Path> --output <Destination_Folder> [-v <Project_Version>]

Esse comando é usado para empacotar um arquivo Project.json em um arquivo .nupkg. Ele suporta os seguintes argumentos:

Argumento	Description
-o --output <Destination_Folder>	Obrigatório. Permite que você especifique onde o arquivo .nupkg é criado. Exemplo: UiRobot.exe pack "C:\UiPath\Automation\Project.json" --saída "C:\UiPath\Automation\Packages"
-v <Project_Version>	Opcional. Permite que você especifique uma versão para o arquivo .nupkg. Exemplo: UiRobot.exe pack "C:\UiPath\Automation\Project.json" --saída "C:\UiPath\Automation\Packages" -v 1.0.6820.22047

O Comando Connect

• UiRobot.exe connect [--url <Orchestrator_Server_URL> --key <Machine_Key>] | [--connectionString <Connection_String>]

  Observação: se o Robô já estiver conectado, a execução do comando connect retorna a seguinte mensagem: Orchestrator already connected!.

Esse comando é usado para conectar o Robô a uma instância do Orchestrator. Ele suporta os seguintes argumentos:

Argumento

Description

connect

Usado para conectar o robô ao Orchestrator, deve ser usado com os argumentos --url, --key ou --clientID --clientSecret. Se os argumentos não forem especificados, a configuração do Orchestrator no UiPath Assistant será usada para estabelecer a conexão. Exemplo: UiRobot.exe connect Exemplo de chave da máquina: UiRobot.exe connect --url https://demo.uipath.com/ --key 1122AAB3C-DD44-ABCD-1234-7788GG99HH00 Exemplo de ID do cliente e de Segredo do cliente: UiRobot.exe connect --url https://demo.uipath.com/ --clientID 696CCA0C-1234-ABCD-1234-F65BBC2F15DE --clientSecret QJX!jv12345A4q4N

O Comando Disconnect

Esse comando é usado para desconectar o Robô da instância atual do Orchestrator.

Argumento	Description
UiRobot.exe disconnect	Desconecte o robô do Orchestrator. Esse comando só funciona se não houver trabalhos em execução na máquina do robô.
UiRobot.exe disconnect --force	Desconecte o robô do Orchestrator. Se houver um trabalho sendo executado na máquina, ele será interrompido e só então o robô será desconectado
UiRobot.exe disconnect --wait	Desconecte o robô do Orchestrator. Se houver um trabalho em execução na máquina, o robô será desconectado apenas após a conclusão do trabalho.

O Comando Trace

• Rastreamento UiRobot.exe --enableLowLevel | --disableLowLevel

Esse comando é usado para habilitar ou desabilitar o rastreamento de baixo nível (verbose) para o Robô. Ele suporta os seguintes argumentos:

Argumento	Description
--enableLowLevel	Habilita o rastreamento de baixo nível. Um arquivo .etl é gerado, que pode ser aberto com o Visualizador de Eventos, para ajudar você a solucionar problemas de falhas e erros. Isso habilita o rastreamento verboso para o Executor do Robô e Serviço do Robô no Visualizador de Eventos. Exemplo: UiRobot.exe trace --enableLowLevel
--disableLowLevel	Desabilita o rastreamento de baixo nível. Um arquivo .etl é gerado para a Área de Trabalho após você encerrá-lo. Esse arquivo pode ser aberto no Visualizador de Eventos, para ajudar você a solucionar problemas de falhas e erros. Exemplo: UiRobot.exe trace --disableLowLevel

O Comando PiP

Permite que você habilite ou desabilite o recurso Picture in Picture na máquina. Essa configuração é aplicada na máquina local e afeta todos os usuários, além de ser usada para modificar aplicativos instalados já existentes.

São necessários direitos de administrador para executar esses comandos.

Command	Description
PiP --enable	Habilita o recurso Picture in Picture da máquina.
PiP --disable	Desabilita o recurso Picture in Picture da máquina.

O Comando ENABLE_PIP

Permite habilitar a funcionalidade Picture in Picture da máquina durante a instalação da linha de comando UiPath^®.

Command	Description
ENABLE_PIP=1	Habilita o recurso Picture in Picture da máquina.
ENABLE_PIP=0	Não habilita o recurso de Picture in Picture da máquina.

Comandos Diversos

Os seguintes comandos são puramente informativos e não têm impacto em seus projetos de automação:

Argumento	Description
--version	Exibe informações sobre a versão do Robô.
--help	Exibe a lista de comandos suportados, bem como informações correspondentes e exemplos.
flushlogs [--timeout <timeout_in_seconds>]	Envia todos os logs pendentes para o Orchestrator.