uipath-platform

UiPath Platform — uip CLI アシスタント

UiPath Cloud ／ Orchestrator ／ Studio Web ／ Integration Service を、uip CLI でエンドツーエンドに利用するための包括的なガイドです。uip solution のライフサイクルについては uipath-solution を読み込み、PDD／SDD の設計とタスク計画については uipath-planner を読み込んでください。

プラットフォームで作業する前に、診断が必要か判断する

コマンドを実行する前に、依頼された結果を分類してください。

1. 原因の究明が必要な結果 → ただちに引き継ぎます。 ユーザーが既存の望ましくない動作について説明、診断、根本原因の特定を求めている場合は、何も実行する前に uipath-troubleshoot の Skill ツール（利用可能なスキルの一覧に記載されている名前をそのまま使用）を呼び出してください。事前にジョブ／ログ／トレースを取得しないでください。証拠の収集は troubleshoot が担当します。ユーザーに troubleshoot を使うよう文章で案内するだけでは、Skill の呼び出しの代わりになりません。
2. 運用上の結果 → ここで対応します。 原因を問わずに現在の状態を調べる、CRUD 操作やライフサイクル操作を行う、適用前に入力を検証する、または診断済みのプラットフォーム修正を実行する場合です。
3. 複合的な依頼 → まず troubleshoot に引き継ぎます。 診断を引き継ぎ、確認済みの修正を適用するプラットフォーム変更のみ、ここで対応します。
4. 関連スキルが利用できない場合 → 可能な範囲で対応します。 引き継ぎを実行できなかったことを伝え、調査を再試行するために必要なエンティティ、対象範囲、期間を示してください。プラットフォームの情報だけで根本原因を推測しないでください。

CLI を使ってください。独自に REST を実装しないでください。

まず必ず uip CLI コマンドを使ってください。 CLI は、認証、Orchestrator（フォルダー、プロセス、ジョブ、マシン、ユーザー、ロール、セッション、カレンダー、設定、監査ログ、資格情報ストア、フィード、添付ファイル）、リソース（アセット、キュー、キューアイテム、ストレージバケット、バケットファイル、ライブラリ、Webhook、トリガー）、Integration Service（コネクタ、接続、アクティビティ、IS トリガー）、トレース、ライセンスをエンドツーエンドでカバーします。

HTTP 呼び出しを独自に実装する方法（~/.uipath/.auth を読み取り、/odata/... や /orchestrator_/... に POST する方法）では、ほとんどの場合、CLI が正しく処理する要素を見落とします。たとえば、フォルダーの X-UIPATH-OrganizationUnitId ヘッダー、OData フィルターの形式（エスケープした一重引用符を使う Key eq '...'）、ページネーションのエンベロープ、再試行のセマンティクス、検証エラーの形式、Result/Code/Data の出力規約などです。タスクについて references/uip-commands.md を検索し、対応する uip コマンドがないと確認してから、未加工の REST を使ってください。 CLI が信頼できる情報源です。

curl で https://cloud.uipath.com/... を呼び出そうとしているなら、そこで止めてください。まずコマンドインデックスを検索してください。よく見落とされる例を以下に示します。

• 「ファイルをストレージバケットにアップロードする」→ uip or bucket-files upload（PUT /buckets/.../signedUrl を使う手順ではありません）
• 「アセットを作成する」→ uip or assets create（POST /odata/Assets ではありません）
• 「プロセスのジョブを開始する」→ uip or jobs start <process-key>（POST /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs ではありません）
• 「Integration Service の接続を構成する」→ uip is connections create <connector-key>（独自に OAuth フローを実装するのではありません）
• 「Data Fabric のレコードにファイルを添付する」→ uip df files upload <entity-id> <record-id> <field-name> --file <path>（ファイル値を指定して records insert ／ records update を実行するのではありません。プラットフォームは FILE 列を通知なく削除し、Success を返します。references/data-fabric/data-fabric.md のルール 6 を参照してください）

新しいマシンのための CLI ブートストラップ

uip --version が失敗する場合、Node/npm が見つからない場合、またはコーディングエージェントのために UiPath 用のワークステーションを準備する必要がある場合は、パッケージマネージャーの処理を独自に再構築するのではなく、公式のオンボーディングインストーラーを使用してください。これらは冪等で、安全に再実行できます。

macOS/Linux：

curl -fsSL https://download.uipath.com/uipath-cli/install.sh | bash

Windows PowerShell：

irm https://download.uipath.com/uipath-cli/install.ps1 | iex

インストーラーは次の処理を行います。

• Node.js >= 20 と npm があることを確認します。
• 公開 npm から @uipath/cli をインストールします。
• uip skills install --no-interactive を実行し、インストール済みの AI コーディングエージェント（Claude Code、Codex、Gemini CLI、Cursor など）が UiPath スキルを使用できるようにします。
• RPA、コードベースのエージェント、ツールのワークフロー向けに、.NET SDK 8.0 と Python 3.11-3.14 を可能な範囲でインストールします。

エージェントスキルとランタイムが不要な CI または CLI 専用マシンでは、明示的にスキップしてください。

curl -fsSL https://download.uipath.com/uipath-cli/install.sh | bash -s -- --skip-skills --skip-runtimes

iwr https://download.uipath.com/uipath-cli/install.ps1 -OutFile install.ps1
./install.ps1 -SkipSkills -SkipRuntimes

便利なフラグ：macOS/Linux では --skip-node、--skip-skills、--skip-dotnet、--skip-python、--skip-runtimes、--dry-run、Windows では -SkipNode、-SkipSkills、-SkipDotnet、-SkipPython、-SkipRuntimes、-DryRun が使えます。対応する環境変数は UIP_SKIP_NODE、UIP_SKIP_SKILLS、UIP_SKIP_DOTNET、UIP_SKIP_PYTHON、UIP_SKIP_RUNTIMES、UIP_DRY_RUN です。

このスキルを使用するタイミング

UiPath とやり取りするコードを書く前に、このスキルを読み込んでください。具体的なトリガー：

• CLI のブートストラップ／ワークステーションのセットアップ：新しいマシンで uip が見つからない、Node/npm が見つからない、Python または .NET SDK が見つからない、あるいは LLM コーディングエージェントに UiPath スキルをインストールする必要がある場合

• 認証とテナント：ログイン、ログアウト、テナントの切り替え、--profile <name> による名前付きログインプロファイル、~/.uipath/.auth、OAuth トークン、組織

• Orchestrator のコア機能：フォルダー（list/get/create/edit/move/delete/runtimes）、プロセス／リリース、ジョブ（start/stop/logs/traces/healing-data）、パッケージ（upload/download/versions）、マシン、ユーザー／ロール／セッション（DirectoryUser/DirectoryGroup/DirectoryRobot/DirectoryExternalApplication を含む）、ライセンス、カレンダー、設定、監査ログ、資格情報ストア、フィード、添付ファイル

• リソース（Orchestrator スコープ）：アセット（テキスト／整数／ブール値／資格情報）、キューとキューアイテム、ストレージバケットとバケットファイル（upload/download/get-download-url/get-upload-url）、ライブラリ（.nupkg）、Webhook（HMAC 署名）、トリガー（時間／キュー／API）

• Integration Service：コネクター、接続（OAuth フロー）、アクティビティ、IS トリガー、エージェントワークフローの参照解決

• **Data Fabric **：UiPath の構造化された型付きデータストアです。 **⛔ 停止 — uip df コマンドを実行する前に、references/data-fabric/data-fabric.md を必ず読んでください。このリファレンスには、重要なルール（フォルダースコープのプロンプトフロー、取り消し不能な操作のゲート、複雑なフィールドの設定）、リクエストボディのスキーマ、型ごとの演算子一覧、トピック別ファイルへのリンクが記載されています：entity-schema.md、federated-entity-creation.md（フェデレーション／仮想データオブジェクト／ゼロコピーエンティティ — コネクターまたは別のエンティティを基盤とするもの）、records-query.md、filter-platform-contract.md、choice-sets.md、file-attachments.md、bulk-import.md。機能：

  • エンティティ — 型付き列、型ごとの制約（lengthLimit、minValue／maxValue、decimalPrecision）、選択肢セット／リレーションシップ／ファイルフィールド、および addFields／updateFields／removeFields によるスキーマの変更。
  • レコード — 挿入／更新／削除／一覧表示／取得／query。サーバー側のフィルター、並べ替え、ページネーション、グループ化、集計（COUNT、SUM、AVG、MIN、MAX）に対応しています。
    • DF フィルターボディでは filterGroup.queryFilters[] を使用します — 完全な形式は records-query.md を参照してください。
  • ファイル — FILE 型フィールドに保存されたバイナリ添付ファイル。files upload / download / delete を使用します（レコードレベルの書き込みでは FILE 値が通知なく除去されるため、専用の動詞が必須です）。
  • 選択肢セット — CHOICE_SET_SINGLE／CHOICE_SET_MULTIPLE フィールドで使用する共有列挙型です。値にはラベルではなく、変更不可の整数 NumberId を使用します。
  • フォルダースコープ — テナントレベルまたはフォルダースコープ。書き込みのたびに --folder-key <GUID> を指定し、entities list／choice-sets list では --include-folders を指定します。
  • CSV 一括インポート — uip df records import <entity-id> --file <path.csv> --output json。基本的なフィールド型のみ対応します。複雑なフィールド（CHOICE_SET、RELATIONSHIP、FILE、AUTO_NUMBER）には records insert --file <json> が必要です。

  .flow 内の Query／Create／Update／Delete／GetById コネクタノードには、uipath-maestro-flow スキルを使用してください。このスキルが、フロー内ノードの JSON、bindings_v2.json、接続リソースのレイアウトを担当します。

• LLM Gateway — BYO 製品構成：uip llm-configuration byo-connections（list / get / create / update / delete / list-product-configs）。テナントが所有する OpenAI / Azure OpenAI / AWS Bedrock / Google Vertex / Anthropic / OpenAI-compatible のキーを、UiPath 製品の機能（agents、agenthub、jarvis、IXP、agent builder、ECS）に登録します。入力形式は 2 種類です。単一マッピング（AnyModelWithOwnAdditions 機能向け）と、繰り返し指定する --mapping（AllModels / AnyModel 向け。必須）です。サーバー側での検証が必須です。

• LLM Gateway — 失敗する BYO 構成の診断：byo-connections get <id> --force-refresh で基盤となる IS 接続を再プローブし、冪等な update でサーバー側の新しいプローブを強制し、list --include-connection-details を connectionState != Enabled でフィルタリングしてテナントを監査し、list-product-configs でカタログの差分を確認し、uip traces spans get <trace-id> でトレースの証跡と照合します。ゲートウェイは CLI 経由でリクエストごとの呼び出しログを公開しません。診断には現在の状態とトレースの証跡のみを使用します。references/llmgateway/byo-connections.md § Diagnostics を参照してください。ルーティングを上書きしている可能性のある、テナント全体に適用される AI Trust Layer ポリシーについては、uipath-governance を参照してください。

• AI Trust Layer — BYO ガードレール（BYOG）構成：uip guardrails byo-configurations（list / list-validators / probe / create / update / delete）— Integration Service 接続をそれぞれバックエンドとする、テナントに登録済みの外部ガードレールバリデータープロバイダー（例：Azure AI Content Safety、Databricks AI Guardrails）を管理します。ValidatorName はテナント内で一意で、エージェントが参照する唯一の値です（ByoValidator(<ValidatorName>) — 接続はサーバー側で解決されます）。作成前に list（名前が未使用であること）と uip is connections list（--connection-id 用）を実行してください。create は常に接続とバリデーターの組み合わせをサーバー側でプローブし、プローブに失敗すると中止します。スキップするオプションはありません。update は --connection-id が変更されるたびに再プローブします。probe と list-validators は保存せずに組み合わせをテストします。update は指定したフィールドをマージし、--enabled / --disabled を切り替えられます。delete には --force が必要です。get 動詞はありません。references/guardrails/byo-configurations.md を参照してください。これらの構成のいずれかに対するガードレールの作成（ローコードまたはコードによる）については、uipath-agents を参照してください。

• トレース：uip traces spans get <trace-id>（LLM／エージェント実行の可観測性）

• コンテキストグラウンディング：セマンティック検索／RAG 用のナレッジインデックス — uip context-grounding（バケットまたは接続からの list / create ／ 取り込み状況をポーリングするための / ingest / retrieve ／ / search / delete）。エージェントとフローは、これらのインデックスをツールとして使用します。references/context-grounding/index-management.md を参照してください。

• プラットフォームライセンス：テナントのライセンス割り当て、ユーザー／グループへのバンドル割り当て、消費量レポート（uip platform tenants licenses、users licenses、groups rules、licenses consumables get — 消費量に関する唯一の動詞。summary/daily/folders は --mode の値です）

• CLI ツール自体：uip tools list/search/install、uip mcp serve

uip solution のライフサイクル（init / pack / publish / deploy / activate / upload）と、UiPath ソリューションをビルドしてデプロイする CI/CD パイプラインについては、uipath-solution を読み込んでください。

認証トークンの保存場所

デフォルトのログインでは、認証情報は ~/.uipath/.auth に保存されます。

UIPATH_URL=https://cloud.uipath.com
UIPATH_ORGANIZATION_NAME=my_org
UIPATH_TENANT_NAME=my_tenant
UIPATH_ACCESS_TOKEN=eyJ...
UIPATH_ORGANIZATION_ID=...
UIPATH_TENANT_ID=...

名前付きプロファイルでは、認証情報は ~/.uipath/profiles/<name>/.auth に保存されます。同じマシンで複数の UiPath ログインを維持するようユーザーから求められた場合は、名前付きプロファイルを使用してください。

uip login --profile dev --output json
uip login status --profile dev --output json
uip login which --profile dev --output json

ルール：

• --profile <name> はグローバルオプションです。そのログインを使用する各 uip コマンドに指定してください。例：uip --profile dev or folders list --output json。
• default は組み込みのプロファイル未指定のログインを意味し、~/.uipath/.auth に対応します。
• プロファイル名には、英字、数字、., _, - のみ使用できます。../prod のようなパスは使用しないでください。
• --profile と認証コマンドの --file <folder> は同時に使用できません。どちらか一方を使用してください。
• 名前付きプロファイルが見つからない場合、~/.uipath/.auth や Robot の認証情報にはフォールバックしません。uip login --profile <name> を実行するようユーザーに伝えてください。

これらのトークンは、CLI コマンドで対応できないユースケースにおいて、Orchestrator REST API を直接呼び出す際にも再利用できます。名前付きプロファイルが有効な場合は、~/.uipath/.auth と決めつけず、uip login which --profile <name> --output json からパスを取得してください。

クイックスタート

ステップ 0 — CLI が存在することを確認する

まず確認してください。

uip --version

コマンドが見つからない場合は、新しいマシンでの CLI ブートストラップに記載されている公式インストーラーを使用し、インストーラーによって PATH エントリが追加された場合は、新しいシェルを開いてください。

ステップ 1 — 認証する

Orchestrator、ソリューション、または Integration Service を利用する前に、ユーザーはログインしている必要があります。

必ず最初に確認してください — ほとんどのセッションでは、すでに認証済みです。

uip login status --output json

Logged in と表示された場合は、このステップの残りをスキップしてください。--check フラグはありません — 確認には status サブコマンドを使用します。

ユーザーがプロファイルを指定した場合は、そのプロファイルを明示的に確認してください。

uip login status --profile dev --output json

対話型ログイン（ブラウザー OAuth2）： uip login はユーザーのマシンでブラウザーウィンドウを開き、ユーザーがログインを完了するまで処理をブロックします。--no-browser の有無にかかわらず、対話型ログインを自分のシェルツール経由で実行しないでください。 エージェントが実行すると、サインインが必要な人にはスピナーしか表示されません。出力された URL とブロック中の待機状態は、ユーザーの目の前ではなく、ツール出力に表示されます。--no-browser を指定してもエージェントが実行できるコマンドにはなりません。このオプションは、URL を_自分で_開く自動化のためのもので、サインインのコールバックが届くまで処理はブロックされます。また、出力された URL をコピーして貼り付けて中継する方法は不安定です。折り返されたり途中で切れたりした URL は ID サーバーに拒否され、ブラウザー側で原因の分からないエラーが発生します。代わりに、ユーザー自身のターミナルでコマンドを直接実行するよう依頼してください — Claude Code では、先頭に ! を付けるとセッション内で実行できます。

! uip login

完了したとユーザーから連絡があったら、uip login status --output json で確認してください。再試行時に EADDRINUSE / 「Port 8104 is already in use」エラーが発生する場合は、以前の試行がコールバックポートを占有したままになっています。ポートは 5 分以内に解放されます。または、ユーザーが古い uip login プロセスを終了できます。

名前付きプロファイルで対話型ログインする場合：

uip login --profile dev --output json

カスタムのオーソリティ（Automation Suite、専用ホスト、またはその他のデフォルト以外のホスト）を使用する場合：

uip login --authority "<AUTHORITY_URL>" --it --output json

非対話型（CI/CD）のシナリオでは、環境変数から読み込んだクライアント認証情報を、CLI の env.<NAME> 構文で使用してください。シークレットをチャットに貼り付けたり、コマンドラインに入力したりするようユーザーに求めないでください。

uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant "<TENANT>" --output json

ステップ 2 — テナントを選択する

使用可能なテナントを一覧表示し、アクティブなテナントを設定します。

uip login tenant list --output json
uip login tenant set "<TENANT_NAME>" --output json

ステップ 3 — Orchestrator を確認する

現在の状況を把握するため、フォルダーを一覧表示します。

uip or folders list --output json

ステップ 4 — Orchestrator リソースを操作する

以下のタスクナビゲーション表から、適切な操作を選択してください。uip solution の操作では、uipath-solution を読み込んでください。

タスクナビゲーション

必要な作業	参照先
認証する／テナントを管理する	references/uip-commands.md
フォルダー、ユーザー、マシンをセットアップする	references/orchestrator/setup-environment.md
ジョブを実行して監視する	references/orchestrator/run-jobs.md
セッションとランタイムを管理する	references/orchestrator/manage-sessions.md
テナントの設定、カレンダー、監査ログ	references/orchestrator/tenant-admin.md
Orchestrator の概念を理解する	references/orchestrator/orchestrator.md
アセットを管理する	references/orchestrator/manage-assets.md
キューとキューアイテムを操作する	references/orchestrator/process-queues.md
プロセスまたはキューのビジネス ROI を設定／読み取る	references/orchestrator/business-roi.md
ストレージバケットとファイルを操作する	references/orchestrator/work-with-storage.md
トリガーとウェブフックをセットアップする	references/orchestrator/triggers-and-webhooks.md
ジョブ／キューアイテムをポーリングする、ログをエクスポートする、429 に対処する、またはフィールドサイズの上限を確認する	references/orchestrator/api-limits.md
ソリューションを開発／パック／公開／デプロイ／アクティブ化する。CI/CD をセットアップする	/uipath:uipath-solution
公開済みエージェントでランタイム評価を実行する	/uipath:uipath-agents
LLM／エージェントのトレース（スパン）をデバッグする	references/traces/traces.md
フィードバックでトレースに注釈を付ける	references/traces/feedback.md
Integration Service を使用する	references/integration-service/integration-service.md
Data Fabric を使用する — エンティティ、レコード、ファイル、選択肢セット	references/data-fabric/data-fabric.md
エンティティスキーマを構築する／フィールドを追加する／複合フィールド型を扱う	references/data-fabric/entity-schema.md
コネクタまたは別のエンティティからフェデレーションエンティティ（別名：仮想データオブジェクト／ゼロコピー）を作成／更新する	references/data-fabric/federated-entity-creation.md
レコードをクエリする — フィルター、ページネーション、集計、選択肢／リレーションシップのセマンティクス	references/data-fabric/records-query.md
フィールド型ごとのフィルター演算子サポートマトリックス	references/data-fabric/filter-platform-contract.md
選択肢セットと選択肢セットの値を管理する	references/data-fabric/choice-sets.md
レコードのファイル添付をアップロード／ダウンロード／削除する	references/data-fabric/file-attachments.md
CSV からレコードを一括インポートする	references/data-fabric/bulk-import.md
BYO LLM キー（OpenAI／Azure OpenAI／Bedrock／Vertex／Anthropic）を設定する	references/llmgateway/byo-connections.md
BYO LLM 設定を診断／監査／再プローブする	references/llmgateway/byo-connections.md#diagnostics
BYO ガードレール（BYOG）設定を管理する（一覧表示／作成／更新／削除）	references/guardrails/byo-configurations.md
接続で BYOG バリデーターを実行できるかテストする（probe／list-validators）	references/guardrails/byo-configurations.md#validation-mandatory-before-save
BYO ガードレールを診断する（接続切れ、無効な設定）	references/guardrails/byo-configurations.md#diagnostics
テナントにライセンスを割り当てる	references/licensing/tenant-allocations.md
ユーザー／グループのライセンスバンドルを割り当てる	references/licensing/user-licenses-allocations.md
ライセンス消費量をレポートする	references/licensing/consumables-report.md
ライセンスの概念を理解する	references/licensing/licensing.md
ライセンスに関する症状を診断する	references/licensing/diagnose/CAPABILITY.md
CLI コマンドの完全なリファレンス	references/uip-commands.md
uip、Node、Python、.NET、エージェントスキルをブートストラップする	新しいマシン向けの CLI ブートストラップ
コード化されたワークフローを構築／実行／検証する	/uipath:uipath-rpa

UiPath Studio の解決

プロジェクトの作成、検証、ワークフローの実行、パッケージ化などの操作には、UiPath Studio が必要です。Studio が必要な場合は、次の手順に従ってください。

1. まず、実行中のインスタンスを確認します。

   uip rpa instances list --output json
   

2. 実行中のインスタンスがない場合は、標準のインストール先を確認します。

   uip rpa studio start --output json
   

3. それでも見つからない場合（バージョンが古い、見つからないなど）は、Studio のビルドの場所をユーザーに尋ねてください。 ファイルシステム全体を検索してはいけません。一般的な場所は次のとおりです。

   • C:\Program Files\UiPath\Studio
   • 開発ビルドのディレクトリ（例：dev4/Studio/Output/bin/Debug）
   • カスタムのインストールパス

4. パスがわかったら、明示的に指定して渡します。

   uip rpa studio start --studio-dir "<STUDIO_DIR>" --output json
   

Studio を自動で探すのに時間をかけてはいけません。 デフォルトの場所で見つからない場合は、すぐに尋ねてください。ユーザーは自分のビルドの場所を把握しています。

主な概念

UiPath プラットフォームの階層

Organization
  └── Tenant(s)
        └── Folder(s)              ← Orchestrator folders (logical containers)
              ├── Processes         ← Published automation packages
              ├── Assets            ← Key-value configuration (Text, Bool, Integer, Credential, Secret)
              ├── Queues            ← Work item queues for distributed processing
              ├── Jobs              ← Running/completed process executions
              ├── Triggers          ← Event-based or queue-based job triggers
              ├── Schedules         ← Time-based job scheduling (cron)
              ├── Storage Buckets   ← File storage for automation data
              ├── Machines          ← Robot execution environments
              └── Robots            ← Attended/Unattended execution agents

Robot の種類

種類	説明	用途
Attended	人間のユーザーと並行して実行され、UiPath Assistant を通じてトリガーされます	フロントオフィス業務、ユーザー支援型の自動化
Unattended	仮想環境で自律的に実行され、Orchestrator によって管理されます	バックオフィス業務、スケジュール処理、24 時間 365 日の運用

フォルダーの種類

種類	説明
Standard	自動化を整理するためのデフォルトのフォルダー
Personal	ユーザー専用のワークスペース
Virtual	物理的に分離せずに論理的にグループ化します
Solution	ソリューションのデプロイによって作成されるフォルダー
DebugSolution	ソリューションフォルダーのデバッグ用バリエーション

アセットの種類

種類	説明
Text	プレーンテキスト値
Bool	ブール値（true/false）
Integer	整数値
Credential	ユーザー名とパスワードの組み合わせ
Secret	暗号化されたシークレット値
DBConnectionString	データベース接続文字列
HttpConnectionString	HTTP 接続文字列
WindowsCredential	Windows 認証情報の組み合わせ

CLI の概要

UiPath CLI（uip）は、UiPath プラットフォームを操作するための統合コマンドラインツールです。

コマンドグループ	プレフィックス	説明	ステータス
認証	login, logout	OAuth2、クライアントクレデンシャル、PAT、テナント管理	利用可能
Orchestrator	or	フォルダー、ジョブ、プロセス、リリース	利用可能
リソース	resource	アセット、キュー、キュー項目、ストレージバケット、バケットファイル	利用可能
Integration Service	is	コネクタ、接続、アクティビティ、リソース	利用可能
Data Fabric	df	エンティティ、レコード、ファイル、選択肢セット（@uipath/data-fabric-tool）	利用可能
ツール	tools	CLI ツールの拡張機能管理	利用可能
MCP	mcp	Model Context Protocol サーバー	利用可能
コーディングエージェント	codedagent	Python エージェントのライフサイクル（セットアップ、実行）	利用可能
RPA	rpa	RPA ワークフロー管理（作成、コンパイル、検証、実行）	利用可能

グローバルオプション

すべての uip コマンドで、次のオプションを使用できます。

オプション	説明	デフォルト
--output <format>	出力形式：table、json、yaml、plain	table（対話型）、json（非対話型）
--output-filter <expression>	JSON 出力をフィルタリングする JMESPath 式	--
--profile <name>	~/.uipath/profiles/<name>/.auth の名前付き認証プロファイルを使用	組み込みのデフォルトログイン
--verbose	詳細／デバッグログを有効にする	オフ
--help / -h	コマンドのヘルプを表示する	--
--version / -v	CLI のバージョンを表示する	--

uip コマンドをプログラムから呼び出す場合は、必ず --output json を使用してください。JSON はコンパクトで、機械可読です。

list の結果を絞り込むには、名詞に固有のフィルターフラグ（--state Faulted、--type Text、--status New、--name、--process-name、--search）を使用してください。バックエンド側で送信前にフィルタリングされるため、ページネーションも正しく保たれます。名詞ごとのフラグについては、references/uip-commands.md を参照してください。すべてを一覧表示してから手作業で絞り込む方法は避けてください。

--output-filter（JMESPath）は、出力の整形やサーバー側のフラグがないフィールドに使用してください。たとえば、--output-filter "[].{id: Id, name: Name}" のように指定したり、派生値／計算値でフィルタリングしたりできます。サーバーにすでにその属性のフィルターがある場合は、こちらを使わないでください。フィルターが何も返さない原因が2つあります。どちらの場合も、JMESPath は一致なしをエラーなしで報告するため、フィルターが何も返さないように見えます。式は Data ペイロードに対して評価されるため、Data の内側から始め、Data 自体を指定しないでください。Data 内の Data キーを探してしまう Data[].Key ではなく、[].Key と記述します。また、フィールドの参照では、CLI がフィルタリング前にキーを PascalCase に変換するため、大文字と小文字が区別されます。生の大文字・小文字を保持する一部のコマンド（maestro flow registry get、api-workflow registry、会話型コマンド）を除き、displayName ではなく DisplayName を指定してください。

デプロイに関する注意事項

• ジョブの開始にはランタイムが必要です。 エラー 2818「ランタイムが設定されていません」が表示された場合、対象フォルダーに、Unattended／Development ランタイムが割り当てられたマシンテンプレートが必要です。
• uip solution の pack／publish／deploy／activate フローでは、uipath-solution を読み込んでください。 これらのフローで必要な認証と Orchestrator の機能はこのスキルが担当し、ライフサイクルコマンドは solution スキルが担当します。
• 代替手段：REST API を直接使用する。 CLI ツールが操作に対応していない場合は、~/.uipath/.auth のアクセストークンを使用して Orchestrator REST API を呼び出してください。references/orchestrator/orchestrator.md - REST API を参照してください。
• Orchestrator は、一部のエンドポイントに対するテナント単位のレート制限を設けています。 フィルター付きの jobs list／queue-items list 呼び出しには1分あたりの上限があり、jobs logs／audit-logs list の --export には1日あたり100回の上限があります。CLI は 429（ErrorCode: rate_limited）を再試行しません。これらのコマンドを使ったポーラー、ループ、スクリプトを作成する前に、references/orchestrator/api-limits.md をお読みください。

参考資料

• CLI コマンドリファレンス — ワークフローへのリンク付きで、すべての uip コマンドを紹介します

• Orchestrator — 概念、フォルダー、ジョブ、プロセス、マシン、ユーザー

• リソース — アセット、キュー、バケット、トリガー、ライブラリ、Webhook

• Orchestrator API の制限 — テナントごとのレート制限、エクスポートの割り当て、429 の処理、フィールドサイズの上限

• ソリューション — ソリューションのライフサイクル（uip solution init/pack/publish/deploy/activate）

• Planner — PDD/SDD の設計とマルチスキルのタスク計画（プロセス → ソリューション設計ドキュメント → タスクリスト）

• トレース — スパン — LLM 実行トレースの可観測性

• トレース — フィードバック — トレースに感情とコメントを注釈として追加します

• Integration Service — コネクター、接続、アクティビティ、リソース

• Data Fabric — エンティティスキーマ、レコードの CRUD、クエリフィルターと集計、選択肢セット、ファイル添付、CSV 一括インポート、フォルダーのスコープ設定

• LLM Gateway — BYO 接続 — テナント所有の LLM キーを UiPath 製品に登録します

• ガードレール — BYOG 設定 — テナントに登録された BYOG（bring-your-own guardrail）設定を管理し、その基盤となる Integration Service 接続の問題を診断します

• ライセンス — テナントの割り当て、ユーザー／グループのバンドル、消費量レポート、診断

• コード化されたワークフロー — コード化された自動化プロジェクトの構築

お困りですか？ 期待どおりに動作しない場合は、/uipath-feedback を使ってレポートを送信してください。