Primeiros comandos (início rápido)

Início rápido de cinco comandos para o UiPath CLI que cobre a instalação, o login, a listagem de trabalhos, o início de um processo e a verificação do resultado.

Este início rápido orienta você por cinco comandos que levam você de uma nova instalação a um trabalho em execução no Orchestrator. Aguarde cinco minutos.

Antes de começar

• Instale o UiPath CLI. Consulte Instalação do UiPath CLI.
• Tenha uma conta do UiPath Automation Cloud ou Automation Suite com acesso a pelo menos um tenant.
• Saiba o nome (ou caminho) de uma pasta no Orchestrator que contém pelo menos um processo. A pasta Shared funciona para a maioria das avaliações.

Abra um terminal. Todos os comandos abaixo são digitados lá.

Etapa 1. Entrar

Inicie o login interativo:

uip login

abre seu navegador uip , solicita que você faça logon no UiPath e, após você autenticar, pede que você escolha um tenant. Quando a guia do navegador relatar sucesso, retorne ao terminal — a sessão estará ativa. A sessão é mantida dentro de ~/.uipath/ (ou uma pasta .uipath/ local do projeto, se houver alguma na pasta atual ou em um ancestral).

Dica:

Se você já conhecer o tenant e quiser ignorar o seletor, uip login --tenant DefaultTenant. Se você estiver em um ambiente de CI, consulte Autenticação para os fluxos não interativos.

Etapa 2. Confirmar a sessão

uip login status --output table

Saída esperada:

Status         Organization   Tenant          Expiration Date
Logged in      my-org         DefaultTenant   2026-04-24T18:42:00Z

Observação:

Cada comando uip emite JSON por padrão. Passe --output table para a visualização amigável de leitura. Consulte Opções globais para os quatro formatos de saída (table, json, yaml, plain) e o sinalizador JmesPath --output-filter .

Se o comando relatar Not logged in, execute novamente uip login.

Etapa 3. Listar as pastas

Sua primeira consulta real chega ao Orchestrator:

uip or folders list

Isso retorna as primeiras 50 pastas no tenant. A saída inclui Key (GUID) de cada pasta, Name, Path e Type.

Para filtrar ou parecer mais profundo, transmita --all para desbloquear filtros:

uip or folders list --all --name Shared
uip or folders list --all --top-level

Observação:

--all é necessário antes que os sinalizadores de filtros (--name, --path, --type, --top-level, --sort-by) tenham qualquer efeito. Essa é uma rede de segurança deliberada — um erro de digitação em um filtro em um tenant grande retornaria silenciosamente a primeira página não filtrada.

Etapa 4. Encontre um processo para executar

Escolha uma pasta da Etapa 3 — Shared é usada aqui como exemplo — e liste seus processos:

uip or processes list --folder-path Shared

A saída mostra Key (GUID) de cada processo, Name, Version, e Type. Copie o Key de um processo que você deseja executar. Substitua <process-key> na próxima etapa por esse GUID.

Etapa 5. Iniciar um trabalho

uip or jobs start <process-key>

uip retorna imediatamente após o Orchestrator aceitar a solicitação. A resposta mostra o Key do novo trabalho, State (geralmente Pending no início) e o ProcessName resolvido.

Para bloquear até que o trabalho termine e veja sua saída, adicione --wait-for-completion:

uip or jobs start <process-key> --wait-for-completion --timeout 600

Com --wait-for-completion o comando faz pesquisas a cada cinco segundos (por padrão) e sai quando o trabalho atinge um estado terminal (Successful, Faulted, Stopped). O código de saída é diferente de zero em Faulted. --timeout é em segundos e o padrão é 300.

Passe os argumentos de entrada com --input-arguments (string JSON) ou --input-file (caminho para um arquivo JSON):

uip or jobs start <process-key> \
  --input-arguments '{"invoiceNumber":"INV-001","customer":"Contoso"}'

O que você acabou de fazer

Em cinco comandos, você autenticava, consultava dois recursos do Orchestrator e iniciava um trabalho. Cada comando uip segue a mesma forma — uip <tool> <resource> <verb> para ferramentas com vários recursos ou uip <tool> <verb> para ferramentas de fluxo de trabalho único — e cada um é compatível com os mesmos sinalizadores globais para formato de saída, filtragem e registro em log. Consulte Opções globais.

Próximas Etapas

• Seu primeiro pipeline — empacote uma solução localmente, publique-a em seu tenant e implante-a no Orchestrator.
• Autenticação — login interativo em detalhes, credenciais do cliente do aplicativo externo para CI e o fluxo da variável de ambiente para contêineres.
• Formatos de saída — alterne entre table, json, yaml e plain, e use a filtragem JmesPath com --output-filter.
• Referência de comando do Orchestrator — cada comando, cada sinalizador.
• Usando o UiPath CLI com Agentes de Codificação — deixe o Claude Code, o Cursor, o GitHub Copilot e outros agentes criarem automações UiPath com uip.