uip (comandos principais)

Comandos principais no UiPath CLI que não exigem a instalação de ferramentas, cobrindo autenticação, ciclo de vida da ferramenta, habilidades, ponte MCP e conclusão de shell.

A superfície de comando principal é tudo o que o host (@uipath/cli) envia — sem necessidade de instalação de ferramenta. Esses comandos gerenciam autenticação, ciclo de vida da ferramenta, habilidades de agente de codificação de IA, a ponte MCP e a conclusão de shell. Cada comando nesta página estará disponível no momento em que npm install -g @uipath/cli finaliza.

Para comandos que se comunicam com uma superfície da UiPath (Orchestrator, Solutions, Agents etc.), consulte as páginas de referência por ferramenta — cada uma é fornecida por um pacote npm separado que o host carrega sob demanda.

Os comandos do host

O host da CLI registra 11 comandos de nível superior (uip track é telemetria interna oculta e não é voltado para o usuário — os outros 10 são):

Command	Finalidade	Logon Obrigatório
uip login	Autenticar por meio de OAuth2 interativo, aplicativo externo, variáveis de ambiente ou federação/carga de trabalho-identity; alternar tenants. Grava uma sessão em .uipath/.auth.	—
uip logout	Remova o arquivo de credenciais.	—
uip login status	Mostre a organização atual, o tenant, a expiração e qual arquivo de credenciais a CLI está lendo.	Opcional (relata Not logged in caso contrário)
uip config	Obtenha, defina e limpe os valores de configuração da CLI local (incluindo as leituras de pinos de uip tools update versão).	—
uip user	Exiba a identidade do usuário autenticado no momento.	Sim
uip feedback	Enviar feedback sobre a CLI.	—
uip tools	Liste, pesquise, instale, atualize e desinstale as ferramentas instaláveis (Orchestrator, Solution, Agent, Test Manager,…).	—
uip skills	Instale habilidades da UiPath em agentes de codificação de IA.	—
uip mcp	Exponha a CLI como um servidor de Protocolo de Contexto do Modelo sobre o Studio.	Por run_command (herda a sessão baseada em arquivo).
uip update	Atualize automaticamente a CLI, suas ferramentas instaladas e habilidades instaladas.	—
uip completion	Instale ou imprima a conclusão da guia do shell (bash, zsh, object, pwsh).	—

Resumo

uip login [--tenant <name>] [--organization <name>] [--authority <url>] [--client-id <id>] [--client-secret <secret> | --client-assertion <jwt>] [--scope <scopes>] [--no-browser] [-f <folder>]
uip login status                       [-f <folder>]
uip login refresh                      [--login-validity <minutes>]
uip login which                        [-f <folder>]
uip login tenant list                  [-f <folder>]
uip login tenant set <name>            [-f <folder>]
uip logout                             [-f <folder>]
uip config get / set / clear <key>
uip user
uip feedback send
uip tools list / search / install / update / uninstall …
uip skills list / search / show / install / update / uninstall --agent <name>
uip mcp serve
uip update [--dry-run] [--tools-only] [--skills-only]
uip completion [shell] [--print] [--uninstall]

Cada comando também honra o sinalizador --interactive/--no-interactive global (consulte Opções globais) — não há um formato abreviado específico de comando para ele.

Todos os comandos principais respeitam as opções globais (--output, --output-filter, --log-level, --log-file, --profile, --interactive/--no-interactive) e seguem o contrato de código de saída padrão.

Como a superfície principal se relaciona com ferramentas

Todas as outras invocações uip <tool> … são executadas em cima desses:

1. A autenticação é estabelecida uma vez com uip login e herdada por cada chamada de ferramenta subsequente (Orchestrator, Solução, Agente,…).
2. O ciclo de vida da ferramenta (uip tools install) controla quais pacotes de extensão serão carregados na próxima vez que você invocar um prefixo de ferramenta.
3. As habilidades ficam ao lado de ferramentas — elas ensinam os agentes de IA a usar uip em vez de adicionar novos comandos.
4. O MCP encapsula toda a superfície (núcleo + ferramentas instaladas) como uma única ferramenta MCP que qualquer cliente sensível a MCP pode chamar.
5. A conclusão encontra comandos no momento da instalação; portanto, execute novamente uip completion após uip tools install se desejar a conclusão para comandos recém-adicionados.

Veja Como o UiPath CLI é organizado para a arquitetura host-vs-ferramenta em mais profundidade.

Formato de autenticação

Cada comando principal, exceto os próprios comandos de autenticação, funciona sem uma sessão — eles apenas se comunicam com arquivos locais (configuração, manifesto, script de conclusão). Os comandos auth gerenciam a própria sessão:

• — OAuth2 uip login (navegador), aplicativo externo (credenciais do cliente), token de variável de ambiente e identidade federada/carga de trabalho (--client-assertion). Consulte Autenticação. --profile delimita a sessão a um conjunto de credenciais nomeadas, ortogonal a qual fluxo você usa.
• uip logout remove o arquivo. O fluxo env-var não tem nada para limpar.
• uip login status relata a sessão ativa.
• — atualiza uip login refresh o token de acesso e emite uma carga de sessão legível por máquina para consumidores programáticos.
• uip login which imprime de onde a sessão ativa/arquivo de credenciais foi resolvido.
• uip login tenant list / set Alterne tenants sem autenticar novamente.

Os comandos de ferramenta herdam qualquer sessão que esteja no disco no momento da invocação; --tenant substituições por chamada.

Para onde cada comando envia sua saída

Stream	Content
Saída std	O envelope JSON estruturado (Result, Code, Data, …). Um por invocação.
stderr	Logs (controlados --log-level), indicadores de progresso e texto de erro legível por humanos. Nunca JSON analisável por máquina.

A divisão é imposta em todos os lugares; você pode redirecioná-los de forma independente:

uip tools list > tools.json 2> uip.log

Consulte Formatos de saída para os cinco formatos (json, table, yaml, plain, markdown) e a filtragem JmesPath.

Veja também

• Conceitos: como o UiPath CLI é organizado — o que "host" significa e por que o núcleo é dividido das ferramentas.
• Conceitos: ferramentas ( Não
• Conceitos: habilidades — como o uip skills install estende os agentes de IA.
• Conceitos: sessões e credenciais — o que uip login grava e onde.
• Autenticação — a autenticação fluxos em detalhes, incluindo login federado/carga de trabalho-identity.
• Opções globais, códigos de saída — contratos compartilhados por todos os comandos.