Como o UiPath CLI é organizado

Visão geral arquitetônica do UiPath CLI, incluindo o host, ferramentas instaláveis, serviços cruzados e contrato de estabilidade.

A UiPath CLI é construída a partir de um pequeno host, mais um conjunto de ferramentas e alguns serviços cruzadas. Entender como as partes se encaixam torna as escolhas de design — formato de saída padrão, instalação automática, resolução da sessão, contrato de estabilidade — mais fáceis de raciocinar. Esta página é um mapa de parágrafo único de cada camada, com links para a página mais profunda.

O host

O host é o pacote npm @uipath/cli , invocado por meio do comando uip que coloca npm install -g em seu PATH. É um programa de linha de comando fino que possui:

• Análise de Argv e opções globais, incluindo o contrato de quatro sinalizadores: --output, --output-filter, --log-level, --log-file. As opções globais são removidas do argv antes que o subcomando de qualquer ferramenta veja os argumentos, para que as ferramentas não possam sombreá-las acidentalmente.
• Autenticação e gerenciamento de sessão por meio de quatro fluxos (OAuth2 interativo, aplicativo externo, credenciais federadas, env-var), além de uma camada ortogonal --profile para nomear várias sessões lado a lado. Consulte Sessões e credenciais.
• Configuração por meio de variáveis de ambiente e sinalizadores por comando. Consulte Configuração.
• Ciclo de vida da ferramenta por meio de uip tools install / update / uninstall / list / search. Consulte Ferramentas ( plugins ).
• Ciclo de vida de habilidades por meio de uip skills install / update / uninstall. Ortogonal às ferramentas. Consulte Habilidades.
• Conclusão de shell por meio de uip completion (bash, zsh, object, pwsh).
• A ponte de protocolo de contexto do modelo por meio de uip mcp, para clientes com reconhecimento de MCP.
• Registro em log, telemetria, formatação de saída e o envelope JSON — os serviços de runtime que cada comando usa para produzir uma saída consistente.

O host é publicado como @uipath/cli no npm. Sua cadência de lançamento é independente das ferramentas.

Ferramentas

Cada superfície da UiPath — Orchestrator, Soluções, Agentes, Fluxos, Maestro, RPA, Test Manager, Integration Service, Data Fabric, Insights, Traces, DocsAI, Fluxo de trabalho de API, Soluções verticais, Agentes codificados, Coded Apps — é um pacote npm separado sob o Escopo @uipath/ . O host mantém uma lista de permissões de instalação automática desses pacotes e os instala no primeiro uso. As ferramentas são carregadas lentamente; uma nova instalação tem zero ferramentas no disco.

As versões de ferramentas rastreiam a linha MAJOR.MINOR do host por padrão, portanto, atualizar a CLI e executar uip tools update traz toda a cadeia de ferramentas para a etapa.

Consulte Ferramentas ( plugins ) para obter o modelo completo e referência às ferramentas uip para o comando. O comportamento da instalação automática sem opção é abordado na instalação do UiPath CLI em "Controle da instalação automática da ferramenta".

Habilidades

As habilidades são um mecanismo de extensão paralela destinado a agentes de codificação de IA, não à superfície de comando. uip skills install --agent <name> escreve um catálogo de instruções específicas da UiPath em um dos dez agentes compatíveis: Claude Code, Cursor, GitHub Copilot, Codex, OpenCode, UiPath Autopilot, Especifica ele (Amazon Q), Air UiPath, Air UiPath CLI ou Devin. O agente lê essas instruções para saber como usar uip para tarefas comuns da UiPath — empacotar uma solução, implantar um agente, executar um conjunto de testes e assim por diante.

Habilidades e ferramentas são independentes. Ferramentas adicionar comandos; habilidades ensinam aos agentes como usar os comandos. A instalação de ferramentas não instala habilidades e vice-versa. Consulte Habilidades.

Sessões e credenciais

uip login estabelece uma sessão — uma organização, um tenant e um par de tokens de acesso/atualização — e a persiste dentro de uma pasta .uipath/ . A CLI resolve a pasta percorrendo o diretório atual, recai para ~/.uipath/ se nenhuma pasta local do projeto for encontrada. Os tokens são atualizados silenciosamente até que o próprio token de atualização expire ou seja revogado.

Um fluxo de autenticação ignora totalmente o estado no disco: com UIPATH_CLI_ENABLE_ENV_AUTH=true, a CLI lê token + tenant + organização de variáveis de ambiente em cada invocação, que é o ajuste certo para contêineres e executores efêmeros. Consulte Sessões e credenciais e Autenticação.

Códigos de saída e saída

Cada comando emite um único envelope estruturado no stdout. Cinco formatos — json (padrão), table, yaml, plain, markdown — renderizam o mesmo envelope de forma diferente. O campo Result do envelope mapeia um a um para um conjunto restrito de códigos de saída (0 / 1 / 2 / 3 / 4 + 130 para o usuário cancelar) que os scripts podem ramificar sem analisar strings.

stdout está reservado para o envelope. Os logs, indicadores de progresso e texto de erro legível por humanos sempre vão para stderr, para que os pipelines possam redirecionar os dois fluxos de forma independente.

Consulte Formatos de saída, Códigos de saída e Padrões de script.

Registro em log e telemetria

Os logs são linhas JSON estruturadas. Eles vão para o stderr por padrão e, com --log-file <path>, são duplicados em um arquivo para os remetentes de log coletarem. --log-level controla a verbosidade (debug / info / warn / error).

A telemetria são dados de uso anônimos enviados ao Application Insights da UiPath. Ele pode ser desabilitado com UIPATH_TELEMETRY_DISABLED=1 ou redirecionado com UIPATH_AI_CONNECTION_STRING. Nenhum argumento de comando, conteúdo de arquivo ou credencial é transmitido.

Consulte Configuração e a seção Telemetria da instalação do UiPath CLI.

A superfície de comando completa

uip <core-command> …                  # login, logout, tools, skills, mcp, completion
uip <tool-alias> <verb> [options]     # single-workflow tools (solution, agent, flow, maestro, rpa, codedagent, codedapp, api-workflow, vss)
uip <tool-alias> <resource> <verb>    # resource-first tools (or, tm)
uip <tool-alias> [options]            # flat wrappers (df, insights, traces, docsai, is)

Três formas, uma gramática. A página de referência de cada ferramenta documenta os verbos e sinalizadores exatos; toda ferramenta herda as mesmas opções globais e envelope.

Como um comando é executado

A sequência para uma invocação uip or folders list , em um nível alto:

1. Analisa opções globais. O host remove --output, --output-filter, --log-level, --log-file do argv e configura o runtime.
2. Resolva a ferramenta. or corresponde à lista de permissões. Se @uipath/orchestrator-tool ainda não estiver instalado, a instalação automática será executada. Caso contrário, a ferramenta é carregada dinamicamente.
3. A ferramenta registra subcomandos. O host aprende sobre uip or folders list e outros subcomandos do Orchestrator.
4. Resolvido autenticação. A ferramenta solicita a sessão ao host. O host coleta-o de uma pasta .uipath/ (direct aplicativo), da autenticação env-var ou falha rapidamente com o código de saída 2 se nada estiver disponível.
5. Resolvido configuração. As variáveis de ambiente e os sinalizadores são reconciliados de acordo com a cadeia de precedência.
6. Executar o verbo. A ferramenta chama o Orchestrator com a sessão e a configuração resolvidas e, em seguida, emite o envelope por meio do formatação do host.
7. Sair. O host traduz o Result do envelope em um código de saída do processo.

Nada nessa sequência é específico do Orchestrator. uip <tool> … chamada segue o mesmo formato, que é o que torna os scripts portáteis entre ferramentas.

Veja também

• Ferramentas ( plugins ) — o modelo de plugin em profundidade.
• Habilidades — o mecanismo de extensão paralela para agentes de IA.
• Sessões e credenciais — onde a pasta de credenciais reside e como ela é resolvida.
• Configuração — arquivos, variáveis de ambiente e precedência.
• Formatos de saída, Códigos de saída, Opções globais — o contrato de runtime.