構成

UiPath CLI の構成リファレンスです。環境変数、コマンド ライン フラグ、優先順位のルールについて説明します。

UiPath CLI は、 コマンド ライン フラグ、 環境変数、およびローカル 構成ファイルを使用して構成します。フラグは 1 回の呼び出し用です。環境変数は、CI ランナーとコンテナに適しています。構成ファイルには、1 台のマシン上の呼び出し間で保持される既定値 (出力形式、ログ レベル、バージョン/更新チャネル ポリシー) が保持されます。

設定ソース

優先順位の高い順に、最も具体的なものから最も一般的なものへと:

1. コマンドラインフラグ — --tenant、 --authority、 --client-id、 --output、 --log-levelなどフラグは他のすべてのソースよりも優先されます。
2. 環境変数 — 実行時にCLIによって読み取られる変数( 環境変数を参照)。CLI は、文書化されたポイントでのみ各変数を読み取ります。暗黙の「すべてのフラグには env-var に対応するものがある」というルールはありません。
3. 構成ファイル — .uipath/config.json、現在のディレクトリから $HOMEにウォークして検出し、 ~/.uipath/config.jsonにフォールバックします。uip config get|set|clearで管理されます。output、logLevel、interactive、updateChannel、versionを保持します。完全なキー リファレンスについては、「 uip config 」をご覧ください。
4. ハードコードされたデフォルト — https://cloud.uipath.com 、 json は出力形式、 info ログレベル、ページサイズは 50 on list 動詞です。

環境変数

環境変数は、CI ランナー、コンテナー、およびシェルごとの開発者設定で CLI を構成するための主要なメカニズムです。ランナーの環境 (またはランナーによって消費される .env ファイル) で設定すると、CLI は以下に記載されているポイントでそれらを読み取ります。

変数	読み上げ者	目的
UIPATH_URL	uip login、認証されたすべてのコマンド	ID 機関のベース URL を上書きします。既定値は https://cloud.uipath.comです。
UIPATH_CLI_ENABLE_ENV_AUTH	認証されたすべてのコマンド	Set to literal true to switch the CLI from the file-based credentials flow to environment-variable auth. With this gate on, the CLI reads the access token + tenant + organization from the variables below and bypasses the ~/.uipath/ credentials folder entirely. Refer to Authentication — Flow 4.
UIPATH_CLI_AUTH_TOKEN	env-var 認証フローのみ	Access token: a JWT, or a Personal Access Token. For a JWT, the server URL is derived from the token's iss claim. For a Personal Access Token, which is not a JWT, set UIPATH_URL to the UiPath base URL.
UIPATH_CLI_ORGANIZATION_NAME	env-var 認証フローのみ	組織のスラッグ。
UIPATH_CLI_ORGANIZATION_ID	env-var 認証フローのみ	組織 UUID。
UIPATH_CLI_TENANT_NAME	env-var 認証フローのみ	テナント スラッグ。
UIPATH_CLI_TENANT_ID	env-var 認証フローのみ	テナント UUID。
UIPATH_TELEMETRY_DISABLED	テレメトリの初期化	匿名の使用状況テレメトリをオプトアウトするには、[ 1 ] または [ true ] に設定します。
UIPATH_AI_CONNECTION_STRING	テレメトリの初期化	Application Insights の接続文字列を上書きします。
HTTP_PROXY / http_proxy	ネットワーク層	送信要求 (ホストとツール) の HTTP プロキシ。
UIPATH_PROXY_INTEGRATED_AUTH	ネットワーク層	Set to literal true to authenticate the proxy CONNECT tunnel with Windows Integrated Authentication — Kerberos/Negotiate or NTLM single sign-on. Without the opt-in the CLI supports no-auth and Basic proxies only.
UIPATH_PROXY_USER / UIPATH_PROXY_PASSWORD / UIPATH_PROXY_DOMAIN	ネットワーク層	Authenticate the proxy as a specific account rather than the logged-in user. Credentials may also be supplied as user:pass@ in the proxy URL. Supplying them excludes ambient SSO, so a wrong password fails rather than silently falling back.
HTTPS_PROXY / https_proxy	ネットワーク層	HTTPS プロキシ。
NO_PROXY / no_proxy	ネットワーク層	プロキシ バイパス リスト。
UIP_DEFAULT_OUTPUT	出力の書式設定	--outputが渡されない場合、既定の組み込みjsonを上書きします。table、json、yaml、plain、または markdownを受け入れます。コマンド ラインでの明示的な--outputは常に優先されます。
UIP_TIMINGS	タイミング計測器	Set to 1 or true to print a per-invocation timing line to stderr (total, startup, command, http/httpCalls, flush). Refer to Global options — Command timings.
UIP_TIMINGS_FILE	タイミング計測器	Path of a file to append the timing line to instead of stderr. Read only when UIP_TIMINGS is on.
UIPATH_CLI_TOOLS_DIRS	Tool discovery and install	For a host application that embeds the CLI: a list of node_modules/@uipath directories, separated by ; on Windows and : on macOS/Linux. When set, only these directories are searched for tools, the first entry is where uip tools install writes, and the CLI does not update itself.
NO_COLOR	ターミナル出力	値を設定すると、 --output tableで色が強制的にオフになり、TTY の自動検出が上書きされます。
FORCE_COLOR	ターミナル出力	stdout が TTY でない場合でも、色を強制的にオンにします (例:色付きのパイプ出力)。TTY 検出の前に NO_COLORとともにチェックされます。

デプロイ間で異なるシークレット以外の値 (テナント、組織、フォルダー名) の場合は、CI ランナーで変数として渡し、 uip コマンドで参照します。

env:
  UIPATH_TENANT: Production
  UIPATH_FOLDER: Shared
script:
  - uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant "$UIPATH_TENANT"
  - uip or folders list --all --path "$UIPATH_FOLDER"

警告:

UIPATH_CLIENT_ID / UIPATH_CLIENT_SECRET の暗黙的な読み取りなし

Setting UIPATH_CLIENT_ID and UIPATH_CLIENT_SECRET in the environment alone does not authenticate the CLI. Pass them explicitly using the env.VAR_NAME prefix on --client-id / --client-secret, or use the env-var auth flow above for token-based authentication. Refer to Authentication.

各設定が生きられる場所

設定	フラグ	環境変数	既定 (Default)
典拠/ベース URL	--authority <url>	UIPATH_URL	https://cloud.uipath.com
外部アプリケーション クライアント ID	--client-id <id>	— (env.VAR_NAMEプレフィックス)	なし
外部アプリのクライアント シークレット	--client-secret <secret>	— (env.VAR_NAMEプレフィックス)	なし
テナント	--tenant <name> (またはセッション)	—	セッションから
フォルダー	--folder-path /コマンドあたり--folder-key	—	なし
出力フォーマット	--output <format>	—	json
出力フィルター	--output-filter <jmespath>	—	なし
ログ レベル	--log-level <level>	—	info
ログ ファイル	--log-file <path>	—	なし
ツールの npm レジストリ	—	—	.npmrc @uipath:registry (設定されている場合)、それ以外の場合は npm default
テレメトリ	—	UIPATH_TELEMETRY_DISABLED=1	enabled

env-var 列のない設定は、フラグを使用してコマンドごとにのみ設定できます。

設定例

最小限のCIランナー(env経由のすべて)

env:
  UIPATH_URL: https://cloud.uipath.com
  UIPATH_CLIENT_ID: ${{ secrets.UIPATH_CLIENT_ID }}
  UIPATH_CLIENT_SECRET: ${{ secrets.UIPATH_CLIENT_SECRET }}
  UIPATH_TENANT: Production
  UIPATH_TELEMETRY_DISABLED: "1"

steps:
  - run: npm install -g @uipath/cli
  - run: uip tools install @uipath/orchestrator-tool
  - run: uip tools install @uipath/solution-tool
  - run: |
      uip login \
        --client-id env.UIPATH_CLIENT_ID \
        --client-secret env.UIPATH_CLIENT_SECRET \
        --tenant "$UIPATH_TENANT"
  - run: uip or folders list

事前に発行されたトークンを含むコンテナー (env-var auth flow)

export UIPATH_CLI_ENABLE_ENV_AUTH=true
export UIPATH_CLI_AUTH_TOKEN="$BUILD_TOKEN"
export UIPATH_CLI_ORGANIZATION_NAME=contoso
export UIPATH_CLI_ORGANIZATION_ID="$ORG_UUID"
export UIPATH_CLI_TENANT_NAME=Default
export UIPATH_CLI_TENANT_ID="$TENANT_UUID"

uip or folders list

uip login手順もファイルも書き込まれません。すべてのコマンドは環境変数から認証されます。

参照

• 認証 — 認証フローと、それぞれが読み取る環境変数です。
• UiPath CLI をインストールする — プロキシ変数、テレメトリのオプトアウト、CI のインストール パターン。
• セッションと資格情報 — uip loginによって書き込まれた.uipath/資格情報フォルダーです。
• グローバルオプション — 呼び出しごとに環境変数をオーバーライドするフラグ。
• uip 構成 — .uipath/config.json ファイル、その完全なキー参照、およびそれを管理する get/set/clear コマンドです。