uipath-cli
latest
false
UiPath CLI ユーザー ガイド
- 概要
- はじめに
- 概念
- UiPath CLI を使用する
- 使用ガイド
- CI/CD レシピ
- コマンド リファレンス
- 概要
- 終了コード
- グローバル オプション
- uip codedagent
- UIP コーダー
- UIP のコンテキスト グラウンディング
- uip docsai
- uip 関数
- UIP ガードレール
- uip llm - 構成
- uip llm-gateway
- uip model-hub
- add-test-data-entity
- テスト データのキューを追加
- 追加-テスト-データ-バリエーション
- 分析
- 開発
- プロジェクトを作成
- 差分
- アクティビティを検索
- GET-ANALYZER-RULES
- get-default-activity-xaml
- エラーを取得
- 手動テスト用のテスト ケースを取得
- 手動テストステップを取得
- get-library-object-repository
- オブジェクト リポジトリを取得
- get-versions
- Get-workflow-example
- indicate-application
- 要素を示す
- inspect-package
- install-data-fabric-entities
- パッケージのインストールまたは更新
- list-data-fabric-entities
- リスト - インスタンス
- list-workflow-examples
- パッケージ化
- パブリッシュ
- リモート
- 元に戻す
- 実行、デバッグ、実行
- ファイル名を実行
- 検索テンプレート
- スタートスタジオ
- 実行を停止
- TM
- UIA
- UIP タスク
- uip traces
- UIP トレースのフィードバック
- 移行
- 参照とサポート
重要 :
このコンテンツは機械翻訳によって処理されています。
新しいコンテンツの翻訳は、およそ 1 ~ 2 週間で公開されます。
すべての 'uip' コマンド、フラグ、および終了コードの参照インデックスをツール別に整理し、リンクされたページに分割します。
このリファレンスには、すべての uip コマンド、フラグ、および終了コードが記載されています。何をしたいかがわかっていて、正確な構文が必要な場合の検索として使用します。学習については、「 クイックスタート 」または 「UiPath CLI の構成方法」から開始してください。
参照の構成方法
参照は3種類のページに分かれています。
- 横断 — ツールに関係なく、すべての
uip呼び出しに適用される動作。 - コアコマンド — ホストが所有するコマンド(
login、logout、tools、skills、mcp、completion)。 - ツールご と — インストール可能なツールごとに 1 つのセクション。各セクションには、概要に加えて、リソースごと (リソース優先ツールの場合) または動詞ごと (単一ワークフロー ツールの場合) ごとに 1 つのページがあります。
横断的
| ページ | カバーされる内容 |
|---|---|
| グローバル オプション | --output、 --output-filter、 --log-level、 --log-file — すべてのコマンドで使用できる4つのフラグ。 |
| 終了コード | 5 段階のエグジットコード契約 (0 / 1 / 2 / 3 / 4) とユーザーのキャンセル 130 。 |
主要なコマンド
ホストが直接登録するコマンドです。ツールのインストールは必要ありません。
| コマンド | 目的 |
|---|---|
| uip login | 対話型の OAuth2 セッションの開始、外部アプリとしての認証、テナントの切り替えを行います。 |
| uip logout | 保存されている資格情報を削除します。 |
| uip login status | 現在のセッションの組織、テナント、および有効期限を表示します。 |
| uip tools | インストール可能なツールを一覧表示、検索、インストール、更新、またはアンインストールします。 |
| uip skills | コーディング エージェント (Claude Code、Cursor、GitHub Copilot、Codex、OpenCode、Autopilot、Kiro、Windsurf、Antigravity、Devin) に UiPath のスキルをインストールします。 |
| uip mcp | MCP 対応クライアントのモデル コンテキスト プロトコルを介して uip コマンドを公開します。 |
| uip completion | bash、zsh、fish、pwsh のシェルタブ補完をインストール、印刷、または削除します。 |
| UIP 構成 | ローカルの CLI 構成設定 (出力形式、ログ レベル、バージョン/更新チャネル ポリシー) を取得、設定、またはクリアします。 |
| UIP ユーザー | 現在ログインしているセッションに関する ID 情報を表示する。 |
| UIP の更新 | インストール済みのツールとスキルを更新し、新しい CLI バージョンを確認または適用します。 |
| UIP へのフィードバック | バグ レポートまたは改善提案を UiPath チームに送信します。 |
ツール
各ツールは、インストール可能な npm パッケージです。uip tools install <alias>を実行して追加するか、一度呼び出して自動インストールに任せてください。モデルについては 「ツール (プラグイン)」 を、それらを管理するコマンドについては「 uip ツール 」を参照してください。
| エイリアス | ツール | 参照 |
|---|---|---|
or | Orchestrator (ジョブ、プロセス、フォルダー、マシン、ユーザー、ライセンス、ランタイム リソース — アセット、バケット、キュー、トリガー、ライブラリ、Webhook) | uip or |
platform | プラットフォーム (テナント ライセンス、ユーザー バンドル、グループ ルール、消費状況) | uip platform |
solution | 解決策 | uip solution |
agent | オペレーター | uip agent |
maestro | Maestro — インストール可能な 1 つのパッケージと、3 つの独立した兄弟サーフェス。ベア uip maestro コマンドはありません | UIP Maestro BPMN、 UIP 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 |
is | Integration Service | uip is |
codedagent | コード化されたエージェント | uip codedagent |
codedapp | コード化されたアプリ | uip codedapp |
api-workflow | API ワークフロー | uip api-workflow |
vss | バーティカルソリューション | uip vss |
df | Data Fabric | uip df |
insights | Insights | uip insights |
traces | トレース | uip traces |
docsai | DocsAI | uip docsai |
eval | Orchestrator パッケージの実行時の評価 — 評価器、評価セット、評価、スケジュール | UIP の評価 |
admin | 管理者 (ユーザー、グループ、ロボット アカウント、外部アプリ、SMTP、認可、IP 制限、組織、テナント、VPN ゲートウェイ、リソース カタログ、監査) | UIP 管理者 |
agenthub | AgentHub (MCP サーバーの登録、ツール、リモート A2A エージェント) | UIP AgentHub |
ah | Automation Hub (アイデア、パイプライン、タクソノミー、ユーザー) | UIP ああ |
aops | StudioAdmin AOps (コネクション、リポジトリ、プロジェクト、ソリューション、パイプライン、実行) | UIP の AOP |
coder | Coder — AI コーディング エージェント (プレビュー ビルドのみ) | UIP コーダー |
context-grounding | コンテキスト グラウンディング (Python ブリッジ) | UIP のコンテキスト グラウンディング |
conversational | 会話型 (チャット、エージェント、会話履歴、トランク) | UIP 会話型 |
function | 関数 — JS/TS および Python 関数のビルド、サーブ、パブリッシュ | uip 関数 |
gov | ガバナンス (AOps ポリシー、アクセス ポリシー、コンプライアンス パッケージ) | UIP Gov |
guardrails | ガードレール (BYO ガードレールの設定、AI Trust Layer) | UIP ガードレール |
ixp | IXP — インテリジェントなドキュメント処理 (プロジェクト、タクソノミー、ドキュメント、デプロイ) | UIP IXP |
llm-configuration | LLM の設定 — BYO LLM 接続 (AI Trust Layer) | uip llm - 構成 |
llm-gateway | LLM ゲートウェイ — 利用可能なモデルのリストを表示します | uip llm-gateway |
model-hub | モデル ハブ — LLM ゲートウェイのルーティング設定 | uip model-hub |
pm | Process Mining (アプリ、変換、データ取り込み) | UIP PM |
tasks | Action Center のタスク (カタログ、コメント、ラベル、メタデータ、データ) | UIP タスク |
コマンド ページを読み取る方法
すべてのコマンドのリファレンス ページは、同じ構造に従います。
- 書式 — 位置引数と共通フラグセットを示す1行のコマンド形状。
- 説明 — コマンドが何をし、ワークフローのどこに適合するかに関する 1 つか 2 つの段落。
- 引数 — 位置引数の表:名前、必須/オプション、目的。
- オプション — 関心事(識別、フィルタリング、出力、動作)別にグループ化されたフラグの表。各行には、短い名前、長い名前、値の型、既定値、および 1 行の説明が表示されます。
- 例 — 3つ以上の実用的な例:最小限、一般的なケース、スクリプトフレンドリー(
--output-filterまたは明示的なJSON処理を使用)。 - 終了コード — 終了コード へのポインターとコマンド固有のオーバーライド。
- 関連コマンド — このコマンドで頻繁に使用されるコマンド。
- 参照 — コマンドのコンテキストをカバーする概念とハウツーページ。
すべてのページは グローバル オプションを継承します。すべてのコマンドで繰り返されるわけではありません。
命名規則
- コマンド プレフィックス。
uipは実行可能ファイルです。すべての例はそれから始まります。 - プレースホルダー。必須の値
<angle-brackets>、任意の値[square-brackets]。実際の値に置き換えてください。 - 短いフラグ。フラグが短い形式(たとえば、
--tenantの場合は-t)の場合、両方がオプションテーブルに一緒にリストされます。例では、読みやすくするために長い形式を使用しています。 - JSON のサンプル。
--output jsonがデフォルトです。出力を示す例では、関係のないフィールドは…で省略され、フォーカスが維持されます。 - バージョンノート。[プレビュー] というラベルの付いたコマンドまたはフラグは、メジャー バージョンのバンプなしで変更される場合があります。非推奨というラベルの付いたコマンドは、少なくとも 1 つの MAJOR サイクルの間、機能し続けます。「バージョン管理と安定性」をご覧ください。