uip (comandos principais)

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 sete comandos

Command	Finalidade	Logon Obrigatório
uip login	Autenticar por meio de OAuth2 interativo ou aplicativo externo; 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 tools	Liste, pesquise, instale, atualize e desinstale as ferramentas instaláveis (Orchestrator, Solução, Agente, Fluxo…).	—
uip skills	Instale habilidades da UiPath em agentes de codificação de IA (Claude Code, Cursor, GitHub Copilot, Gemini CLI, Codex, OpenCode).	—
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 completion	Instale ou imprima a conclusão da guia do shell (bash, zsh, object, pwsh).	—

Resumo

uip login [--interactive] [--tenant <name>] [--organization <name>] [--client-id <id>] [--client-secret <secret>] [--scope <scopes>] [-f <folder>]
uip login status                       [-f <folder>]
uip login tenant list                  [-f <folder>]
uip login tenant set <name>            [-f <folder>]
uip logout                             [-f <folder>]
uip tools list / search / install / update / uninstall …
uip skills install / update / uninstall --agent <claude|cursor|copilot|gemini|codex|opencode>
uip mcp serve
uip completion [shell] [--print] [--uninstall]

Todos os comandos principais respeitam as quatro opções globais (--output, --output-filter, --log-level, --log-file) 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:

• uip login três fluxos: OAuth2 interativo (navegador), aplicativo externo (credenciais do cliente) e token de variável de ambiente. Consulte Autenticação.
• uip logout remove o arquivo. O fluxo env-var não tem nada para limpar.
• uip login status relata a sessão ativa.
• 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 quatro formatos (json, table, yaml, plain) 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 — os três fluxos de autenticação em detalhe.
• Opções globais, códigos de saída — contratos compartilhados por todos os comandos.