Configuração da UIP

Sintaxe e opções para "uip config", que lê, define e limpa preferências de configuração da CLI armazenadas em config.json.

uip config lê e grava o arquivo de configuração local da CLI — padrões como o formato de saída, nível de log e a política de versão/canal de atualização que rege uip update e uip tools update. O arquivo é descoberto andando do diretório atual até $HOME procurando .uipath/config.json, recai para ~/.uipath/config.json se nenhum for encontrado; --config-file substitui a descoberta de qualquer verbo.

Resumo

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

Todos os verbos uip config respeitam as opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato padrão.

Chaves de configuração

Chave	Valores válidos	gravável	Description
output	table, json, yaml, plain, markdown	sim	Formato de saída padrão para comandos de CLI.
logLevel	error, warn, info, debug	sim	Nível de log padrão.
interactive	never, auto, always	sim	Quando a CLI pode mostrar prompts interativos. O padrão é auto.
updateChannel	stable, preview (dev é aceito, mas não anunciado)	sim	Canal de versão usado para resolver atualizações de ferramentas.
version	major.minor ou major.minor.patch (por exemplo 1.2 ou 1.2.3)	sim	Política de versão: um major.minor.patch exato congela totalmente a atualização automática; uma linha major.minor rastreia essa linha; unset segue a versão mais recente.
clientSecret	—	não	Segredo do cliente do aplicativo externo usado por uip login. Somente leitura de uip config — defina-o por meio de uip login --client-secret env.NAME para que o segredo permaneça em uma variável de ambiente e no arquivo de autenticação, nunca em config.json.

Duas chaves mais antigas, autoVersionSync e versionSource, foram removidas quando a política de versão foi recolhida em version + updateChannel. A execução de uip config set autoVersionSync ... ou versionSource ... agora falha com Unknown config key, e a mensagem de erro orienta você para o equivalente a version/updateChannel.

Obtenção de configuração do uip

Obtenha um valor de configuração ou a configuração completa quando nenhuma chave é fornecida.

Argumentos

Name	Required	Finalidade
[key]	não	Uma das chaves de configuração acima. Omita para mostrar todo o arquivo de configuração.

Opções

• -c, --config-file <path> — caminho para um arquivo de configuração específico, substituindo a descoberta.

Exemplos

uip config get output

# Show everything
uip config get

Formato dos dados (--output json)

Chave única:

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

Uma chave sem valor definido retorna Value: "-". clientSecret (e qualquer outra chave com segredo) sempre retorna <redacted>, nunca o valor real.

Sem chave — o arquivo completo, com segredos rasurados:

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

ConfigGet e ConfigList são valores Code distintos, então um consumidor JmesPath vê uma forma estável por Code em vez de um campo Data que muda de forma dependendo se key foi passado.

conjunto de configurações do uip

Defina um valor de configuração.

Argumentos

Name	Required	Finalidade
<key>	sim	Uma chave de configuração gravável (todas as chaves acima, exceto clientSecret).
<value>	sim	O novo valor. Validado com os valores permitidos da chave, quando tem um.

Opções

• -c, --config-file <path> — caminho para um arquivo de configuração específico, substituindo a descoberta. O arquivo será criado se não existir.

Exemplos

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

Formato dos dados (--output json)

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

A tentativa de definir clientSecret falha com ValidationError apontando você para uip login --client-secret env.NAME em vez disso. Um valor inválido para uma chave enumerada (por exemplo uip config set output csv) falha com ValidationError e lista os valores válidos.

Limpeza de configuração do uip

Remova um valor de configuração. Um não operacional (não um erro) se a chave nunca foi definida.

Argumentos

Name	Required	Finalidade
<key>	sim	Uma chave de configuração gravável.

Opções

• -c, --config-file <path> — caminho para um arquivo de configuração específico, substituindo a descoberta.

Exemplos

# 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

Formato dos dados (--output json)

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

Status é "Not set" em vez de "Cleared" quando a chave não tinha nenhum valor a ser removido.

Relacionado

• atualização uip — config get version / config set version governam qual linha uip update e uip tools update resolvem.
• ferramentas uip — instalações/atualizações de ferramentas leem as mesmas chaves version e updateChannel .
• login uip — define credenciais fora de config.json; clientSecret aqui é somente leitura por um motivo.

Veja também

• Opções globais
• Códigos de saída