- Información general
- Comience ya
- Conceptos
- Uso de UiPath CLI
- UiPath para agentes de codificación
- Guías prácticas
- Recetas de CI/CD
- Referencia de los comandos
- Información general
- Códigos de salida
- Opciones globales
- agente de código UIP
- UIP Docsai
- añadir-entidad-de-datos-de-prueba
- añadir-cola-de-datos-de-prueba
- añadir-variación-de-datos-de-prueba
- Analizar
- Crear
- Crear proyecto
- Diferencia
- Buscar actividades
- obtener-reglas-del-analizador
- obtener-predeterminado-actividad-xaml
- obtener-errores
- obtener-casos-de-prueba-manual
- obtener-pasos-de-prueba-manual
- obtener versiones
- get-workflow-example
- indicar-aplicación
- indicar-elemento
- inspeccionar-paquete
- install-data-fabric-entities
- instalar-o-actualizar-paquetes
- enumerar-data-fabric-entities
- ejemplos-de-flujo-de-trabajo-de-lista
- Paquete
- restore
- archivo de ejecución
- plantillas-de-búsqueda
- iniciar-studio
- detener la ejecución
- UIA
- Seguimientos de UIP
- Migración
- Referencia y soporte
Guía del usuario de UiPath CLI
uip or es la herramienta de Orchestrator: gestiona trabajos, carpetas, procesos, paquetes, máquinas, usuarios, roles, licencias, fuentes y archivos adjuntos en un tenant de UiPath Orchestrator. Instálalo con uip tools install or o invoca uip or … y deja que se ejecute la instalación automática. Consulta Herramientas (complementos) para el modelo de instalación y herramientas uip para el comando que gestiona la instalación de herramientas.
Recursos
Cada recurso tiene su propia página de referencia. El verbo establecido en cada página coincide con los comandos registrados por uip or — ejecuta uip or --help para confirmar la superficie completa en tu instalación.
| Recurso | Propósito |
|---|---|
| Trabajos | Iniciar, detener, reiniciar, reanudar e inspeccionar ejecuciones de procesos; obtener registros, seguimientos, datos de reparación e historial de estados. |
| Carpetas | Crear, enumerar, mover, editar y eliminar carpetas; inspeccionar la asignación de runtime. |
| Procesos | Vincular paquetes a carpetas como procesos ejecutables; actualizar, revertir y editar. |
| Paquetes | Cargar, descargar, enumerar e inspeccionar paquetes de automatización .nupkg y sus puntos de entrada. |
| Máquinas | Gestionar las plantillas de máquinas y las asignaciones de ranuras; asignar máquinas a carpetas. |
| Usuarios | Crear, editar, eliminar y asignar usuarios de Orchestrator; gestionar las asignaciones de roles a nivel de tenant. |
| Roles | Gestiona roles, permisos y membresía de rol-usuario en el ámbito del tenant y la carpeta. |
| Licencias | Enumerar las asignaciones de licencias de runtime y de usuario nombrado; alternar licencias de máquina; ver resumen de licencia de tenant. |
| Transmisiones | Enumerar las fuentes de paquetes disponibles para el usuario actual. |
| Archivos adjuntos | Enumerar y descargar archivos adjuntos de trabajo. |
Sinopsis
uip or <resource> <verb> [options]
uip or <resource> <verb> [options]
Siempre uip or, nunca uip orchestrator. or es el prefijo de comando de la herramienta (consulta la columna commandPrefix en uip tools list).
Cómo leer esta sección
Cada página de recursos está estructurada de la misma manera:
- Sinopsis : la forma del comando
uip or <resource> <verb>. - Verbos : una tabla de una línea de cada verbo que expone el recurso.
- Un H2 por verbo : descripción, argumentos posicionales (si los hay), tabla de marcas, tres ejemplos (el más simple, el caso común, el scripting con
--output-filter) y la formaDatadevuelta en--output json. - Códigos de salida : un puntero al contrato de códigos de salida compartido, con cualquier anulación específica del verbo llamada en línea.
- Comandos relacionados y enlaces cruzados a recursos relacionados y páginas de conceptos relevantes.
El formato de salida predeterminado es --output json. Las formas de datos en cada página reflejan la carga útil de JSON: las representaciones de tabla, yaml y simples se derivan del mismo objeto Data .
Marcadores comunes
Un pequeño conjunto de marcadores se repite en la mayoría de los recursos. Se comportan de la misma manera dondequiera que aparezcan:
| Marca | Utilizado por | Propósito |
|---|---|---|
-t, --tenant <tenant-name> | cada verbo | Anula el tenant seleccionado en el momento de la autenticación. Opcional; omitir para utilizar la sesión predeterminada. Consulta Autenticación. |
--folder-path <path> | la mayoría de los verbos que se limitan a una carpeta | Carpeta de destino por ruta completa (por ejemplo, Shared, Production/EU). |
--folder-key <key> | la mayoría de los verbos que se limitan a una carpeta | Carpeta de destino por GUID. Utilizable mutuamente con --folder-path; resuelve la misma carpeta. |
-l, --limit <number> | cada verbo de lista | Tamaño de la página. El valor predeterminado es el DEFAULT_PAGE_SIZE de CLI (50 en el momento de escribir este artículo). |
--offset <number> | cada verbo de lista | Número de elementos que se omitirán antes de volver. El valor predeterminado es 0. |
--order-by <field> | la mayoría de los verbos de lista | Expresión de ordenación de OData (por ejemplo, Name asc, Id desc). Cada verbo documenta su valor predeterminado. |
--all-fields | muchos verbos list / get | Devuelve la respuesta de la API sin procesar en lugar del resumen seleccionado. Útil cuando necesitas campos que omite la forma predeterminada. |
Los marcadores a nivel de verbo (filtros, rutas de entrada/salida, estrategias, prioridades) se documentan en cada página de recursos.
Opciones globales y códigos de salida
Todos los verbos uip or respetan las cuatro opciones globales (--output, --output-filter, --log-level, --log-file). Los códigos de salida siguen el contrato compartido; cualquier anulación específica del verbo se indica en la página de recursos relevante.
Ver también
- Conceptos: cómo se organiza UiPath CLI : dónde encajan las herramientas en el modelo host + herramienta.
- Sesiones : cómo se resuelven el contexto del tenant y la carpeta.
- Configuración : variables de entorno y archivos de configuración que afectan a cada herramienta.
- Inicio rápido y Tu primer proceso : tutoriales de extremo a extremo que ejercitan
uip or.