UIP RPA

uip rpa は RPA ツールであり、CLI と UiPath Studio のインストールをつなぐ橋渡し役となります。Studio プロジェクトを .nupkg アーカイブにパッケージ化し、ワークフロー アナライザーとコンパイラを実行し、プロジェクトをスキャフォールディングして実行し、AI コーディング エージェントと スキル システムで使用される Studio の操作を公開します。

uip tools install rpaでインストールするか、uip rpa … を呼び出して自動インストールを実行します。インストール モデルについては 「ツール (プラグイン)」 を、ツールのインストールを管理するコマンドについては「 uip ツール 」を参照してください。rpa はコマンド プレフィックスです。基になるパッケージは @uipath/rpa-toolです。

Before running the packager verbs in CI or on a fresh machine, make sure your runtime and runner OS match the project flavor — see Prerequisites.

コマンド

すべての uip rpa 動詞には、独自のリファレンスページがあります。インストール済みのツール バージョンのライブ引数リストを取得するには、 uip rpa <verb> --helpを実行します。

動詞	説明
add-test-data-entity	Data Service のエンティティをテスト ケースのデータ ソースとして追加します。
add-test-data-queue	Orchestrator からテスト データのキューをテスト ケースのデータ ソースとして追加します。
add-test-data-variation	CSV/Excel データ バリエーション ファイルをテスト ケースに追加します。
analyze	ガバナンス ポリシーが設定されたプロジェクトに対してワークフロー アナライザーを実行します。
build	Studio プロジェクトを .nupkgを作成せずにコンパイルします。
create-project	テンプレートから新しいプロジェクトをスキャフォールディングします。
diff	Studio の差分ウィンドウでの 2 つのファイルの差分の表示
find-activities	クエリに一致するアクティビティと任意のタグを検索する
get-analyzer-rules	開いているプロジェクトに対して有効化されているワークフロー アナライザーのルールを表示します。
get-default-activity-xaml	既定値を含むアクティビティの XAML 表現を取得します。
get-errors	診断をファイルまたはプロジェクト全体から、重要度でフィルター処理して取得します。
get-manual-test-cases	Test Manager から手動テスト用のテスト ケースを取得します。
get-manual-test-steps	手動テスト ステップを取得して、テスト ケース ID のリストを確認します。
get-versions	構成済みのフィード全体で NuGet パッケージの利用可能なバージョンを一覧表示します。
get-workflow-example	ワークフローの例の XAML をキーで取得します。
indicate-application	Studio を使用して画面上でアプリケーションを指定します。
indicate-element	Studio を使用して画面上で UI 要素を指定します。
inspect-package	リフレクションを使用して NuGet パッケージのパブリック API を調べます。
install-data-fabric-entities	アクティブなプロジェクトで Data Fabric エンティティのバインドを追加または削除します。
install-or-update-packages	現在のプロジェクトに NuGet パッケージをインストールまたは更新します。
list-data-fabric-entities	アクティブなプロジェクトに関連する Data Fabric エンティティのリストを取得します。
list-workflow-examples	RPA ワークフローの例をサービス タグで検索します。
pack	Studio プロジェクトを .nupkgにパッケージ化します。
restore	project.jsonで宣言されている依存関係をダウンロードします。
run-file	ワークフロー/コード化されたファイルを実行またはデバッグします。
search-templates	構成済みの NuGet フィードでプロジェクト テンプレートを検索します。
start-studio	Studio インスタンスが実行されていることを確認します。
stop-execution	以前に run-fileで開始した実行中の実行を停止します。
uia	UI Automation CLI サブグループ。

list-instances も登録され、 --help から非表示になり、リゾルバーに表示される実行中の Studio インスタンスが一覧表示されます。

概要

uip rpa pack <project> [options]
uip rpa build <projectDir> [options]
uip rpa analyze <project> --governance-file-path <policy> [options]
uip rpa restore <project> [outputPath] [options]
uip rpa start-studio [options]
uip rpa <verb> [options]

すべての uip rpa 動詞は、 グローバル オプション ( 、--output、 --output-filter、 --log-level、 --log-file) に従います。標準の 終了コード が適用されます。

親 uip rpa グループは、すべての動詞で共有されるオプションの小さなセットを受け入れます。

親オプション	説明
--project-dir <path>	動詞が動作するプロジェクト ディレクトリです。デフォルトは、現在の作業ディレクトリです。
--studio-dir <path>	検出で Studio が自動的に見つからない場合の、Studio のインストールへのパスです。
--robot-dir <path>	Robot のインストール ディレクトリへのパスです。
--timeout <seconds>	基になる操作の最大待機時間。既定値は [ 300] です。
--verbose	Verbose ログ

これらは、サブコマンド名の前後に渡すことができます。

注:

旗の表面

動詞ごとのページには、主要なオプションが文書化されています。rpa-tool は Studio パッケージャーを統合しているため、いくつかのニッチなパッケージャー フラグ (署名資料、NuGet ソース構成、出力タイプ フィルター) が基になるパッケージャーのネイティブ フラグに従います — ライブ インストールでuip rpa <verb> --helpを実行して、インストールされているツール バージョンの完全なセットを確認します。フラグ名は、CLI の MAJOR 内のツールバージョン間で一貫しています。マイナーライン; 「バージョン管理と安定性」をご覧ください。

注:

Windows のみのレガシ ラッパー

兄弟ツール @uipath/rpa-legacy-tool (別名 rpa-legacy) は、クロスプラットフォーム uip rpaにまだ移植されていない Windows のみの機能を必要とするユーザー向けに、v2025.10 のレガシ .NET CLI をラップします。package、validate、debug、find-package、find-activities、および type-definitionのuip rpa-legacy <verb>を公開します。フラグの参照については、 v2025.10 のレガシ .NET CLI のドキュメント をご覧ください。rpa-legacy は Windows 専用です。 rpa は現代の表面を覆っています。

前提条件

Two environmental constraints govern when and where the packager verbs can run.

.NET runtime

The packager verbs (pack, build, analyze, restore) wrap the Studio packager and the workflow compiler — both .NET-backed. A runner that invokes them must have a .NET runtime available.

For the full context on why rpa-tool keeps a .NET dependency while the rest of the CLI runs on Node.js, see Breaking changes — Runtime change.

Runner OS for Windows projects

Studio projects come in two non-legacy flavors — Cross-platform (targetFramework: "Portable" in project.json) and Windows (targetFramework: "Windows"). The runner OS must match the project flavor:

• Cross-platform projects can be operated on from any OS — Windows, macOS, or Linux.
• Windows projects require a Windows runner, regardless of which verb you are running. The Linux and macOS toolchain cannot resolve the Windows-only references these projects pull in.
• Windows - レガシ プロジェクトは別のカテゴリで、uip rpa-legacy ツールが必要です。このツールは設計上 Windows 専用です。

Match the runner OS in your CI to the project flavor, or split the pipeline so cross-platform work runs on Linux/macOS and Windows project work runs on a Windows agent.

参照

• ツール (プラグイン) — @uipath/rpa-toolのモデルをインストールします。
• .NET CLI からの移行 — パッケージャー動詞の完全なコマンド間マップ。
• uip tools — ツールをインストールして管理します。
• バージョン管理と安定性 — ツールリリースの semver 契約。
• スキル — AI コーディングエージェントが uip rpa 動詞を駆動する方法。