Cómo está organizada la UiPath CLI

Descripción general de la arquitectura de UiPath CLI, incluido el host, las herramientas instalables, los servicios transversales y el contrato de estabilidad.

UiPath CLI se ensambla a partir de un pequeño host más un conjunto de herramientas y algunos servicios transversales. Comprender cómo encajan las piezas hace que las opciones de diseño (formato de salida predeterminado, instalación automática, resolución de sesión, contrato de estabilidad) sean más fáciles de razonar. Esta página es un mapa de un solo párrafo de cada capa, con enlaces a la página que profundiza.

El host

El host es el paquete @uipath/cli npm, invocado a través del comando uip que npm install -g coloca en tu PATH. Es un programa delgado de línea de comandos que posee:

• Opciones globales y de análisis de Argv, incluido el contrato de cuatro banderas: --output, --output-filter, --log-level, --log-file. Las opciones globales se eliminan de argv antes de que cualquier subcomando de la herramienta vea los argumentos, por lo que las herramientas no pueden ensombrecerlos accidentalmente.
• Authentication and session management through four flows (interactive OAuth2, External App, federated credentials, env-var), plus an orthogonal --profile layer for naming multiple side-by-side sessions. See Sessions and credentials.
• Configuración a través de variables de entorno y marcadores por comando. Consulta Configuración.
• Ciclo de vida de la herramienta a través de uip tools install / update / uninstall / list / search. Consulta Herramientas (complementos).
• Ciclo de vida de habilidades a través de uip skills install / update / uninstall. Ortogonal a las herramientas. Consulta Habilidades.
• Finalización del shell a través de uip completion (bash, zsh, fish, pwsh).
• El puente del protocolo de contexto del modelo a través de uip mcp, para clientes compatibles con MCP.
• Registro, telemetría, formato de salida y el sobre JSON : los servicios de runtime que cada comando utiliza para producir una salida coherente.

El host se publica como @uipath/cli en npm. Su cadencia de lanzamiento es independiente de las herramientas.

Herramientas

Cada superficie de UiPath (Orchestrator, Soluciones, Agentes, Flujos, Maestro, RPA, Test Manager, Integration Service, Data Fabric, Insights, Traces, DocsAI, Flujo de trabajo de API, Soluciones verticales, Coded Agents, Coded Apps) es un paquete npm independiente bajo la @uipath/ ámbito. El host mantiene una lista blanca de instalación automática de estos paquetes y los instala en el primer uso. Las herramientas se cargan de forma diferida; una instalación nueva no tiene herramientas en el disco.

Las versiones de la herramienta realizan un seguimiento de la línea MAYOR.MENOR del host de forma predeterminada, por lo que actualizar la CLI y ejecutar uip tools update pone en marcha toda la cadena de herramientas.

Consulta Herramientas (complementos) para obtener el modelo completo y la referencia de herramientas de UIP para el comando. El comportamiento de autoinstalación sin opción de exclusión se trata en Instalar UiPath CLI en "Controlar la autoinstalación de la herramienta".

Aptitudes

Skills are a parallel extension mechanism aimed at AI coding agents, not at the command surface. uip skills install --agent <name> writes a catalog of UiPath-specific instructions into one of ten supported agents: Claude Code, Cursor, GitHub Copilot, Codex, OpenCode, UiPath Autopilot, Kiro (Amazon Q), Windsurf, Antigravity CLI, or Devin. The agent reads those instructions to know how to use uip for common UiPath tasks — pack a solution, deploy an agent, run a test set, and so on.

Las habilidades y las herramientas son independientes. Las herramientas añaden comandos; las habilidades enseñan a los agentes a utilizar los comandos. La instalación de herramientas no instala habilidades y viceversa. Consulta Habilidades.

Sesiones y credenciales

uip login establece una sesión (una organización, un tenant y un par de tokens de acceso/actualización) y la mantiene dentro de una carpeta .uipath/ . La CLI resuelve la carpeta subiendo desde el directorio actual, retrocediendo a ~/.uipath/ si no se encuentra ninguna carpeta local del proyecto. Los tokens se actualizan de forma silenciosa hasta que el propio token de actualización caduca o se revoca.

One auth flow bypasses on-disk state entirely: with UIPATH_CLI_ENABLE_ENV_AUTH=true, the CLI reads token + tenant + organization from environment variables on every invocation, which is the right fit for containers and ephemeral runners. See Sessions and credentials and Authentication.

Códigos de salida y salida

Every command emits a single structured envelope on stdout. Five formats — json (default), table, yaml, plain, markdown — render the same envelope differently. The envelope's Result field maps one-to-one to a narrow set of exit codes (0 / 1 / 2 / 3 / 4 + 130 for user cancel) that scripts can branch on without parsing strings.

La salida estándar está reservada para el sobre. Los registros, los indicadores de progreso y el texto de error legible por humanos siempre van a stderr, por lo que los procesos pueden redirigir los dos flujos de forma independiente.

Consulta Formatos de salida, Códigos de salida y Patrones de scripting.

Registro y telemetría

Los registros son líneas JSON estructuradas. Van a stderr de forma predeterminada y, con --log-file <path>, se duplican en un archivo para que los recojan los cargadores de registros. --log-level controla la verbosidad (debug / info / warn / error).

La telemetría son datos de uso anónimos enviados a Application Insights de UiPath. Se puede deshabilitar con UIPATH_TELEMETRY_DISABLED=1 o redirigir con UIPATH_AI_CONNECTION_STRING. No se transmiten argumentos de comando, contenidos de archivo o credenciales.

Consulta Configuración y la sección Telemetría de Instalación de UiPath CLI.

La superficie 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)

Tres formas, una gramática. La página de referencia de cada herramienta documenta los verbos y marcadores exactos; cada herramienta hereda las mismas opciones globales y envolvente.

Cómo se ejecuta un comando

La secuencia para una invocación uip or folders list , en un nivel alto:

1. Analizar opciones globales. El host elimina --output, --output-filter, --log-level, --log-file de argv y configura el runtime.
2. Resuelve la herramienta. or coincide con la lista blanca. Si @uipath/orchestrator-tool aún no está instalado, se ejecuta la instalación automática. De lo contrario, la herramienta se carga de forma dinámica.
3. La herramienta registra los subcomandos. El host aprende sobre uip or folders list y otros subcomandos de Orchestrator.
4. Resolver la autenticación. La herramienta pregunta al host por la sesión. El host lo recoge de una carpeta .uipath/ (automática), de env-var auth, o falla rápidamente con el código de salida 2 si no hay nada disponible.
5. Resolver la configuración. Las variables de entorno y los marcadores se concilian según la cadena de precedencia.
6. Ejecuta el verbo. La herramienta llama a Orchestrator con la sesión y la configuración resueltas y, a continuación, emite el sobre a través del formateador del host.
7. Salir. El host traduce el Result del sobre en un código de salida del proceso.

Nada en esta secuencia es específico de Orchestrator. Cada llamada uip <tool> … sigue la misma forma, que es lo que hace que los scripts sean portátiles entre herramientas.

Ver también

• Herramientas (complementos) : el modelo de complemento en profundidad.
• Habilidades : el mecanismo de extensión paralelo para agentes de IA.
• Sesiones y credenciales : dónde reside la carpeta de credenciales y cómo se resuelve.
• Configuración : archivos, variables de entorno y precedencia.
• Formatos de salida, Códigos de salida, Opciones globales : el contrato de runtime.