グローバル オプション

すべての 'uip' 呼び出しで受け入れられるグローバル オプションであり、出力形式、出力フィルター、ログ レベル、およびログ ファイルをカバーします。

すべての uip 呼び出しは、ツールやサブコマンドがその引数を見る前に、固定されたグローバルオプションセットについて事前にスキャンされます — それらはコマンドラインのどこにでも表示され、すべてのツールで同じように動作し、コマンドごとのフラグ解析の実行前に取り除かれます。

オプション	Short	値 (Value)	既定 (Default)	目的
--output	—	table、json、yaml、plain、markdown	json	stdout に書き込まれるプライマリ出力の形式。
--output-filter	—	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	—	パス	—	If set, logs are written to this file instead of stderr.
--profile	—	name	—	既定の資格情報の場所ではなく、名前付きで保存されているログイン プロファイルを選択します。コマンド自体の -f, --file <folder> と相互に排他的です (例: uip login、 、 uip login tenant list/set、 uip logout)。両方を渡すと が ValidationErrorです。「 セッションと資格情報」をご覧ください。
--interactive / --no-interactive	—	フラグ	自動 (TTY でのみプロンプト)	プロンプトのオン/オフを強制的に行え、既定の「TTY に接続されている場合にのみプロンプト」の動作を上書きします。特定のコマンドに固有のものではなく、 uip コマンドが質問するすべての場所 (たとえば、 uip login時のテナントの選択や、 uip skills installのエージェント/ターゲット ピッカーなど) を制御します。

--version (-v)と --help (-h)も uip およびすべてのサブコマンドで認識されますが、これらは上記の意味でのグローバルフラグではなく、標準のCLI規則です。

--output

出力形式を選択します。--output jsonと--output=jsonの両方が機能します。値では大文字と小文字が区別されます。

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 (既定) — stdout 上の 1 つの JSON ドキュメント。jq、--output-filter、および任意の JSON コンシューマーにより解析可能です。これは、端末が TTY であるかどうかに関係なく、すべての呼び出しのデフォルトです。
• table — 端末での読み取りに適した、縁取られた色付きの表。バージョン間で安定していない — 解析しないでください。
• yaml — jsonと同じ構造の YAML シリアライゼーション。
• plain — 平坦なkey=value線。jqをインストールせずにシェルread、grep、およびcutにパイプする場合に便利です。
• 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.

注:

既定値は jsonで、tableではありません。人間がターミナルで uip or folders list を実行すると、stdout に JSON ドキュメントが表示されます。--output tableを明示的に渡す (またはシェルエイリアスに追加して) 読みやすいビューにします。この選択により、ターミナルとパイプラインで同じstdout形状が維持され、スクリプトはインタラクティブに実行されているかどうかを気にする必要はありません。

--プロフィール

既定の資格情報の場所ではなく、名前付きで保存されているログイン プロファイルを選択します。

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> とコマンド自体の -f, --file <folder> は相互に排他的であり、両方を渡すと ValidationError: option '--profile' cannot be used with option '--file'で失敗します。プロファイル名は正規化されます (大文字と小文字の区切り文字のルールが適用されます)。無効な名前は、ネットワーク呼び出しの前に拒否されます。「 セッションと資格情報 — 指定ログイン プロファイル」をご覧ください。

--インタラクティブ / --no-interactive

既定の「stdout が TTY の場合にのみプロンプト」動作を上書きします。

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 プロンプトを常時オンに設定します。 --no-interactive 強制的にオフにします。どちらのフラグも uip login に固有のものではありません — このドキュメントセット全体のログイン例に登場しているにもかかわらず、インタラクティブ性は横断的なグローバルオプションであり、コマンド固有の短い形式はありません(CLIのどこにも --it または同様のエイリアスはありません)。

ストリームの分離

--output は stdout のみを制御します。ログ、進行状況インジケーター、および人間が直面するエラーは、形式に関係なく stderr に送られます。これは、パイプラインが次の方法でクリーンな JSON をキャプチャできることを意味します。

uip or folders list > folders.json 2> uip.log

…また、ログ出力は個別に表示されます。

--output-filter

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.

--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

不正な形式のフィルター式は、基になるコマンドが実行される前に ValidationError と終了コード 3 で高速に失敗するため、タイプミスによって 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.

ヒント:

--output-filter は、Azure CLI の --queryの CLI バージョン、AWS CLI の --query、および gcloud の --filter/--formatです。これらのツールで JMESPath をすでに知っている場合、構文は同じです。

--log-level

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

値では大文字と小文字が区別されません。不明な値は、エラーではなく、意図的に、ラッパースクリプトのタイプミスがパイプラインを壊さないように、暗黙のうちに無視されます(デフォルトは保持されます)。

UIPATH_LOG_LEVEL 環境変数は適用されません。フラグを渡すか、プロファイル スクリプトに設定します。

--log-file

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.

グローバル オプションが適用される場所

グローバルオプションは、コマンドごとのフラグが解析される前にコマンドラインから削除されるため、コマンドラインの任意の場所に表示できます。

uip --output table or folders list
uip or --output table folders list
uip or folders list --output table
uip or folders list --output=table

4 つの呼び出しはすべて同等です。

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.

終了コード

グローバルオプションは、出力とロギングのみを制御します。終了コードには影響しません。「終了コード」を参照してください。

環境変数の上書き

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

変数	効果
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 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.

コマンドのタイミング

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

フィールド	意味
(引用符で囲まれたコマンド)	入力されたコマンド。
exit	呼び出しが返した終了コード。
total	プロセス開始から測定された全壁時計。
startup	コマンド ハンドラーが実行される前のすべて (プロセスの起動、構成、ツールの読み込み)。
command	コマンド ハンドラー自体。
http	実行の送信 HTTP 呼び出しの合計時間です ( 合計であり、壁掛け時計ではありません)。加算するのではなく command 重なるため、並列呼び出しでは よりも大きく command。
httpCalls	この合計がカバーする送信 HTTP 呼び出しの数。
flush	ハンドラーが戻ってからのすべて (テレメトリの簿記と最終的なフラッシュ)。

startup + command + flush は常に totalと等しくなります。フィールドが適用されない場合は省略されます。ハンドラーに到達しない実行 (uip --version、不明なコマンド) は、 total と exitのみを出力します。HTTP 呼び出しを行わないコマンドには、 http も httpCallsもありません。

レポートには独自のスイッチがあります — --log-levelに依存しないため、デバッグ出力をオンにせずに期間を取得し、stdout には触れません。

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.

参照

• 出力形式 (テーブル、JSON、YAML) — 各形式の完全な例を含む、より詳細に説明されています。
• スクリプトパターン — 終了コード、ストリーム分離、再試行、ポーリング。
• uip login reference とその他のコマンドページ — これらのグローバルに加えて、コマンドごとのフラグを文書化します。