- 概要
- はじめに
- 概念
- 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 トレース
- 移行
- 参照とサポート
UiPath CLI ユーザー ガイド
このページでは、ディスク上の UiPath ソリューションをエンドツーエンドで Orchestrator に配布する方法、つまり、ローカルに パッケージ化 してテナントのソリューション フィードに パブリッシュ し、 フォルダーにデプロイする方法について説明します 。これは、開発者のラップトップとCIパイプラインから同じように機能する solution ツールを使用します。
必要なもの
- UiPath CLI がインストールされていて、ログインしているセッションがある。「 UiPath CLI と認証をインストールする 」をご覧ください。
- ディスク上の UiPath ソリューション 。
uip solution packは、次の 2 つのシェイプのいずれかを受け入れます (CLI 独自のsolution pack --helpに一致します)。.uipxソリューション記述子 (Studio が書き込み、uip solution new作成するもの) を含むソリューション ディレクトリ- スタンドアロンの
.uisファイル (事前にバンドルされたソリューションの成果物)
- ソリューションをデプロイする Orchestrator フォルダー パスです (例:
Shared/MySolutionFolder)。
フロー
3 つのコマンドがそれぞれ個別のステップであるため、CI パイプラインで個別に実行できます。
uip solution pack— ソリューション ディレクトリからバージョン管理された.zipパッケージを生成します。uip solution publish— テナントのソリューション フィードに.zipをアップロードします。uip solution deploy run— フォルダーを作成し、パブリッシュしたパッケージを Orchestrator にデプロイします。
ステップ1.ソリューションを梱包する
uip solution pack ./my-solution ./dist \
--name my-solution \
--version 1.0.0
uip solution pack ./my-solution ./dist \
--name my-solution \
--version 1.0.0
引数:
- 最初の位置引数は、ソリューション ディレクトリ (または
.uisファイル) です。 - 2 つ目は出力ディレクトリです。
uip存在しない場合は作成します。
フラグ:
- パッケージ名 (既定: ソリューション ディレクトリ名) を上書き
--name。 --versionパッケージのバージョンを設定します (既定値:1.0.0)。読みやすくし、Orchestrator でバージョンを正しく並べ替えられるようにするには、セマンティック バージョニングを使用します。
成功すると、 ./dist/my-solution.1.0.0.zip が書かれます。JSON 応答は、 Data.Package ( name@versionの形式) と Data.Packages (内部のファイル名 .nupkg ) を返します。.zipパス自体は規則{outputDir}/{name}.{version}.zipに従うため、パイプラインでは JSON を解析せずにパスを構築できます。
NAME=my-solution
VERSION=1.0.0
uip solution pack ./my-solution ./dist --name "$NAME" --version "$VERSION"
PACKAGE="./dist/${NAME}.${VERSION}.zip"
NAME=my-solution
VERSION=1.0.0
uip solution pack ./my-solution ./dist --name "$NAME" --version "$VERSION"
PACKAGE="./dist/${NAME}.${VERSION}.zip"
ステップ2.テナントにパブリッシュします。
uip solution publish ./dist/my-solution.1.0.0.zip
uip solution publish ./dist/my-solution.1.0.0.zip
パッケージがテナントのソリューション フィードにアップロードされます。Orchestrator は、テナント上のこの特定のバージョンの PackageVersionKey を割り当てます。publish は (name, version) ごとのべき等です。同じバージョンで再実行すると、複製されるのではなく、既存のバージョンが返されます。
マルチテナント組織の特定のテナントに対して実行する場合は、 --tenant <tenant-name> を publishに渡します。 pack はテナントに依存しません。不明な場合は、CLI が現在バインドされているテナントが表示されます uip login status 。
ステップ3.Orchestrator にデプロイする
uip solution deploy run \
--name MyFirstDeployment \
--package-name my-solution \
--package-version 1.0.0 \
--folder-name MySolutionFolder \
--folder-path Shared
uip solution deploy run \
--name MyFirstDeployment \
--package-name my-solution \
--package-version 1.0.0 \
--folder-name MySolutionFolder \
--folder-path Shared
フラグ (特に明記されていない限り必須):
--name— デプロイ名 (パッケージ名ではない) です。意味のあるものを使用してください。これにより、今後のdeploy status/deploy activate呼び出しのデプロイが識別されます。--package-name、--package-version— 手順 2 でパブリッシュした内容と一致します。--folder-name— このデプロイ用に作成する Orchestrator のフォルダーです。--folder-path— 親フォルダーのパスです。Sharedテナント ルートです。--folder-key— 親フォルダーの GUIDID でバインドする場合は、--folder-pathの代わりにこれを使用します。
deploy run は、デプロイが終了ステート (既定のポーリング タイムアウトは 360 秒で、 --timeoutで調整可能) に達するまで Orchestrator をポーリングします。応答には、新しいフォルダーのパスとデプロイ キーが含まれます。
--name と --folder-name は 2つの異なるものです。--name デプロイ レコードに名前を付けます。 --folder-name 、デプロイによって作成される新しい Orchestrator フォルダーの名前が付けられます。両方に同じ値を選択するのは問題ありませんし、一般的です。
CIにまとめる
#!/usr/bin/env bash
set -euo pipefail
uip login \
--client-id env.UIPATH_CLIENT_ID \
--client-secret env.UIPATH_CLIENT_SECRET \
--tenant "$UIPATH_TENANT"
uip solution pack ./my-solution ./dist --version "$BUILD_VERSION"
uip solution publish "./dist/my-solution.$BUILD_VERSION.zip"
uip solution deploy run \
--name "my-solution-$GIT_SHA" \
--package-name my-solution \
--package-version "$BUILD_VERSION" \
--folder-name MySolutionFolder \
--folder-path Shared
#!/usr/bin/env bash
set -euo pipefail
uip login \
--client-id env.UIPATH_CLIENT_ID \
--client-secret env.UIPATH_CLIENT_SECRET \
--tenant "$UIPATH_TENANT"
uip solution pack ./my-solution ./dist --version "$BUILD_VERSION"
uip solution publish "./dist/my-solution.$BUILD_VERSION.zip"
uip solution deploy run \
--name "my-solution-$GIT_SHA" \
--package-name my-solution \
--package-version "$BUILD_VERSION" \
--folder-name MySolutionFolder \
--folder-path Shared
スクリプトは最初の 0 以外のステータスで終了するため、いずれかのステップでエラーが発生するとビルドが中止されます。uip は、成功した場合は 0 を返し、失敗した場合は 1 を返します。ドメイン固有のセマンティクスを持つコマンド (例えば、タイムアウトに2を再利用する uip tm waitなど) は、他のコードを返す可能性があります — 終了コードを参照してください。
デプロイ後
ソリューションがデプロイされると、Orchestrator にはフォルダー (Shared/MySolutionFolder)、ソリューション内のデプロイ可能なプロジェクトごとのプロセス、および関連するすべてのリソース (アセット、キュー、トリガー) があります。これで次の操作が可能になります。
# confirm the folder exists
uip or folders list --all --path "Shared/MySolutionFolder"
# find the processes that were created
uip or processes list --folder-path "Shared/MySolutionFolder"
# start a job
uip or jobs start <process-key>
# inspect the deployment
uip solution deploy status --deployment-key <deployment-key>
# confirm the folder exists
uip or folders list --all --path "Shared/MySolutionFolder"
# find the processes that were created
uip or processes list --folder-path "Shared/MySolutionFolder"
# start a job
uip or jobs start <process-key>
# inspect the deployment
uip solution deploy status --deployment-key <deployment-key>
Studio のプロジェクトが 1 つしかない場合はどうでしょうか。
単一の Studio プロジェクト (ソリューションではなく project.json を含むディレクトリ) の場合、クラシック パイプラインはpack a .nupkg → upload to a feed → create a processです。このフローでは、 rpa ツールと or ツールのコマンドを使用します。
uip rpa pack ./MyStudioProject ./dist
uip or packages upload ./dist/MyStudioProject.1.0.0.nupkg
uip or processes create \
--name MyProcess \
--package-key MyStudioProject \
--package-version 1.0.0 \
--folder-path Shared
uip rpa pack ./MyStudioProject ./dist
uip or packages upload ./dist/MyStudioProject.1.0.0.nupkg
uip or processes create \
--name MyProcess \
--package-key MyStudioProject \
--package-version 1.0.0 \
--folder-path Shared
次のステップ
- 方法: CI から Orchestrator にデプロイ する — CI プラットフォームごとのバリアント。
- CI/CD レシピ: Azure DevOps、 GitHub Actions、 Jenkins、 GitLab。
- UIP Solution Reference — すべての
solutionサブコマンド。 - ソリューションをパッケージ化して公開する (使い方) — バージョン管理戦略や複数環境の昇格など、より詳細にカバーできます。