- 概要
- はじめに
- 概念
- UiPath CLI を使用する
- UiPath for Coding Agents
- 使用ガイド
- CI/CD レシピ
- コマンド リファレンス
- 概要
- 終了コード
- グローバル オプション
- uip codedagent
- uip docsai
- add-test-data-entity
- テスト データのキューを追加
- 追加-テスト-データ-バリエーション
- 分析
- 開発
- プロジェクトを作成
- 差分
- アクティビティを検索
- GET-ANALYZER-RULES
- get-default-activity-xaml
- エラーを取得
- 手動テスト用のテスト ケースを取得
- 手動テストステップを取得
- get-versions
- Get-workflow-example
- indicate-application
- 要素を示す
- inspect-package
- install-data-fabric-entities
- パッケージのインストールまたは更新
- list-data-fabric-entities
- list-workflow-examples
- パッケージ化
- 元に戻す
- ファイル名を実行
- 検索テンプレート
- スタートスタジオ
- 実行を停止
- UIA
- UIP トレース
- 移行
- 概要
- レガシ .NET CLI から移行する
- コマンド マップ (レガシから uip)
- フラグの名前の変更
- 重大な変更
- 参照とサポート
UiPath CLI ユーザー ガイド
UiPath CLI 1.x (uip、 npm で @uipath/cliとして配布 ) は、従来の .NET CLI (uipcli.exe、 2023.10、2024.10、および 2025.10のカレンダー リリースを通じてUiPath.CLIとして配布) を置き換えるものです。このページでは、誰が移行する必要があるか、ツールレベルでの変更点、および以下の 4 つの詳細ページでの移動方法について説明します。
このガイドの対象者
次のいずれかに該当する場合は、移行する必要があります。
- パイプラインは、Azure DevOps タスクを介して直接、または Jenkins / GitHub Actions シェル ステップから
uipcli.exeUiPathCLI呼び出します。 - レガシCLIをカレンダーバージョン(
2023.10、2024.10、2025.10)に固定し、その年ごとの周期を追跡しています。 - Orchestrator に対してユーザー/パスワード認証 (
-u/-p) または更新トークン認証 (-t/-a) を使用している。 uipcli package packを使用して.nupkgを構築したり、uipcli package deployを使用してデプロイしたり、uipcli test runを使用して Orchestrator のテストを実行したりできます。
クロスプラットフォーム uip rpa ツール (Studio デバッガーとの連携、 validate、 find-package、 find-activities、 type-definition) にまだ移植されていない Windows 専用の機能が必要な場合は、今のところレガシ CLI の使用を継続できます。Windows では、兄弟の uip rpa-legacy ツールが 2025.10 バイナリをラップします。「 uip RPA — Windows 専用レガシ ラッパー」をご覧ください。それ以外のすべてのパッケージ (Linux/macOS でのパッケージ、Orchestrator の操作、ソリューション、Test Manager、Agents、フロー、Maestro など) は、現在 uip されています。
一目でわかる変更点
| Dimension | レガシ の uipcli (2025.10 まで) | uip 1.x |
|---|---|---|
| バイナリ名 | uipcli.exe / uipcli.dll | uip |
| 分布 | MSI、NuGet (UiPath.CLI、 UiPath.CLI.Windows) | npm (@uipath/cli) |
| 実行時 | .NET 6 / .NET Framework | Node.js 18+ |
| プラットフォーム | Windows (プライマリ)、Linux (クロスプラットフォーム NuGet 経由) | Windows、macOS、Linux、ARM64 |
| バージョン管理 | カレンダー (2023.10, 2024.10, 2025.10) | セマンティック (1.0.0、 1.1.0、 2.0.0) |
| モデルをインストール | モノリシック | ホスト + サーフェスごとのツール プラグイン ( 「ツール」を参照) |
| 既定の出力 | テキスト ログから stdout + 終了コード | stdout の JSON エンベロープ、stderr のログ |
| プライマリ認証フロー | ユーザー/パス、更新トークン、外部アプリ | 外部アプリ (CI)、対話型 OAuth (dev)、env-token (コンテナー) |
| 構成 | CLI フラグのみ | フラグ + 環境変数 ( 「構成」を参照) |
書き換えの概要については 、「更新内容 」をご覧ください。
使用しているCLIのバージョン
uipcli --version (または dotnet uipcli.dll --version) を実行します。出力は、 23.10.8817.35919、 24.10.9248.xxxxx、または 25.10.xxxx.xxxxxのようになります。以下の移行パスは、この 3 つすべてをカバーしています。
| 実行中 | 行き先 |
|---|---|
uipcli 23.10.* | このページ全体を読んでから、 コマンドマップ + フラグの名前を変更してください。使用するdeploy動詞とasset deploy動詞はすべてマッピングされます。 |
uipcli 24.10.* | 23.10と同じで、コマンドサーフェスはほとんど変更されていません。24.10で追加された solution 動詞を採用した場合、すべてのサブコマンドがマッピングされます。 |
uipcli 25.10.* | 同上。test parallel とマルチエントリ ポイント --processNames <csv> デプロイ フォームには、 コマンド マップに固有の移行に関する注意事項があります。 |
を使用する uipcli run <args.json> | コマンド マップ — 実行 — 新しい CLI には直接同等のものはありません。推奨されるパターンは、ステップごとに 1 つの uip 呼び出しを行うシェルスクリプトです。 |
デシジョンテーブル — 開始点を選択
ユースケース uipcli | 移行対象 | 詳細ページ |
|---|---|---|
| Studio プロジェクトをパッケージ化→ Orchestrator にアップロードし→プロセスを作成します | uip rpa pack → uip or packages upload → uip or processes create | コマンド マップ — パッケージ |
ソリューションを梱包してデプロイする (.uipx) | uip solution pack → uip solution publish → uip solution deploy run | コマンド マップ — ソリューション、 最初のパイプライン |
| Orchestrator のジョブを開始する | uip or jobs start <process-key> [--wait-for-completion] | コマンド マップ — ジョブ |
| Test Manager のテスト セットを実行する | uip tm testsets run → uip tm wait → uip tm report get | コマンドマップ — テスト |
| CSV 宣言アセットをデプロイする | uip resource assets create イン・ア・ループ(今すぐワンショットのCSVをデプロイすることはありません) | コマンド マップ — アセット |
| ワークフロー アナライザーを実行する | uip rpa analyze <project> --governance-file-path <policy> | コマンドマップ — analyze |
| CI パイプラインを認証する | uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant <name> | フラグの名前変更 — auth |
| Azure DevOps/Jenkins パイプラインを移植する | UiPathCLIタスクブロックをuipシェルステップに置き換えます | パイプラインの例 |
最も一般的な重大な変更
この3つは、ほぼすべての移住に登場します。完全なリストについては、「 重大な変更 」をご覧ください。
- Basic (
-u/-p) と refresh-token (-t/-a) 認証はなくなりました。外部アプリケーション クライアント資格情報、対話型 OAuth2、および環境変数アクセス トークンのみがサポートされています。「 認証」をご覧ください。 UIPATH_CLIENT_ID/UIPATH_CLIENT_SECRETが暗黙的に読み取られなくなりました。引数を--client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRETとして渡します (プレフィックスenv.は、変数をコマンド ラインで公開せずに読み取ります)。- 既定では、Stdout は JSON です。テキスト出力を解析したレガシ シェル スクリプト
uipcli、jq(または--output plain+--output-filter) を使用するか、人間が読み取るために--output tableに切り替える必要があります。
開始する前に
パイプラインの移植を開始する前に、次の 4 つの手順を完了してください。
1. 現在のパイプライン ファイルをバックアップする
ブランチ(またはタグ)上のすべての azure-pipelines.yml、 Jenkinsfile、 .github/workflows/*.yml、または .gitlab-ci.yml の既知の良好なコピーをコミットします。移植版は差分としてレビューするのが簡単です。
2. @uipath/cli を特定バージョンにピン留めする
パイプラインの動作が予期せず変更されないように、移行中は必ず明示的なバージョンでインストールしてください。
npm install -g @uipath/cli@1.0.0
npm install -g @uipath/cli@1.0.0
ツールはCLIの MAJOR.MINOR 行に暗黙的にピン留めされるため( バージョニングを参照)、ピン留めされたCLIはすべてのツールを既知のマイナー範囲にもピン留めします。厳密なパッチレベルの再現性を得るには、ツールもピン留めしてください — スクリプトパターンの「CI でのバージョンのピン留め」セクションを参照してください。
3. レガシ .NET CLI ドキュメントをブックマークする
ポート中の相互参照フラグの動作。2025.10 のリファレンスは、「 docs.uipath.com — UiPath Command Line Interface (2025.10)」にあります。タブで開いたままにします。
4. UiPath で外部アプリケーションを作成する
レガシCLIはいくつかの認証モードを受け入れました。新しいCLIは、外部アプリケーションクライアントクレデンシャルへのCI認証を折りたたみます。ここでアプリを作成して、ポートが指すものを持つようにします。「認証 — フロー 2」を参照してください。
レガシ CLI で使用しているスコープと同じスコープ ( 、 OR.Folders、 OR.Jobs、 OR.Execution、 OR.Assets、 OR.Users.Read、 OR.Machines.Read、 OR.TestSets、 OR.TestSetExecutions を外部アプリに付与します。必要な正確なリストについては、既存の uipcli 呼び出しの--applicationScope値を確認します。
4 つの詳細ページ
以下の各ページは、一度にレビューするのに十分な焦点を絞っています。完全なパイプラインを移植する場合は、順番に作業してください。特定の答えだけが必要な場合は、必要な質問に直接ジャンプしてください。
コマンド マップ
すべてのレガシー動詞 — package pack、 package analyze、 package deploy、 package restore、 job run、 test run、 、 test parallel、 asset deploy、 asset delete、 solution pack、 solution deploy、 run は、 uip に相当する 1:1 / 複数ステップ/削除された分類と、重要なすべての行の before/after シェルスニペットです。
フラグの名前の変更
上部に認証ブロックがあるフラグレベルのマッピング。レガシ の -u/-p/-t/-a/-A/-I/-S/-o/--applicationScope/--identityUrl/--outputType/--traceLevel uip 対応物にマッピングされます (または、置換されたものとともに削除済みとして呼び出されます)。これをコマンドマップと一緒に読んでください — コマンドマップは動詞を示し、Flag renames はフラグを表示します。
重大な変更
警告なしにパイプラインを中断させる変更の散文的な報道。認証モードの削除、環境変数の自動読み取りの削除、終了コードのコントラクトの締め付け、JSON-stdout の既定値、カレンダー バージョン管理された NuGet フォルダーの削除、.NET ランタイムの削除。変更ごとに1つの段落と「何をすべきか」の修正。
パイプライン
Azure DevOps と Jenkins の Before/After スニペット (必須)、短い GitHub Actions と GitLab CI スニペット。完全なパイプラインの完全な CI/CD レシピ にクロスリンクされています。
参照
- 新着情報 — 書き直しの見出しの要約。
- 最初のパイプライン — 新しい CLI を使用した
pack → publish → deploy runの実践的なウォークスルー。 - 認証 — 1.x でサポートされる 3 つの認証フロー。
- 終了コード — 厳格化された5層契約。
- ツール (プラグイン) — コマンド サーフェスが npm パッケージに分割される理由と、初回使用時に自動インストールされる理由。