Opciones globales

Opciones globales aceptadas por cada invocación de `uip`, que cubren el formato de salida, el filtro de salida, el nivel de registro y el archivo de registro.

Cada invocación uip se escanea previamente en busca de un conjunto fijo de opciones globales antes de que cualquier herramienta o subcomando vea sus argumentos: pueden aparecer en cualquier lugar de la línea de comandos, funcionar de forma idéntica en todas las herramientas y se eliminan antes del análisis de marcadores por comando se ejecuta.

Opción	Corto	Valor	Predeterminado	Propósito
--output	—	table, json, yaml, plain, markdown	json	Formato de la salida principal escrita en stdout.
--output-filter	—	Expresión JMESPath	—	Filter applied to the Data field of the response envelope before formatting.
--log-level	—	debug, info, warn, error	info	Verbosity of log messages written to stderr (or to --log-file if set).
--log-file	—	Ruta	—	If set, logs are written to this file instead of stderr.
--profile	—	name	—	Selecciona un perfil de inicio de sesión guardado con nombre en lugar de la ubicación predeterminada de las credenciales. Mutuamente exclusivo con el propio -f, --file <folder> de un comando (por ejemplo en uip login, uip login tenant list/set, uip logout): pasar ambos es un ValidationError. Consulta Sesiones y credenciales.
--interactive / --no-interactive	—	Marca	automático (solicitudes solo en un TTY)	Forzar la activación o desactivación de la solicitud, anulando la opción predeterminada "solicitud solo cuando está conectado a un TTY" comportamiento. No es específico de ningún comando: rige cada lugar en el que un comando uip haría una pregunta (por ejemplo, la selección de tenant durante uip login, o el selector de agente/destino en uip skills install).

--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 --output markdown   # GitHub-flavored markdown, for agents/chat surfaces

• 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.
• markdown — a GFM table for a list, or **key:** value lines for a single record. Meant for an agent or chat surface reading uip output, not a terminal session. Refer to Output formats — markdown for the full behavior.

Only the five format names above are read as the global option. Several commands own a -o, --output <path> option of their own; a value that is not a format name, such as --output ./report.pdf, is left for the command. You can therefore combine a format and a command's output path in one invocation, for example --output json -o ./report.pdf.

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.

--perfil

Selecciona un perfil de inicio de sesión guardado con nombre en lugar de la ubicación predeterminada de las credenciales:

uip login --profile ci-runner --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant Production
uip or folders list --profile ci-runner

--profile <name> y el propio -f, --file <folder> de un comando son mutuamente excluyentes: pasar ambos falla con ValidationError: option '--profile' cannot be used with option '--file'. Los nombres de perfil están normalizados (se aplican las reglas de mayúsculas y minúsculas); un nombre no válido se rechaza antes de cualquier llamada de red. Consulta Sesiones y credenciales: perfiles con nombre.

--interactive / --no-interactive

Anular la opción predeterminada "solicitar solo cuando stdout es un TTY" Comportamiento:

uip login --interactive        # force the tenant-selection prompt even when not on a TTY
uip skills install --no-interactive --agent claude   # never prompt, fail instead if a required choice is missing

--interactive establece las solicitudes en siempre activas; --no-interactive lo fuerza a desactivarse. Ninguno de los marcadores es específico de uip login: a pesar de aparecer en los ejemplos de inicio de sesión a lo largo de este conjunto de documentación, la interactividad es una opción global transversal sin forma abreviada específica del comando (no hay --it o alias similares en ninguna parte de la CLI).

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

…y seguir viendo la salida del registro por separado.

--filtro-de-salida

Apply a JMESPath expression to the Data field of the response envelope before formatting. The expression starts at Data, not at the envelope, so [*].Name picks names out of a Data array and length(@) returns a count. The result replaces Data; Result, Code, and the other envelope fields stay in place.

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

# count
uip or folders list --limit 50 --output-filter "length(@)"

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

Keys in the filtered result are normalized to PascalCase, the same as unfiltered Data. A projection that returns plain values, such as [*].Name, is rendered as one record per value, keyed by the last field name in the expression.

Combinando con --output:

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

# names as one-per-line plain text
uip or folders list --limit 50 --output-filter "[*].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.

The filter runs on the client, over the records the command fetched. On a command whose --limit has a default value, --output-filter requires an explicit --limit; without one, the command fails instead of filtering only the first page of records.

When the filter returns nothing, or only null values, from records that were there, the envelope carries a Warning field that names the fields the expression read that do not exist, and lists the available fields. The same note is written to stderr.

On failure, the filter is applied to the failure envelope's Data the same way. Message, Instructions, ErrorCode, Retry, and Context are never filtered. If the filter cannot be evaluated against a failure's Data, Data is shown in full and Warning explains why.

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

Set the verbosity of log messages (written to stderr, or to --log-file if provided).

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

Write the log stream to the specified file instead of stderr. The file is created if it does not exist, including missing parent directories, and is truncated at the start of each run — use a build-specific path if you need to keep logs from several runs.

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

Each line in the file is the log message prefixed with an ISO 8601 timestamp:

2026-04-24T18:42:00.123Z [DEBUG] <message>

Debug, warning, and error lines carry a [DEBUG], [WARN], or [ERROR] tag; info lines carry none. When --log-file is set, every envelope includes a Log field with the file path.

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

Las cuatro invocaciones son equivalentes.

Tool subcommands do not define their own --log-level. Commands that take an output path define -o, --output <path>; the CLI reads --output as the global option only when its value is one of the format names, so the two do not collide.

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.

Anulaciones de variables de entorno

These environment variables change global-option behavior without a flag:

Variable	Efecto
UIP_DEFAULT_OUTPUT	Anula el valor predeterminado integrado json para --output cuando no se pasa el marcador. Acepta table, json, yaml, plain o markdown; los valores no válidos se ignoran. Un --output explícito en la línea de comandos siempre gana.
UIP_TIMINGS	Set to 1 or true to print a per-invocation timing line on every uip command. Refer to Command timings below.
UIP_TIMINGS_FILE	Path of a file to append the timing line to, instead of writing it to stderr. Read only when UIP_TIMINGS is on.

Tiempos de comando

Set UIP_TIMINGS=1 (or true) and every invocation prints one line to stderr (or to the --log-file file, when one is set):

[timing] 'uip or assets list' exit=0 total=1250ms startup=380ms command=863ms http=691ms httpCalls=3 flush=7ms

Campo	Significado
(el comando entrecomillado)	El comando tal como se ha escrito.
exit	El código de salida que devolvió la invocación.
total	Reloj de pared total, medido desde el inicio del proceso.
startup	Todo antes de que se ejecutara el controlador de comandos: arranque del proceso, configuración, carga de herramientas.
command	El propio controlador de comandos.
http	Duración sumada de las llamadas HTTP salientes de la ejecución: una sum, no un reloj de pared. Se superpone a command en lugar de sumarse a él, por lo que las llamadas paralelas pueden hacer que sea mayor que command.
httpCalls	Cuántas llamadas HTTP salientes cubre esa suma.
flush	Todo lo que sucede después de la devolución del controlador: contabilidad de telemetría y el vaciado final.

startup + command + flush siempre es igual a total. Los campos se omiten cuando no se aplican: una ejecución que nunca llega a un controlador (uip --version, un comando desconocido) imprime solo total y exit; un comando que no realiza ninguna llamada HTTP no tiene http ni httpCalls.

El informe tiene su propio conmutador: no depende de --log-level, por lo que obtienes duraciones sin activar la salida de depuración y la salida estándar nunca se toca.

To keep the report off stderr without moving the rest of the log stream, set UIP_TIMINGS_FILE to a file path. Each invocation appends its line to that file, so several runs can share one file. Only the values 1 and true turn the report on; any other UIP_TIMINGS value leaves it off.

Ver también

• Formatos de salida (tabla, JSON, YAML) : cobertura más profunda con ejemplos completos de cada formato.
• Patrones de scripting : códigos de salida, separación de flujo, reintentos, sondeo.
• referencia de inicio de sesión de uip y otras páginas de comandos: documenta sus marcadores por comando además de estos globales.