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 da linha de comando suportados pelos Robôs, certifique-se de que o serviço do UiPath Robot 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.

All the examples displayed in the Arguments Description chapter are constructed from the assumption that you performed this action.

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:

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>	Mandatory. Starts the execution of a local project file. The target file can be .json, .xaml, or .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>	Optional. Allows you to specify the Orchestrator folder from which to install and execute the target process. It can only be used together with the --process argument. Exemplo: UiRobot.exe -Execute --process UiPathDemoProcess --folder OrchFolder1
--input <Input_Parameters>	Optional. Allows you to specify input arguments for execution. It can be used with the --process or --file arguments. 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	Permite que você selecione o ponto de entrada de um processo ao iniciá-lo pela linha de comando. Exemplos: 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\Project.json"
• UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml"

O Comando Pack

Observação:

For Studio v2018.4.4 and later releases we recommend publishing using the command UiPath.Studio.CommandLine.exe publish instead of UiRobot.exe pack. For more information, see Mass Update Command Line Parameters in the Studio guide.

• 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" --output "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" --output "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

Used to connect the robot to Orchestrator, must be used with the --url, --key, or --clientID --clientSecret arguments. If the arguments are not specified, the Orchestrator configuration in Assistant is used to establish the connection. 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

• UiRobot.exe disconnect

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

O Comando Trace

• UiRobot.exe trace --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 que você habilite a funcionalidade Picture in Picture da máquina, durante a instalação da linha de comando da 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.
logs --flush	Envia todos os logs pendentes para o Orchestrator.