Sobre o UiPath CLI

Arquitetura e recursos do UiPath CLI, a interface de linha de comando multiplataforma para criar e operar automações da UiPath.

Observação:

O UiPath CLI atingiu a disponibilidade geral na versão 1.197.0 (31 de julho de 2026). Todos as versões anteriores à 1.197.0 eram versões de visualização e podiam incluir alterações significativas entre versões.

A Interface de Linha de Comando da UiPath (UiPath CLI, invocada como uip) é a ferramenta de linha de comando multiplataforma para a UiPath Platform. Ele permite que desenvolvedores, engenheiros de RPA e equipes DevOps criem, gerenciem, operem e implantem automações UiPath — trabalhos e recursos do Orchestrator, Soluções, Agentes, Fluxos, processos do Maestro, ativos do Test Manager e muito mais — a partir de um terminal ou um CI/CD pipeline.

A UiPath CLI é distribuída no npm e segue o versionamento semântico (MAJOR.MINOR.PATCH). Isso substitui o esquema baseado em calendário usado até 2025.10 e o.NET CLI legado (uipcli.exe).

Observação:

Esta é a documentação para o UiPath CLI (o comando baseado em uip ). Para o .NET CLI legado (uipcli.exe / dotnet uipcli.dll), consulte as integrações de CI/CD 2025.10 docs. Um guia de migração está disponível.

Para a extensão do Azure DevOps, plug-in do Jenkins e outras integrações de pipeline, consulte Integrações de CI/CD.

Mais que uma ferramenta de CI/CD

Ferramentas de linha de comando anteriores da UiPath focadas em tarefas de CI/CD — empacotar, analisar, implantar, executar testes. O UiPath CLI 1.x mantém tudo isso e adiciona a superfície completa da plataforma. Você pode usar uip para:

• Criar — projetos de Scaffold (uip solution init, uip agent init, uip maestro flow init, uip maestro init), empacotar (uip rpa pack, uip solution pack, uip agent pack) e analisar (uip rpa analyze com políticas de governança).
• Gerenciar — trabalhe com pastas, usuários, funções e licenças do Orchestrator; criar e atualizar ativos, filas, buckets de armazenamento, bibliotecas, gatilhos e webhooks; administrar projetos, conjuntos de testes e resultados do Test Manager; gerenciar conectores e conexões do Integration Service.
• Operar — inicie, interrompa e inspecione trabalhos do Orchestrator; monitorar instâncias e incidentes do Flow e do Maestro; executar Agentes e avaliá-los em relação a conjuntos de dados; executar conjuntos de testes e ler resultados.
• Implantar — carregue pacotes, crie e atualize processos, publique Soluções e Agentes, ative ou desinstale implantações de Soluções.

Essa é a mesma ferramenta, seja você um desenvolvedor explorando a plataforma de um laptop ou um pipeline fazendo implantações unattended. Os verbos, sinalizadores, formatos de saída e códigos de saída são os mesmos em ambos os contextos.

Projetado para humanos e agentes de codificação

O UiPath CLI foi projetado para ser consumido igualmente bem por dois públicos:

• Humanos — uma experiência de primeiro terminal com uip login interativo, conclusão de guia do shell (uip completion), visualização detalhada --output table e ajuda incorporada em cada comando (uip <cmd> --help).
• Coding agents — the uip skills system installs UiPath skills into coding agents so they know how to build, deploy, and operate UiPath automations with uip — not just which commands exist. Supported agents: Claude Code, Cursor, GitHub Copilot, Codex, OpenCode, UiPath Autopilot, Kiro (Amazon Q), Windsurf, Antigravity CLI, and Devin.

uip skills install o catálogo de habilidades UiPath completo do GitHub e o instala em um ou mais agentes de codificação. Você escolhe os agentes de destino (não habilidades individuais — o próprio agente decide qual habilidade se aplica a uma determinada tarefa) passando --agent <name> ou interativamente a partir de uma solicitação de caixa de seleção quando a sinalização é omitida. Por padrão, a instalação é global; adicione --local para escopo habilidades ao projeto atual (onde o agente é compatível — o Claude Code é somente global, por exemplo).

uip skills install                         # prompts you to pick one or more agents
uip skills install --agent claude          # non-interactive, skills installed globally for Claude Code
uip skills install --agent cursor --local  # non-interactive, skills installed into the current project for Cursor
uip skills update --agent claude           # re-fetch and reinstall to pick up new skills
uip skills uninstall --agent claude        # remove skills for Claude Code

Os mesmos comandos funcionam de qualquer maneira. Uma invocação de uip que um desenvolvedor digita manualmente é exatamente a mesma chamada que um agente faz — o que significa que sua equipe pode criar uma automação interativamente, canalizar a sequência exata em um script e entregá-la a um agente de IA para iterar ainda mais.

A saída é JSON por padrão — o mesmo em um laptop de desenvolvedor e em um pipeline, para que os scripts não precisem se ramificar dependendo de se estarem sendo executados interativamente. Adicione --output table para a visualização amigável de leitura, --output yaml para YAML ou --output plain para linhas key=value . A filtragem do JmesPath está disponível via --output-filter "Data[*].Name".

Como o UiPath CLI é organizado

uip é um pequeno host com um sistema de plug-in. O host lida com a autenticação, gerenciamento de sessão, configuração e ciclo de vida da ferramenta. Todo o resto — Orchestrator, Solution, Agent, Flow, Maestro, RPA, Test Manager e assim por diante — é enviado como uma ferramenta instalável no npm.

uip <tool> <resource-or-command> [subcommand] [options]

Exemplos:

uip login                                # core command
uip or jobs list                         # orchestrator jobs (manage + operate)
uip solution pack ./MySolution ./dist    # solution packing (build)
uip rpa analyze ./MyProject              # workflow analyzer (build)
uip agent deploy my-agent                # agent deploy (deploy)

Um novo npm install -g @uipath/cli contém apenas os comandos host e principal — nenhuma ferramenta é pré-instalada. A primeira vez que você invocar um comando cujo prefixo corresponde a uma ferramenta na lista de permissões, o host instalará essa ferramenta a partir do npm automaticamente. Você também pode instalar ferramentas explicitamente com uip tools install <name> — útil para preparação offline e executores de CI. Consulte Ferramentas ( plugins ) para obter detalhes.

Ferramentas integradas

The tools below are the core platform-automation surfaces, each on the auto-install whitelist — typing the prefix is enough. Prefixes shown are the canonical names as defined in the host. This is a representative subset, not the full roster: UiPath CLI ships 30+ whitelisted tools in total, covering everything from Orchestrator to governance, LLM configuration, and process mining. See Tools (plugins) for the complete, exact table (kept in sync with the host's whitelist), or the Command reference for every tool's alias and reference page.

Ferramenta	Prefix	Finalidade
Orchestrator	or	Jobs, folders, processes, packages, machines, users, roles, licenses, feeds, assets, queues, storage buckets, libraries, triggers, webhooks
Solução	solution	Estruturar, empacotar, publicar, carregar e implantar Soluções da UiPath
RPA	rpa	Empacotamento de projetos do Studio, analisador de fluxo de trabalho, restauração de dependências
RPA Legacy	rpa-legacy	Windows-only wrapper around uipcli.exe for Studio commands not yet ported to the cross-platform rpa tool
Agente	agent	Criação, empacotamento, implantação e execução de agentes low-code
Agente codificado	codedagent	Agentes codificados baseados em Python
Aplicativo codificado	codedapp	Projetos de aplicativo da Web codificados
Maestro	maestro	BPMN process authoring/packaging/runtime, plus the flow and case branches (see note below)
Test Manager	tm	Casos de teste, conjuntos de teste, execuções, resultados, relatórios
Integration Service	is	Conectores e conexões
Soluções verticais	vss	Estruturação e geração de soluções verticais
Fluxo de trabalho da API	api-workflow	Execução local de fluxos de trabalho da UiPath API
Data Fabric	df	Operações do Data Fabric
Insights	insights	Painéis e relatórios do Insights
Traces	traces	Rastreamentos e diagnóstico de execução
Docs AI	docsai	Pesquisa de documentação da UiPath com IA
Eval	eval	Runtime evaluation of deployed packages against an Orchestrator process — a standalone package, not a sub-command of or

Dica:

Run uip --help to see the exact prefixes in your installation, and uip tools list to see which tools are currently installed. Only the allowlisted @uipath/ tools above are supported in UiPath CLI 1.x; third-party extension is not available yet. Maestro Flow and Case are not separately whitelisted tools. @uipath/maestro-tool is the only package on the whitelist for maestro; it directly imports @uipath/flow-tool and @uipath/case-tool as its own dependencies to register the uip maestro flow and uip maestro case branches. Installing maestro-tool pulls both in — there's no separate auto-install trigger for flow or case on their own.

Autenticação em um piscar de olhos

UiPath CLI supports five authentication flows. The interactive flow is new in 1.x; External App and environment-variable auth have analogs in the legacy .NET CLI; federated credentials is for workload-identity setups that can't hold a long-lived secret; Robot credentials is for Studio Desktop and other Robot-hosted contexts.

Fluxo	quando usar	Como usá-lo
Login do usuário do OAuth2 interativo (novo em 1.x)	Desenvolvedores trabalhando em um terminal. Vincula a sessão à sua conta pessoal e suas permissões.	uip login abre um navegador para login e seleciona um tenant. Os tokens de sessão são armazenados e atualizados automaticamente.
Aplicativo externo (credenciais do cliente)	pipelines de CI/CD, servidores, qualquer contexto não interativo. Vincula a sessão a um aplicativo externo que você cria no UiPath, com escopos explícitos.	uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant <name> — o prefixo env.VAR lê o segredo de uma variável de ambiente sem expô-lo na linha de comando.
Federated credentials (workload identity)	CI/CD platforms that can issue their own OIDC tokens (for example, a GitHub Actions or Azure DevOps workload-identity setup) — no long-lived client secret to store or rotate.	uip login --client-id <app-id> --client-assertion env.OIDC_TOKEN — an OIDC JWT stands in for the client secret. Requires --client-id; mutually exclusive with --client-secret.
Autenticação da variável de ambiente	Contêineres e executores efêmeros que já possuem um token de acesso da UiPath. Sem navegador, sem viagem de ida e volta do aplicativo externo, sem estado no disco.	Defina UIPATH_CLI_ENABLE_ENV_AUTH=true e forneça UIPATH_CLI_AUTH_TOKEN + variáveis de organização/tenant. Cada comando uip autentica a partir das variáveis de ambiente; não há atualização.
Robot credentials	Studio Desktop and other UiPath Robot-hosted contexts, authenticating through the Robot already running on the machine.	Set UIPATH_CLI_ENFORCE_ROBOT_AUTH=true. Authenticates exclusively through the local Robot's IPC channel; mutually exclusive with environment-variable auth.

The first three flows all persist a session to a credentials folder. --profile <name> (a global flag — see Global options) names a session so multiple logins can coexist side by side, independent of which flow created them; pass the same --profile on later commands to reuse that specific session.

Consulte Autenticação para obter o fluxo completo, seleção de tenant, layout de pasta de credenciais e como pré-configurar Apps externos para CI.

UiPath CLI versus o .NET CLI legado

Aspecto	UiPath CLI (uip, 1.x)	Legado.NET CLI (uipcli, 2025.10 e anterior)
Runtime	Node.js (multiplataforma)	.NET 8 (Windows-primeiro)
Distribuição	npm install -g @uipath/cli	.nupkg no feed MyGet/NuGet
Controle de versão	Controle de versão semântico (1.0.0, 1.1.0, …)	Controle de versão do calendário (2023.10, 2024.10, 2025.10)
Escopo	Crie, gerencie, opere e implante em toda a plataforma	Foco em CI/CD — empacotar, analisar, implantar, executar testes
Autenticação	OAuth2 interativo (uip login) e Aplicativo externo (credenciais do cliente)	Aplicativo externo (credenciais do cliente), além de autenticação básica/token obsoleta
Arquitetura	Ferramentas modulares, instaladas automaticamente no primeiro uso do npm	Executável monitorado
Formatos de saída	table, json, yaml, plain com filtragem JmesPath	Texto / JSON (limitado)
Integração de IA	Sistema de habilidades para agentes de codificação	Não disponível
Analisador de Fluxo de Trabalho	Preservado como uip rpa analyze, com suporte para política de arquivo de governança	Pacote com CLI (uipcli package analyze)
Restauração da dependência	Preservado como uip rpa restore, com suporte isolado e NuGet-config	Pacote com CLI (uipcli package restore)

Se você estiver iniciando um novo pipeline hoje, use o UiPath CLI 1.x. Se você estiver mantendo pipelines existentes do Azure DevOps ou Jenkins criados em uipcli.exe, consulte o guia de migração para o mapa de comando, renomeações de sinalizadores e alterações significativas.

UiPath CLI versus os plug-ins de CI/CD

A UiPath CLI (uip) é a ferramenta. A extensão DevOps do Azure, o plug-in do Jenkins e integrações de pipeline semelhantes são wrapper dessa ferramenta — eles empacotam invocações uip por trás de formulários de tarefas orientados por interface gráfica, injeção de variável segura e registro nativo do pipeline. No futuro, as versões mais recentes desses plug-ins chamarão uip internamente.

Use o plug-in quando desejar a interface do usuário do pipeline e o gerenciamento de variáveis. Use uip diretamente (por meio de uma etapa bash ou pwsh ) quando você quiser os recursos de CLI mais recentes sem esperar uma versão de plug-in ou quando você precisar de um comando que o plug-in não expõe.

Consulte Integrações de CI/CD para a documentação do plug-in.

Plataformas compatíveis

UiPath CLI 1.x runs on any platform that supports Node.js 22 or later:

• Windows (x64, ARM64)
• macOS (x64, ARM64)
• Linux (x64, ARM64)

Estabilidade e cadência de lançamento

A UiPath CLI segue o versionamento semântico:

• MAJOR — alterações interruptivas nos nomes de comandos, semântica de sinalizadores ou no envelope JSON. Um ciclo de descontinuação precede qualquer versão MAJOR.
• MINOR — novos comandos, novos sinalizadores, novas ferramentas; apenas cumulativa. Observe que a forma de Data na saída JSON é específica do comando e pode mudar em versões MINOR; os pipelines devem fixar @uipath/cli.
• PATCH — correções de bugs; nenhuma alteração de comportamento documentada.

Comandos e ferramentas individuais são rotulados GA, Preview ou Obsoleto. Os comandos de Visualização podem mudar sem um aumento de versão importante; os comandos obsoletos continuam funcionando por pelo menos um ciclo MAJOR. Consulte Controle de versão e estabilidade para o contrato completo.

Próximas Etapas

• Instale o UiPath CLI — configure uip no Windows, macOS ou Linux.
• Início rápido — faça login, liste pastas do Orchestrator e execute um trabalho em cinco minutos.
• Seu primeiro pipeline — empacotar um projeto e implantá-lo a partir de um pipeline de CI.
• Using UiPath CLI with Coding Agents — install skills into Claude Code, Cursor, GitHub Copilot, or any other supported agent and let them build UiPath automations with uip.
• Referência de comando — referência completa para cada comando.
• Migração do.NET CLI legado — se você estiver vindo de uipcli.exe.