グローバル オプション

ツールまたはサブコマンドに関係なく、 uip 呼び出しごとに 4 つのオプションが認識されます。出力形式、出力フィルター、およびログ ストリームを制御します。他のすべてのフラグはコマンドごとに定義されます。

オプション	Short	値 (Value)	既定 (Default)	目的
--output	—	table、json、yaml、plain	json	stdout に書き込まれるプライマリ出力の形式。
--output-filter	—	JMESPath 式	—	書式設定前に JSON ペイロードに適用されるポスト フィルター。
--log-level	—	debug、info、warn、error	info	stderr に書き込まれるログメッセージの詳細度 (設定されている場合は --log-file )。
--log-file	—	パス	—	設定すると、ログは JSON 行形式でこのファイルに複製されます。

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

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

注:

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

ストリームの分離

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

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

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

--output-filter

書式設定する前に、 JMESPath 式を JSON ペイロードに適用します。フィルターは完全な応答エンベロープで実行されるため、 Data[*].Name Data 配列から名前を選択し、 length(Data) カウントを返します。

# just the Data field
uip or folders list --output-filter "Data"

# folder names only
uip or folders list --output-filter "Data[*].Name"

# count
uip or folders list --output-filter "length(Data)"

# first folder's key and name
uip or folders list --output-filter "Data[0] | {key: Key, name: Name}"

--outputとの組み合わせ:

# names as YAML
uip or folders list --output-filter "Data[*].Name" --output yaml

# names as one-per-line plain text
uip or folders list --output-filter "Data[*].Name" --output plain

不正な形式のフィルター式は、基になるコマンドが実行される前に ValidationError と終了コード 3 で高速に失敗するため、タイプミスによって API 呼び出しが無駄になることはありません。

ヒント:

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

--log-level

ログ メッセージの詳細度を設定します (指定されている場合は stderr と --log-file に書き込まれます)。

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

ログ ストリームの複製を JSON 行形式で、指定したファイルに書き込みます (1 行に 1 つの JSON オブジェクト)。ファイルは 追加されます — 実行ごとに個別のログが必要な場合は、ビルド固有のパスを使用します。

uip or folders list --log-file ./uip.log
uip or folders list --log-file /var/log/uip/$(date +%F).log --log-level debug

ファイル内の各行は次のようになります。

{"time":"2026-04-24T18:42:00.123Z","level":"info","message":"CLI v1.0.0 starting — output=json, logLevel=info, logFile=./uip.log"}

この形式は、ログの荷送人 (Fluent Bit、Loki、Splunk) および事後分析用に設計されています。

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

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

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 つの呼び出しはすべて同等です。

ツールのサブコマンドは 、 独自の --output や --log-levelを定義しません。誤ってグローバルフラグを定義したツールは、グローバルフラグをシャドーします — CLI の lint チェックはこれを禁止しています。

終了コード

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

参照

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