UIP 構成

'uip config' の構文とオプション。config.json に保存されている CLI 構成設定を読み取って設定し、クリアします。

uip config CLI のローカル構成ファイル (出力形式、ログ レベル、 uip update と uip tools updateを管理するバージョン/更新チャネル ポリシーなどの既定値) を読み書きします。ファイルは、現在のディレクトリから $HOME まで歩いて .uipath/config.jsonを探すことによって検出され、見つからない場合は ~/.uipath/config.json にフォールバックします。 --config-file 動詞の検出を上書きします。

概要

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

uip config動詞はすべてグローバル オプション (--output、 --output-filter、 --log-level、 --log-file) に従います。終了コードは 標準契約に従います。

構成キー

キー	有効な値	書き込み可能	説明
output	table、json、yaml、plain、markdown	○	CLI コマンドの既定の出力形式です。
logLevel	error、warn、info、debug	○	既定のログ レベル。
interactive	neverauto、always	○	CLI に対話型プロンプトが表示される場合。既定値は autoです。
updateChannel	stable、 preview (dev は受け入れられますが、アドバタイズされません)。	○	ツールの更新の解決に使用されるリリース チャネル。
version	major.minor または major.minor.patch (例:1.2 または 1.2.3)	○	バージョン ポリシー: 正確な major.minor.patch によって自動更新が完全にフリーズします。 major.minor 線がその線を追跡します。[設定解除] は最新リリースに従います。
clientSecret	—	×	uip loginが使用する外部アプリのクライアント シークレットです。uip config からの読み取り専用 — uip login --client-secret env.NAME を使用して設定し、シークレットが環境変数と認証ファイル内に留まるようにconfig.json。

バージョン ポリシーが version + updateChannelに折りたたまれたときに、autoVersionSync と versionSourceの 2 つの古いキーが削除されました。uip config set autoVersionSync ... または versionSource ... の実行が Unknown config keyで失敗し、エラー メッセージが表示されて同等の version/updateChannel に移動できるようになりました。

uip config get

1 つの構成値を取得するか、キーが指定されていない場合は完全な構成を取得します。

引数

名前	Required	目的
[key]	×	上記の構成キーの 1 つ。設定ファイル全体を表示する場合は省略します。

オプション

• -c, --config-file <path> — 検出を上書きする特定の構成ファイルへのパスです。

例

uip config get output

# Show everything
uip config get

データシェイプ(--output json)

シングルキー:

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

値が設定されていないキーは Value: "-"を返します。clientSecret (およびその他のシークレットを含むキー) は常に <redacted>を返し、実際の値は返しません。

キーなし — ファイル全体、シークレットは墨消し済み:

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

ConfigGetとConfigListはCode別個の値であるため、JMESPathコンシューマーには、keyが渡されたかどうかに応じて形状が変化するDataフィールドではなく、Codeごとに1つの安定した図形が表示されます。

UIP 構成セット

設定値を設定します。

引数

名前	Required	目的
<key>	○	書き込み可能な構成キー ( を除く上記のすべてのキー clientSecret)。
<value>	○	新しい値です。キーの許容値がある場合、その値に対して検証されます。

オプション

• -c, --config-file <path> — 検出を上書きする特定の構成ファイルへのパスです。ファイルが存在しない場合は作成されます。

例

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

データシェイプ(--output json)

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

clientSecretを設定しようとすると失敗し、代わりにValidationErroruip login --client-secret env.NAMEを参照します。列挙キーに無効な値 ( uip config set output csvなど) があると、 ValidationError で失敗し、有効な値が一覧表示されます。

UIP 構成のクリア

設定値を削除します。キーが設定されていない場合の操作なし (エラーではありません)。

引数

名前	Required	目的
<key>	○	書き込み可能な構成キー。

オプション

• -c, --config-file <path> — 検出を上書きする特定の構成ファイルへのパスです。

例

# 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

データシェイプ(--output json)

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

キーに削除する値がない場合、Status"Cleared"ではなく"Not set"されます。

関連

• UIP の更新 — config get version / config set version uip update と uip tools update 解決対象の行を制御します。
• UIP ツール — ツールのインストール/更新では、同じ version キーとキー updateChannel 読み取られます。
• uip ログイン — config.json外の資格情報を設定します。ここで clientSecret が読み取り専用になっているのには理由があります。

参照

• グローバル オプション
• 終了コード