Interface de Linha de Comando do Robô

Robot Command Line Interface (UiRobot.exe) for starting automations, connecting to Orchestrator, and managing the Robot from a terminal.

The UiPath Robot Command Line Interface is a tool that allows you to interact with the Robot from a command line terminal. It uses the UiRobot.exe file to start automations, install processes, connect and disconnect the Robot from Orchestrator, and manage logs, tracing, the Robot session (PiP), proxy credentials, and the NuGet cache directly from the command line.

Como funciona

Para usar a CLI, certifique-se dos seguintes aspectos:

• O Serviço de Robôs da UiPath está em execução
• Você está no diretório no qual o Robô está instalado.

Then enter instructions or commands that refer to the UiRobot.exe program along with the necessary parameters, depending on what you want your automation to achieve.

UiRobot.exe is in the Robot installation folder: %ProgramFiles%\UiPathPlatform\Robot\<version> for a per-machine installation, or %LocalAppData%\Programs\UiPathPlatform\Robot\<version> for a per-user installation.

Command and option names aren't case-sensitive.

When the Robot runs in service mode, the connect, disconnect, and flushlogs commands require an elevated command prompt (run as administrator).

Por exemplo, para iniciar um processo da linha de comando, você usaria o seguinte comando:

UiRobot.exe execute --file "C:\UiPath\Projects\YourProject\project.1.0.0.nupkg"

Comandos comuns do UiRobot.exe

Executar

Use esse comando para iniciar a execução de um arquivo de projeto dos seguintes tipos:

• NUPKG
• JSON (legacy projects only)
• XAML (legacy projects only)

Observação:

Com a versão 2023.4 do Robô, a UiPath atualiza a lista de processos ao mesmo tempo em que um processo é executado. Se uma atualização de processo estiver disponível no início do trabalho, o trabalho usará a versão mais antiga do processo. As execuções subsequentes aplicam o processo atualizado.

O comando execute usa os seguintes argumentos:

UiRobot.exe execute (--package-id <Package_ID> | --process-name <Process_Name> | --file <File_Path>) [--input <Input_Parameters>] [--folder <Orchestrator_Folder_Path>] [--entry <Entry_Point_Path>]

Use exactly one of --package-id, --process-name, and --file.

• -p, --package-id <Package_ID> - Starts the process with this package ID, from the Orchestrator feed or the local feed. The Robot uses the available version of the package.

  Exemplos:

  UiRobot.exe execute --package-id UiPathDemo
  

  UiRobot.exe execute -p UiPathDemo
  

• -r, --process-name <Process_Name> - Starts the process with this name, as defined in Orchestrator.

  Exemplo:

  UiRobot.exe execute --process-name UiPathDemoProcess
  

• -f, --file <File_Path> - Starts the execution of a local project file. The target file can be NUPKG, or JSON or XAML for legacy projects only.

  Exemplo:

  UiRobot.exe execute --file "C:\UiPath\Automation\project.1.0.0.nupkg"
  

• --folder <Orchestrator_Folder_Path> (optional) - The path of the Orchestrator folder from which to install and execute the target process, such as Product/Development/QA. Required when the process is deployed in more than one folder.

  Exemplo:

  UiRobot.exe execute --package-id UiPathDemo --folder "Product/Development/QA"
  

• -i, --input <Input_Parameters> (optional) - Input arguments for the execution, in JSON format.

  Exemplos:

  UiRobot.exe execute --package-id UiPathDemo --input "{\"intArg\" : 3, \"strArg\" : \"hello\"}"
  

  UiRobot.exe execute --file "C:\UiPath\Automation\project.1.0.0.nupkg" --input "{\"intArg\" : 3, \"strArg\" : \"hello\"}"
  

  In PowerShell, enclose the JSON in single quotes: --input '{\"intArg\" : 3, \"strArg\" : \"hello\"}'.

• --entry <Entry_Point_Path> (optional) - Selects the entry point of the process. It applies to .nupkg files and --package-id. It is ignored when --file points to a .xaml or .json file, and you can't use it with --process-name.

  Exemplo:

  UiRobot.exe execute --file "C:\UiPath\Project\project.1.0.3.nupkg" --entry "OtherEntryPoint.xaml"
  

  Importante:

  • Os seguintes comandos não são compatíveis com projetos do Windows ou multiplataforma:

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

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

  • The --process argument of earlier versions still works as an alias of --package-id.

Processo de instalação

Use esse comando para instalar um processo. Se o Robô estiver conectado ao Orchestrator, ele pesquisará o processo no feed do Orchestrator. Sem uma conexão com o Orchestrator, o Robô usa o feed local.

O comando do processo de instalação usa os seguintes argumentos:

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

• -p, --process-name <process_name> (mandatory) - The name of the process you want to install. The -p short form means process name here, but package ID in the execute command.

  Exemplo:

  UiRobot.exe installprocess --process-name MyProcess
  

• --folder <orchestrator_folder_path> (optional) - The full path of the Orchestrator folder containing the process you want to install, such as Product/Development/QA. This argument applies only when the connection to Orchestrator is active. If only one folder contains the process for installation, skip this parameter.

  Exemplo:

  UiRobot.exe installprocess --process-name MyProcess --folder "Product/Development/QA"
  

Conectar

Use this command to connect your Robot to an Orchestrator instance. If your Robot is already connected to a different Orchestrator instance or with different credentials, the command returns the "Orchestrator already connected" message. Run disconnect first to switch. Running it again with the same URL and credentials succeeds and changes nothing.

O comando usa os seguintes argumentos:

UiRobot.exe connect --url <Orchestrator_Server_URL> --clientId <Client_ID> --clientSecret <Client_Secret>

• connect - Establishes the connection to Orchestrator. Must be used together with the --url, --clientId, and --clientSecret arguments.

  Exemplo:

  UiRobot.exe connect --url https://cloud.uipath.com/<Organization_Name>/<Tenant_Name>/orchestrator_ --clientId <Client_ID> --clientSecret <your-client-secret>
  

  The command also accepts --url with --key <Machine_Key> for a machine key connection. Robots connected with a machine key don't run agents, functions, or API workflows by default, and the command prints a message that calls machine key connections deprecated. For the differences, refer to Connecting the Robot to Orchestrator.

Desconectar

Use esse comando para desconectar o Robô da instância atual do Orchestrator.

O comando disconnect usa os seguintes argumentos:

UiRobot.exe disconnect [--force | --wait]

• disconnect - Desconecta o robô do Orchestrator apenas quando não houver trabalhos em execução na máquina do robô.

  Exemplo:

  UiRobot.exe disconnect
  

• --force - Encerra todos os trabalhos em execução na máquina e, em seguida, desconecta o Robô do Orchestrator.

  Exemplo:

  UiRobot.exe disconnect --force
  

• --wait - Aguarda a conclusão de trabalhos em execução antes de desconectar o robô do Orchestrator.

  Exemplo:

  UiRobot.exe disconnect --wait
  

You can't use --force and --wait together. The disconnectandsignout command takes the same arguments, and also signs out the current user.

Trace

Use this command to enable or disable low-level tracing of the UiPath drivers and the browser extension. Tracing of the Robot Executor and Service is always on, and the command prints a warning about it.

O comando trace usa os seguintes argumentos:

UiRobot.exe trace --enableLowLevel | --disableLowLevel

• --enableLowLevel - Starts low-level tracing of the UiPath drivers and the browser extension. Requires administrator rights.

  Exemplo:

  UiRobot.exe trace --enableLowLevel
  

• --disableLowLevel - Stops it and saves the trace as UiPathTrace-<id>.etl on the Desktop of the user who runs the command. Requires administrator rights. Without them, the command shows an error but still returns exit code 0.

  Exemplo:

  UiRobot.exe trace --disableLowLevel
  

PiP

Use esse comando para habilitar ou desabilitar a sessão do Robô ou o recurso Picture in Picture na máquina. Essa configuração modifica as instalações existentes e se aplica a todos os usuários na máquina local. Requer privilégios de administrator.

O comando PiP usa os seguintes argumentos:

UiRobot.exe pip --enable | --disable

• --enable - Enables the Robot session (PiP functionality) of the machine.

  Exemplo:

  UiRobot.exe pip --enable
  

• --disable - Disables the Robot session (PiP functionality) of the machine.

  Exemplo:

  UiRobot.exe pip --disable
  

Limpar cache do NuGet

Use este comando para limpar os caches do NuGet: o cache de pacotes globais (onde reside o conteúdo .nupkg restaurado) e o cache HTTP (cache de resposta de feed do NuGet).Nenhum trabalho deve estar em execução durante esta Operação.

O comando limpar cache do NuGet usa os seguintes argumentos:

UiRobot.exe cleannugetcache [--period <period_in_days>] [--timeout <timeout_in_minutes>] [--allow-unsafe]

• -p, --period <period_in_days> (optional, default 30) - Deletes global-packages entries whose .nupkg.metadata file has not been accessed in the last X days. Stale or corrupt package folders (missing .nupkg.metadata) are removed regardless of this value, unless they are listed in nugetclean.ignore. The HTTP cache is wiped in full regardless of this value. Must be greater than 0.

  Exemplo:

  UiRobot.exe cleannugetcache --period 60
  

• -t, --timeout <timeout_in_minutes> (optional, default 10) - Maximum time, in minutes, to wait for the cleanup. Press Ctrl+C to cancel the cleanup; the command then prints a partial summary.

  Exemplo:

  UiRobot.exe cleannugetcache --timeout 20
  

• --allow-unsafe (optional, default false) - By default, the command refuses to run if the Robot packages folder (PackagesInstallationFolder in UiPath.config) differs from the default NuGet global-packages folder (a folder that may be shared with other users). Use this flag to force cleanup of the Robot packages folder.

  Importante:

  Cleaning a shared packages folder may break running jobs or apps belonging to other users sharing the folder.

  Exemplo:

  UiRobot.exe cleannugetcache --period 30 --allow-unsafe
  

O comando imprime um resumo da limpeza, dividido por global-packages e http-cache, incluindo quantas entradas foram excluídas do total correspondente.

To protect package folders from the cleanup, list them in a nugetclean.ignore file in the global-packages folder. Write one package folder per line, as an absolute path or a path relative to the global-packages folder. A line with only a package ID keeps every version of that package. Blank lines and lines that start with # are ignored.

Definir credenciais de autenticação básica do proxy

Use esse comando para definir credenciais básicas de autenticação de proxy para o usuário atual. As credenciais persistem localmente e o robô as utiliza ao se comunicar por meio de um proxy que requer autenticação básica.

O comando set proxy usa os seguintes argumentos:

UiRobot.exe setproxy --username <user> --password <password> [--domain <domain>]

• --username <user> (obrigatório) - O nome de usuário para a autenticação básica do proxy.

• --password <password> (obrigatório) - A senha para autenticação básica de proxy.

  Exemplo:

  UiRobot.exe setproxy --username myuser --password <your-password>
  

• --domain <domain> (opcional) - O domínio para autenticação básica de proxy.Use esta opção quando o proxy exigir credenciais qualificadas pelo domínio.

  Exemplo:

  UiRobot.exe setproxy --username myuser --password <your-password> --domain MYDOMAIN
  

Importante:

A execução do comando substitui quaisquer credenciais de proxy armazenadas anteriormente.

Outros argumentos

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

• version - Displays information about the Robot version. The --version form also works.
• --help - Exibe a lista de comandos compatíveis, bem como as informações e exemplos correspondentes.
• flushlogs [--timeout <timeout_in_seconds>] - Sends all pending logs to Orchestrator. The default timeout is 30 seconds.

Códigos de saída

UiRobot.exe returns the following exit codes:

Código de saída	Significado
0	The command succeeded. For execute, the job completed successfully.
1	For execute, the job failed. For cleannugetcache, the cleanup didn't complete successfully.
2	For execute, the job suspended. The command prints the resumeId of the suspended job.
-1	The command was used incorrectly (invalid or missing arguments), or it failed with an error.