Configuración de UIP

Sintaxis y opciones para `uip config`, que lee, establece y borra las preferencias de configuración de CLI almacenadas en config.json.

uip config lee y escribe el archivo de configuración local de CLI: valores predeterminados como el formato de salida, el nivel de registro y la política de versión/actualización-canal que rige uip update y uip tools update. El archivo se descubre subiendo desde el directorio actual a $HOME buscando .uipath/config.json, retrocediendo a ~/.uipath/config.json si no se encuentra ninguno; --config-file anula el descubrimiento para cualquier verbo.

Sinopsis

uip config get [key] [-c <path>]
uip config set <key> <value> [-c <path>]
uip config clear <key> [-c <path>]

Todos los verbos uip config respetan las opciones globales (--output, --output-filter, --log-level, --log-file). Los códigos de salida siguen el contrato estándar.

Claves de configuración

Clave	Valores válidos	Escribible	Descripción
output	table, json, yaml, plain, markdown	Sí	Formato de salida predeterminado para los comandos CLI.
logLevel	error, warn, info, debug	Sí	Nivel de registro predeterminado.
interactive	never, auto, always	Sí	Cuándo la CLI puede mostrar solicitudes interactivas. El valor predeterminado es auto.
updateChannel	stable, preview (dev se acepta pero no se anuncia)	Sí	Canal de versión utilizado para resolver actualizaciones de herramientas.
version	major.minor o major.minor.patch (p. ej. 1.2 o 1.2.3)	Sí	Política de versión: un major.minor.patch exacto congela la actualización automática por completo; una línea major.minor realiza un seguimiento de esa línea; unset sigue a la última versión.
clientSecret	—	No	Secreto de cliente de aplicación externo utilizado por uip login. Solo lectura desde uip config: establécelo a través de uip login --client-secret env.NAME para que el secreto permanezca en una variable de entorno y el archivo de autenticación, nunca en config.json.

Dos claves más antiguas, autoVersionSync y versionSource, se eliminaron cuando la política de versión se contrajo en version + updateChannel. Ejecutar uip config set autoVersionSync ... o versionSource ... ahora falla con Unknown config key, y el mensaje de error te dirige al equivalente version/updateChannel.

Obtener configuración de UIP

Obtenga un valor de configuración o la configuración completa cuando no se proporciona ninguna clave.

Argumentos

Nombre	Obligatorio	Propósito
[key]	No	Una de las claves de configuración anteriores. Omitir para mostrar el archivo de configuración completo.

Opciones

• -c, --config-file <path> — ruta a un archivo de configuración específico, anulando el descubrimiento.

Ejemplos

uip config get output

# Show everything
uip config get

Forma de datos (--json de salida)

Clave única:

{
  "Code": "ConfigGet",
  "Data": { "Key": "output", "Value": "table" }
}

Una clave sin valor establecido devuelve Value: "-". clientSecret (y cualquier otra clave que contenga secretos) siempre devuelve <redacted>, nunca el valor real.

Sin clave: el archivo completo, secretos redactados:

{
  "Code": "ConfigList",
  "Data": {
    "Config": {
      "core": { "output": "table", "logLevel": "info", "updateChannel": "stable" },
      "auth": { "clientId": "client-abc", "clientSecret": "<redacted>" }
    }
  }
}

ConfigGet y ConfigList son valores Code distintos, por lo que un consumidor JMESPath ve una forma estable por campo Code en lugar de un campo Data que cambia de forma dependiendo de si se pasó key.

conjunto de configuración de UIP

Establece un valor de configuración.

Argumentos

Nombre	Obligatorio	Propósito
<key>	Sí	Una clave de configuración de escritura (todas las claves anteriores excepto clientSecret).
<value>	Sí	El nuevo valor. Validado contra los valores permitidos de la clave, cuando tiene uno.

Opciones

• -c, --config-file <path> — ruta a un archivo de configuración específico, anulando el descubrimiento. El archivo se crea si no existe.

Ejemplos

uip config set output table

uip config set updateChannel preview

# Pin the CLI and tools to the 1.196 line (float — tracks patch releases within it)
uip config set version 1.196

# Freeze on an exact patch (no auto-update at all)
uip config set version 1.196.3

Forma de datos (--json de salida)

{
  "Code": "ConfigSet",
  "Data": { "Key": "output", "Value": "table", "Status": "Updated" }
}

El intento de establecer clientSecret falla y ValidationError te dirige a uip login --client-secret env.NAME en su lugar. Un valor no válido para una clave enumerada (por ejemplo uip config set output csv) falla con ValidationError y enumera los valores válidos.

Borrar configuración de UIP

Eliminar un valor de configuración. Una no-op (no es un error) si la clave nunca se configuró.

Argumentos

Nombre	Obligatorio	Propósito
<key>	Sí	Una clave de configuración escribible.

Opciones

• -c, --config-file <path> — ruta a un archivo de configuración específico, anulando el descubrimiento.

Ejemplos

# Un-pin the version so the CLI follows the latest release again
uip config clear version

# Clearing a key that was never set is a no-op
uip config clear updateChannel

Forma de datos (--json de salida)

{
  "Code": "ConfigClear",
  "Data": { "Key": "version", "Status": "Cleared" }
}

Status es "Not set" en lugar de "Cleared" cuando la clave no tenía ningún valor que eliminar.

Relacionado

• actualización de uip : config get version / config set version gobiernan contra qué línea uip update y uip tools update se resuelven.
• herramientas de uip : las instalaciones/actualizaciones de herramientas leen las mismas claves version y updateChannel .
• inicio de sesión de uip : establece las credenciales fuera de config.json; clientSecret aquí es de solo lectura por una razón.

Ver también

• Opciones globales
• Códigos de salida