Visão geral de referência

Índice de referência para cada comando, sinalizador e código de saída do "uip", organizado por ferramenta e dividido em páginas vinculadas.

A referência documenta uip comando, sinalizador e código de saída. Use-a como uma pesquisa quando você souber o que deseja fazer e precisar da sintaxe exata. Para aprender, comece no Início rápido ou Como o UiPath CLI é organizado.

Como a referência é organizada

A referência é dividida em três tipos de página:

1. Cortes cruzados — comportamento que se aplica a cada invocação de uip independentemente da ferramenta.
2. Comandos principais — comandos que o host possui (login, logout, tools, skills, mcp, completion).
3. Por ferramenta — uma seção por ferramenta instalável; cada seção tem uma visão geral mais uma página por recurso (para ferramentas que iniciam primeiro o recurso) ou por verbo (para ferramentas de fluxo de trabalho único).

Correspondência

Página	O que ela cobre
Opções globais	--output, --output-filter, --log-level, --log-file — os quatro sinalizadores disponíveis em cada comando.
Códigos de saída	O contrato de código de saída de cinco níveis (0 / 1 / 2 / 3 / 4) mais 130 para cancelamento do usuário.

Comandos principais

Comandos os registros do host diretamente. Nenhuma instalação de ferramenta é necessária.

Command	Finalidade
Logon da UIP	Inicie uma sessão interativa do OAuth2, faça a autenticação como um aplicativo externo ou alterne os tenants.
logout da UIP	Remova as credenciais armazenadas.
Status de login do uip	Mostre a organização, o tenant e a expiração da sessão atual.
Ferramentas da UIP	Listar, pesquisar, instalar, atualizar ou desinstalar ferramentas instaláveis.
Habilidades da UIP	Instale as habilidades da UiPath em agentes de codificação (Claude Code, Cursor, GitHub Copilot, Codex, OpenCode, Autopilot, Robot, Killer, Air UiPath, Devin).
UIP MCP	Exponha comandos uip sobre o Protocolo de contexto do modelo para clientes com reconhecimento de MCP.
Conclusão de UIP	Instale, imprima ou remova a conclusão da guia do shell para bash, zsh, object e pwsh.
Configuração da UIP	Obtenha, defina ou limpe as preferências de configuração da CLI local (formato de saída, nível de log, política de versão/canal de atualização).
Usuário UIP	Exibe informações de identidade sobre a sessão atualmente conectada.
Atualização de UIP	Atualize as ferramentas e habilidades instaladas e verifique ou aplique uma versão mais recente da CLI.
Feedback da UIP	Envie um relatório de bug ou sugestão de melhoria para a equipe da UiPath.

Ferramentas

Cada ferramenta é um pacote npm instalável. Execute uip tools install <alias> para adicioná-lo ou invoque-o uma vez e deixe a instalação automática fazer o trabalho. Consulte Ferramentas ( plugins ) para o modelo e ferramentas uip para o comando que os gerencia.

Alias	Ferramenta	Referência
or	Orchestrator (trabalhos, processos, pastas, máquinas, usuários, licenças e recursos de runtime — ativos, buckets, filas, gatilhos, bibliotecas, webhooks)	UIP ou
platform	Plataforma (licenciamento de tenant, pacotes de usuários, regras de grupo, consumíveis)	Plataforma UIP
solution	Solução	Solução uip
agent	Agente	Agente de UIP
maestro	Maestro — one installable package with three project families (BPMN, Flow, Case), the authoring commands shared across them, and the connector-library registry; there is no bare uip maestro command	uip maestro bpmn, uip maestro flow, uip maestro case, Maestro authoring, uip maestro registry
tm	Test Manager	UIP TTM
rpa	RPA (empacotamento do Studio, analisador, restauração)	RPA UiPath
rpa-legacy	RPA Legacy — wrapper somente do Windows em torno de uipcli.exe (debug, validate, Find-activities, Find-package, Type-definition, Package)	uip rpa-legado
is	Integration Service	uiip é
codedagent	Agente codificado	Agente de código uip
codedapp	Aplicativo codificado	Aplicativo codificado uiip
api-workflow	Fluxo de trabalho da API	fluxo de trabalho da API do uip
vss	Soluções verticais	UIP vss
df	Data Fabric	Df da UIP
insights	Insights	Insights da UIP
traces	Traces	Traces da UIP
docsai	Docs AI	Documento da UIP
eval	Avaliação de runtime de pacotes do Orchestrator — avaliadores, conjuntos de avaliação, avaliações, agendamentos	Avaliação da UIP
admin	Administrador (usuários, grupos, contas de robô, aplicativos externos, SMTP, autorização, restrição de IP, organizações, tenants, gateways VPN, catálogo de recursos, auditoria)	Administrador da UIP
agenthub	AgentHub (registros de servidor MCP, ferramentas, agentes A2A remotos)	HubDoAgente da UIP
ah	Automation Hub (ideias, pipeline, taxonomia, usuários)	UIP ah
aops	StudioAdmin AOps (conexões, repositórios, projetos, soluções, pipelines, execuções)	UIP ao Ops
coder	Programador — agente de codificação de IA (apenas visualização de compilação)	codificador UIP
context-grounding	Contextualização (Bridge do Python)	Contextualização da uip
conversational	Conversacional (chat, agentes, histórico de conversas, truncamentos)	UIP de conversação
function	Funções — criar, servir e publicar funções JS/TS e Python	Função UIP
gov	Governança (políticas de AOps, políticas de acesso, pacotes de conformidade)	UiPath Government
guardrails	Proteções (configurações de proteção BYO, AI Trust Layer)	Proteções da UIP
ixp	IXP — Processamento inteligente de documentos (projetos, taxonomia, documentos, implantações)	Extração e Processamento Inteligente (IXP) da UIP
llm-configuration	Configuração do LLM — Conexões BYO LLM (AI Trust Layer)	configuração-llm-uip
llm-gateway	Gateway de LLM — listar modelos disponíveis	gateway-llm-uip
model-hub	Hub do modelo — Configuração de roteamento do gateway de LLM	hub de modelo da uip
pm	Process Mining (apps, transformações, ingestão de dados)	UiPath PM
rules	Business Rules (DMN projects — create, refresh, validate, debug, and read deployed rules)	Regras da UIP
tasks	Tarefas do Action Center (catálogos, comentários, rótulos, metadados, dados)	tarefas do UIP

Como ler uma página de comando

A página de referência de cada comando segue a mesma estrutura:

1. Resumo — a forma de comando de uma linha, mostrando argumentos posicionais e o conjunto de sinalizador comum.
2. Descrição — um parágrafo ou dois sobre o que o comando faz e onde ele se encaixa em um fluxo de trabalho.
3. Argumentos — tabela de argumentos posicionais: nome, necessário / opcional, finalidade.
4. Opções — tabela de sinalizadores agrupados por preocupações (identidade, filtragem, saída, comportamento). Cada linha mostra o nome abreviado, nome longo, tipo de valor, padrão e uma descrição de uma linha.
5. Exemplos — três ou mais exemplos funcionados: mínimo, caso comum, compatível com script (com --output-filter ou tratamento JSON explícito).
6. Códigos de saída — um ponteiro para códigos de saída mais quaisquer substituições específicas do comando.
7. Comandos relacionados — comandos usados frequentemente com este.
8. Consulte também — páginas de conceito e instruções que cobrem o contexto do comando.

Todas as páginas herdam as opções globais; eles não são repetidos em todos os comandos.

Convenções

• Prefixo do comando. uip é o executável; todo exemplo começa com ele.
• Espaços reservados. <angle-brackets> para valores obrigatórios, [square-brackets] para valores opcionais. Substitua por seus valores reais.
• Sinalizadores curtos. Onde um sinalizador tem um formato curto (por exemplo, -t para --tenant), ambos são listados juntos na tabela de opções; os exemplos usam o formato longo para legibilidade.
• Amostras JSON. --output json o padrão. Exemplos que mostram campos irrelevantes com … para manter o foco.
• Notas da versão. Comandos ou sinalizadores rotulados como Pré-visualização podem mudar sem um aumento da versão MAJOR. Comandos rotulados como obsoletos continuam funcionando por pelo menos um ciclo MAJOR. Consulte Controle de versão e estabilidade.