UiPath Documentation
uipath-cli
latest
false
Importante :
Este contenido se ha traducido mediante traducción automática. La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

Guía del usuario de UiPath CLI

Opciones globales

Se reconocen cuatro opciones en cada invocación uip , independientemente de la herramienta o el subcomando. Controlan el formato de salida, el filtro de salida y el flujo de registro. Todos los demás marcadores se definen por comando.

OpciónCortoValorPredeterminadoPropósito
--outputtable, json, yaml, plainjsonFormato de la salida principal escrita en stdout.
--output-filterExpresión JMESPathFiltro posterior aplicado a la carga útil JSON antes de formatear.
--log-leveldebug, info, warn, errorinfoVerbosidad de los mensajes de registro escritos en stderr (y --log-file si se establece).
--log-fileRutaSi se establece, los registros se duplican en este archivo en formato de líneas JSON.

--version (-v) y --help (-h) también se reconocen en uip y en cada subcomando, pero son convenciones CLI estándar en lugar de marcadores globales en el sentido anterior.

--alida

Elige el formato de salida. Tanto --output json como --output=json funcionan; los valores distinguen entre mayúsculas y minúsculas.

uip or folders list                  # default: json
uip or folders list --output table   # human-friendly table
uip or folders list --output yaml    # yaml
uip or folders list --output plain   # key=value lines, no structure
uip or folders list                  # default: json
uip or folders list --output table   # human-friendly table
uip or folders list --output yaml    # yaml
uip or folders list --output plain   # key=value lines, no structure
  • json predeterminado): un documento JSON en la salida estándar. Analizable por jq, --output-filter y cualquier consumidor JSON. Este es el valor predeterminado para cada invocación, independientemente de si el terminal es un TTY.
  • table — tabla de colores con bordes adecuada para leer en un terminal. No es estable en todas las versiones: no lo analices.
  • yaml — Serialización YAML de la misma estructura que json.
  • plain — líneas key=value planas. Útil para conectar al shell read, grep y cut sin instalar jq.
Nota:

El valor predeterminado es json, no table. Cuando un humano ejecuta uip or folders list en un terminal, ve un documento JSON en la salida estándar. Pasa --output table explícitamente (o añádelo a un alias de shell) para la vista de lectura fácil. Esta opción mantiene la misma forma de salida estándar en un terminal y en un proceso: a los scripts no les tiene que importar si se ejecutan de forma interactiva.

Separación de transmisiones

--output controla solo la salida estándar. Los registros, los indicadores de progreso y los errores de cara a humanos van a stderr, independientemente del formato. Esto significa que un proceso puede capturar JSON limpio con:

uip or folders list > folders.json 2> uip.log
uip or folders list > folders.json 2> uip.log

…y seguir viendo la salida del registro por separado.

--filtro-de-salida

Aplica una expresión JMESPath a la carga útil JSON antes de formatear. El filtro se ejecuta en el sobre de respuesta completo, por lo que Data[*].Name selecciona nombres de la matriz Data , length(Data) devuelve un recuento, etc.

# just the Data field
uip or folders list --output-filter "Data"

# folder names only
uip or folders list --output-filter "Data[*].Name"

# count
uip or folders list --output-filter "length(Data)"

# first folder's key and name
uip or folders list --output-filter "Data[0] | {key: Key, name: Name}"
# just the Data field
uip or folders list --output-filter "Data"

# folder names only
uip or folders list --output-filter "Data[*].Name"

# count
uip or folders list --output-filter "length(Data)"

# first folder's key and name
uip or folders list --output-filter "Data[0] | {key: Key, name: Name}"

Combinando con --output:

# names as YAML
uip or folders list --output-filter "Data[*].Name" --output yaml

# names as one-per-line plain text
uip or folders list --output-filter "Data[*].Name" --output plain
# names as YAML
uip or folders list --output-filter "Data[*].Name" --output yaml

# names as one-per-line plain text
uip or folders list --output-filter "Data[*].Name" --output plain

Una expresión de filtro mal formada falla rápidamente con un ValidationError y el código de salida 3 antes de que se ejecute el comando subyacente, por lo que un error tipográfico no desperdicia una llamada a la API.

Consejo:

--output-filter es la versión CLI de --query de Azure CLI, --query de AWS CLI y --filter/--format de gcloud. Si ya conoces JMESPath de esas herramientas, la sintaxis es idéntica.

--nivel de registro

Establece el nivel de detalle de los mensajes de registro (escritos en stderr y en --log-file si se proporciona).

uip or folders list --log-level debug   # verbose — HTTP calls, auth refresh, tool loading
uip or folders list --log-level info    # default
uip or folders list --log-level warn
uip or folders list --log-level error   # only failures
uip or folders list --log-level debug   # verbose — HTTP calls, auth refresh, tool loading
uip or folders list --log-level info    # default
uip or folders list --log-level warn
uip or folders list --log-level error   # only failures

Los valores no distinguen entre mayúsculas y minúsculas. Los valores desconocidos se ignoran silenciosamente (se mantiene el valor predeterminado) en lugar de generar errores, a propósito, para que un error tipográfico en un script de contenedor no interrumpa un proceso.

La variable de entorno UIPATH_LOG_LEVEL no se respeta; pasar el marcador o establecerlo en un script de perfil.

--archivo-de-registro

Escribe un duplicado del flujo de registro en el archivo especificado, en formato de líneas JSON (un objeto JSON por línea). El archivo se adjunta : utiliza una ruta específica de la compilación si necesitas registros independientes por ejecución.

uip or folders list --log-file ./uip.log
uip or folders list --log-file /var/log/uip/$(date +%F).log --log-level debug
uip or folders list --log-file ./uip.log
uip or folders list --log-file /var/log/uip/$(date +%F).log --log-level debug

Cada línea del archivo tiene el siguiente aspecto:

{"time":"2026-04-24T18:42:00.123Z","level":"info","message":"CLI v1.0.0 starting — output=json, logLevel=info, logFile=./uip.log"}
{"time":"2026-04-24T18:42:00.123Z","level":"info","message":"CLI v1.0.0 starting — output=json, logLevel=info, logFile=./uip.log"}

Este formato está diseñado para los cargadores de registros (Fluent Bit, Loki, Splunk) y para el análisis post-mortem.

Cuando se aplican opciones globales

Las opciones globales se eliminan de la línea de comandos antes de que se analicen los marcadores por comando, por lo que pueden aparecer en cualquier lugar de la línea de comandos:

uip --output table or folders list
uip or --output table folders list
uip or folders list --output table
uip or folders list --output=table
uip --output table or folders list
uip or --output table folders list
uip or folders list --output table
uip or folders list --output=table

Las cuatro invocaciones son equivalentes.

Los subcomandos de herramientas no definen sus propios --output o --log-level. Una herramienta que definiera inadvertidamente uno sombrearía el marcador global: las comprobaciones de pelusa de CLI lo prohíben.

Códigos de salida

Las opciones globales controlan solo la salida y el registro; no afectan a los códigos de salida. Consulta Códigos de salida.

Ver también

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte

¿Quiere aprender? UiPath Academy

¿Tiene alguna pregunta? Foro de UiPath

Manténgase actualizado