Resumen de referencia

La referencia documenta cada comando uip , marca y código de salida. Úsalo como una búsqueda cuando sepas lo que quieres hacer y necesites la sintaxis exacta. Para aprender, comienza en el Inicio rápido o Cómo se organiza UiPath CLI.

Cómo se organiza la referencia

La referencia se divide en tres tipos de página:

1. Transversal : comportamiento que se aplica a cada invocación uip independientemente de la herramienta.
2. Comandos del núcleo : comandos que posee el host (login, logout, tools, skills, mcp, completion).
3. Por herramienta : una sección por herramienta instalable; cada sección tiene una descripción general más una página por recurso (para herramientas de recurso primero) o por verbo (para herramientas de flujo de trabajo único).

Transversales

Página	Qué cubre
Opciones globales	--output, --output-filter, --log-level, --log-file — los cuatro marcadores disponibles en cada comando.
Códigos de salida	El contrato de código de salida de cinco niveles (0 / 1 / 2 / 3 / 4) más 130 para la cancelación del usuario.

Comandos básicos

Comandos que el host registra directamente. No se requiere instalación de herramientas.

Comando	Propósito
Inicio de sesión de UIP	Inicia una sesión OAuth2 interactiva, autentícate como aplicación externa o cambia de tenant.
Cierre de sesión de UIP	Elimina las credenciales almacenadas.
estado de inicio de sesión de uip	Muestra la organización, el tenant y la caducidad de la sesión actual.
Herramientas de UIP	Enumerar, buscar, instalar, actualizar o desinstalar herramientas instalables.
Habilidades de UIP	Instala las habilidades de UiPath en los agentes de codificación (Claude Code, Cursor, GitHub Copilot, Gemini CLI, Codex, OpenCode).
mcp de uip	Exponer comandos uip sobre el protocolo de contexto de modelo para clientes compatibles con MCP.
Finalización de UIP	Instalar, imprimir o eliminar la finalización de la pestaña del shell para bash, zsh, fish y pwsh.

Herramientas

Cada herramienta es un paquete npm instalable. Ejecuta uip tools install <alias> para añadirlo, o invócalo una vez y deja que la instalación automática haga el trabajo. Consulta Herramientas (complementos) para el modelo y herramientas uip para el comando que las gestiona.

Alias	Herramienta	Referencia
or	Orchestrator	UIP o
platform	Plataforma (licencias de tenant, paquetes de usuario, reglas de grupo, consumibles)	Plataforma UIP
solution	Solución	Solución UIP
agent	Agente	Agente de UIP
flow	Flujo (solo instalación explícita, no en la lista blanca de instalación automática)	Flujo de UIP
maestro	Maestro	Maestro de UIP
tm	Test Manager	UIP TM
rpa	RPA (empaquetado, analizador y restauración de Studio)	RPA de UIP
rpa-legacy	RPA heredado: contenedor solo para Windows de uipcli.exe (depurar, validar, encontrar actividades, encontrar paquete, definición de tipo, paquete)	UIP RPA-heredado
resource	Recurso (activos, colas, depósitos, desencadenadores, webhooks)	Recurso UIP
is	Integration Service	UIP es
codedagent	Agente codificado	agente de código UIP
codedapp	Aplicación codificada	aplicación codificada de UIP
api-workflow	Flujo de trabajo de API	flujo de trabajo de API de UIP
vss	Soluciones verticales	vss de UIP
df	Data Fabric	Archivo de UIP
insights	Insights	Información de UIP
traces	Seguimientos	Seguimientos de UIP
docsai	IA de Documentos	UIP Docsai

Cómo leer una página de comandos

La página de referencia de cada comando sigue la misma estructura:

1. Sinopsis : la forma del comando de una línea, que muestra los argumentos posicionales y el conjunto de marcadores comunes.
2. Descripción : uno o dos párrafos sobre lo que hace el comando y dónde encaja en un flujo de trabajo.
3. Argumentos : tabla de argumentos posicionales: nombre, obligatorio/opcional, propósito.
4. Opciones : tabla de marcadores agrupados por preocupación (identidad, filtrado, salida, comportamiento). Cada fila muestra un nombre corto, un nombre largo, un tipo de valor, un valor predeterminado y una descripción de una línea.
5. Ejemplos : tres o más ejemplos resueltos: mínimo, caso común, scripting-amigable (con --output-filter o manejo explícito de JSON).
6. Códigos de salida : un puntero a los códigos de salida más cualquier anulación específica del comando.
7. Comandos relacionados : comandos utilizados con frecuencia con este.
8. Consulta también : páginas de conceptos y de instrucciones que cubren el contexto del comando.

Todas las páginas heredan las opciones globales; no se repiten en cada comando.

Convenciones

• Prefijo de comando. uip es el ejecutable; cada ejemplo comienza con él.
• Marcadores de posición. <angle-brackets> para valores obligatorios, [square-brackets] para valores opcionales. Reemplace con sus valores reales.
• Marcas cortas. Cuando un marcador tiene una forma abreviada (por ejemplo, -t para --tenant), ambos se enumeran juntos en la tabla de opciones; los ejemplos utilizan la forma larga para facilitar la legibilidad.
• Ejemplos de JSON. --output json es el valor predeterminado. Los ejemplos que muestran la salida eliden los campos irrelevantes con … para mantener el foco.
• Notas de la versión. Los comandos o marcadores etiquetados como Vista previa pueden cambiar sin un cambio de versión MAYOR. Los comandos etiquetados como Obsoletos siguen funcionando durante al menos un ciclo MAYOR. Consulta Control de versiones y estabilidad.