参照の概要

このリファレンスには、すべての uip コマンド、フラグ、および終了コードが記載されています。何をしたいかがわかっていて、正確な構文が必要な場合の検索として使用します。学習については、「 クイックスタート 」または 「UiPath CLI の構成方法」から開始してください。

参照の構成方法

参照は3種類のページに分かれています。

1. 横断 — ツールに関係なく、すべての uip 呼び出しに適用される動作。
2. コアコマンド — ホストが所有するコマンド(login、 logout、 tools、 skills、 mcp、 completion)。
3. ツールご と — インストール可能なツールごとに 1 つのセクション。各セクションには、概要に加えて、リソースごと (リソース優先ツールの場合) または動詞ごと (単一ワークフロー ツールの場合) ごとに 1 つのページがあります。

横断的

ページ	カバーされる内容
グローバル オプション	--output、 --output-filter、 --log-level、 --log-file — すべてのコマンドで使用できる4つのフラグ。
終了コード	5 段階のエグジットコード契約 (0 / 1 / 2 / 3 / 4) とユーザーのキャンセル 130 。

主要なコマンド

ホストが直接登録するコマンドです。ツールのインストールは必要ありません。

コマンド	目的
uip ログイン	対話型の OAuth2 セッションの開始、外部アプリとしての認証、テナントの切り替えを行います。
uip ログアウト	保存されている資格情報を削除します。
uip ログイン ステータス	現在のセッションの組織、テナント、および有効期限を表示します。
UIP ツール	インストール可能なツールを一覧表示、検索、インストール、更新、またはアンインストールします。
UIP スキル	コーディング エージェント (Claude Code、Cursor、GitHub Copilot、Gemini CLI、Codex、OpenCode) に UiPath のスキルをインストールします。
UIP MCP	MCP 対応クライアントのモデル コンテキスト プロトコルを介して uip コマンドを公開します。
UIP の完了	bash、zsh、fish、pwsh のシェルタブ補完をインストール、印刷、または削除します。

ツール

各ツールは、インストール可能な npm パッケージです。uip tools install <alias>を実行して追加するか、一度呼び出して自動インストールに任せてください。モデルについては 「ツール (プラグイン)」 を、それらを管理するコマンドについては「 uip ツール 」を参照してください。

エイリアス	ツール	参照
or	Orchestrator	uip または
platform	プラットフォーム (テナント ライセンス、ユーザー バンドル、グループ ルール、消費状況)	UIP プラットフォーム
solution	解決策	uip ソリューション
agent	オペレーター	UIP エージェント
flow	フロー (明示的なインストールのみ — 自動インストールのホワイトリストにはない)	UIP フロー
maestro	Maestro	UIP Maestro
tm	Test Manager	UIP TM
rpa	RPA (Studio のパッケージ化、アナライザー、復元)	UIP RPA
rpa-legacy	RPA レガシ — Windows のみの uipcli.exe ラッパー (debug、validate、find-activities、find-package、type-definition、package)	uip rpa-legacy
resource	リソース (アセット、キュー、バケット、トリガー、Webhook)	UIP リソース
is	Integration Service	uipは
codedagent	コード化されたエージェント	uip codedagent
codedapp	コード化されたアプリ	uip コード化されたアプリ
api-workflow	API ワークフロー	uip api-workflow
vss	バーティカルソリューション	UIP VSS
df	Data Fabric	UIP DF
insights	Insights	UIP インサイト
traces	トレース	UIP トレース
docsai	DocsAI	uip docsai

コマンド ページを読み取る方法

すべてのコマンドのリファレンス ページは、同じ構造に従います。

1. 書式 — 位置引数と共通フラグセットを示す1行のコマンド形状。
2. 説明 — コマンドが何をし、ワークフローのどこに適合するかに関する 1 つか 2 つの段落。
3. 引数 — 位置引数の表:名前、必須/オプション、目的。
4. オプション — 関心事(識別、フィルタリング、出力、動作)別にグループ化されたフラグの表。各行には、短い名前、長い名前、値の型、既定値、および 1 行の説明が表示されます。
5. 例 — 3つ以上の実用的な例:最小限、一般的なケース、スクリプトフレンドリー( --output-filter または明示的なJSON処理を使用)。
6. 終了コード — 終了コード へのポインターとコマンド固有のオーバーライド。
7. 関連コマンド — このコマンドで頻繁に使用されるコマンド。
8. 参照 — コマンドのコンテキストをカバーする概念とハウツーページ。

すべてのページは グローバル オプションを継承します。すべてのコマンドで繰り返されるわけではありません。

命名規則

• コマンド プレフィックス。uip は実行可能ファイルです。すべての例はそれから始まります。
• プレースホルダー。必須の値<angle-brackets>、任意の値[square-brackets]。実際の値に置き換えてください。
• 短いフラグ。フラグが短い形式(たとえば、--tenantの場合は-t)の場合、両方がオプションテーブルに一緒にリストされます。例では、読みやすくするために長い形式を使用しています。
• JSON のサンプル。--output json がデフォルトです。出力を示す例では、関係のないフィールドは … で省略され、フォーカスが維持されます。
• バージョンノート。[プレビュー] というラベルの付いたコマンドまたはフラグは、メジャー バージョンのバンプなしで変更される場合があります。非推奨というラベルの付いたコマンドは、少なくとも 1 つの MAJOR サイクルの間、機能し続けます。「バージョン管理と安定性」をご覧ください。