- 概要
- はじめに
- 概念
- 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 ユーザー ガイド
uip solution が構築、パブリッシュ、デプロイする ソリューション (UiPath プロジェクト (RPA ワークフロー、テスト ケース、ライブラリ、エージェント、Maestro フロー、アプリ) のバンドルで、単一の成果物として提供およびバージョン管理されます。ソリューションは、ソリューション ディレクトリのルートにある .uipx マニフェストによって定義されます。そのマニフェストにリストされているすべてのプロジェクトは、パック、発行、および配置を介して一緒に移動します。
このツールでは、ソリューションをローカルで素早く作成または編集し (new、 project)、 .zip にパッケージ化 ( 、pack)、パッケージ化したバージョンを Orchestrator にデプロイする (publish + deploy runの 3 つのステップにほとんどの時間を費やします。エンドツーエンドのチュートリアルについては、「 最初のパイプライン 」をご覧ください。
動詞のタクソノミー
| 動詞ファミリー | 動作対象 | 目的 |
|---|---|---|
new | ローカル ファイルシステム | 空の .uipx ソリューション ディレクトリをスキャフォールディングします。 |
project | ローカル .uipx | ソリューション マニフェスト内でプロジェクトを追加、インポート、削除する。 |
resource (uip solution resource …経由) | ローカル ソリューション | ソリューション内の共有リソース宣言 (キュー、アセット、バケット、プロセス、コネクション) を一覧表示および更新します。Orchestrator のリソース ツールである uip resourceと混同しないようにしてください。 |
pack | ローカル ソリューション | ソリューション ディレクトリまたは .uis ファイルから配置可能な .zip パッケージを生成します。 |
publish | テナント フィード | パッケージ化された .zip を UiPath ソリューション フィードにアップロードします。 |
upload | Studio Web | Studio Web でブラウザーベースで編集するためのソリューションをアップロードします。 |
delete | Studio Web | Studio Web ソリューションを ID で削除する |
packages | テナント フィード | パブリッシュ済みのソリューション パッケージのリストを取得および削除します。 |
deploy | Orchestrator | デプロイの実行、ステータスの確認、デプロイ構成ファイルのアクティブ化、アンインストール、および編集を行います。 |
uip solution は @uipath/solution-tool プラグインによって提供されます。まだインストールされていない場合は、 uip tools install solution によって追加されます。ツール (プラグイン) を参照してください。
概要
uip solution new <solutionName>
uip solution project add <projectPath> [solutionFile]
uip solution project import --source <path> [--solutionFile <path>]
uip solution project remove <projectPath> [solutionFile]
uip solution resource list [solutionPath] [--kind <kind>] [--search <term>] [--source <all|local|remote>]
uip solution resource refresh [solutionPath]
uip solution pack <solutionPath> <outputPath> [--name <name>] [--version <version>]
uip solution publish <packagePath> [--tenant <tenant-name>]
uip solution upload <solutionPath>
uip solution delete <solution-id>
uip solution packages list [--take <n>] [--order-by <column>] [--order-direction <dir>]
uip solution packages delete <packageName> <packageVersion>
uip solution deploy run --name <n> --package-name <n> --package-version <v> --folder-name <n> [--folder-path <path>] [--config-file <path>]
uip solution deploy status <pipeline-deployment-id>
uip solution deploy activate <deployment-name>
uip solution deploy list [--folder-path <path>] [--take <n>]
uip solution deploy uninstall <deployment-name>
uip solution deploy config get <package-name> [--package-version <v>] [-d <path>]
uip solution deploy config set <file> [--all] <args...>
uip solution deploy config link <file> <resource> --name <n> [--folder-path <path>]
uip solution deploy config unlink <file> <resource>
uip solution new <solutionName>
uip solution project add <projectPath> [solutionFile]
uip solution project import --source <path> [--solutionFile <path>]
uip solution project remove <projectPath> [solutionFile]
uip solution resource list [solutionPath] [--kind <kind>] [--search <term>] [--source <all|local|remote>]
uip solution resource refresh [solutionPath]
uip solution pack <solutionPath> <outputPath> [--name <name>] [--version <version>]
uip solution publish <packagePath> [--tenant <tenant-name>]
uip solution upload <solutionPath>
uip solution delete <solution-id>
uip solution packages list [--take <n>] [--order-by <column>] [--order-direction <dir>]
uip solution packages delete <packageName> <packageVersion>
uip solution deploy run --name <n> --package-name <n> --package-version <v> --folder-name <n> [--folder-path <path>] [--config-file <path>]
uip solution deploy status <pipeline-deployment-id>
uip solution deploy activate <deployment-name>
uip solution deploy list [--folder-path <path>] [--take <n>]
uip solution deploy uninstall <deployment-name>
uip solution deploy config get <package-name> [--package-version <v>] [-d <path>]
uip solution deploy config set <file> [--all] <args...>
uip solution deploy config link <file> <resource> --name <n> [--folder-path <path>]
uip solution deploy config unlink <file> <resource>
すべてのサブコマンドは、 グローバルオプション (--output、 --output-filter、 --log-level、 --log-file) を尊重し、 標準の終了コードを返します。既定の出力は JSON です。
エンドツーエンドのフロー
┌──────────┐ ┌────────────┐ ┌──────────┐ ┌──────────────┐ ┌──────────────────┐
│ solution │ │ solution │ │ solution │ │ solution │ │ solution deploy │
│ new │ → │ project │ → │ pack │ → │ publish │ → │ run │
│ │ │ add/import │ │ │ │ (tenant feed)│ │ (Orchestrator) │
└──────────┘ └────────────┘ └──────────┘ └──────────────┘ └──────────────────┘
┌──────────┐ ┌────────────┐ ┌──────────┐ ┌──────────────┐ ┌──────────────────┐
│ solution │ │ solution │ │ solution │ │ solution │ │ solution deploy │
│ new │ → │ project │ → │ pack │ → │ publish │ → │ run │
│ │ │ add/import │ │ │ │ (tenant feed)│ │ (Orchestrator) │
└──────────┘ └────────────┘ └──────────┘ └──────────────┘ └──────────────────┘
- 足場。
uip solution new my-solution、空の.uipxマニフェストを持つディレクトリが作成されます。 - 設定。
uip solution project add ./my-solution/my-project ./my-solution/my-solution.uipxはプロジェクトのサブフォルダーを登録するか、外部プロジェクトをuip solution project import --source ./external --solutionFile ./my-solution/my-solution.uipxにコピーします。 - パック。
uip solution pack ./my-solution ./dist --version 1.0.0は./dist/my-solution.1.0.0.zipを生成します。 - 公開。
uip solution publish ./dist/my-solution.1.0.0.zip.zipテナントのソリューション フィードにアップロードします。 - 展開。
uip solution deploy run --name my-deployment --package-name my-solution --package-version 1.0.0 --folder-name MySolution --folder-path SharedOrchestrator フォルダーを作成し、リソース (キュー、アセット、プロセス) をプロビジョニングして、ソリューションをアクティブ化します。
対話型の作成の場合は、手順 3 を uip solution upload ./my-solution に置き換えて、ソリューションをデプロイ用にパッケージ化するのではなく 、UiPath Studio Web で開きます。
このフローの各ステップは、上記の 動詞の分類 の表にリンクされているページに記載されています。完全な作業例は 、最初のパイプラインにあります。
認証
Orchestrator と通信するすべてのコマンド ( publish、 upload、 delete、 packages list、 packages delete、および deploy … のすべてのサブコマンド) には、アクティブなセッションが必要です。uip login 1 回実行する認証された組織内の特定のテナントを対象に-t, --tenant <tenant-name>サブコマンドを渡します。「 認証」をご覧ください。
ローカルコマンド(new、 project add/import/remove、 pack、 resource list/refresh)は、ディスク上のファイルに対してオフラインで動作します。
参照
- 最初のパイプライン — パッケージ→パブリッシュ→デプロイの実行の実践的なチュートリアル。
- ツール (プラグイン) — ソリューション ツールの配布方法とバージョン管理方法。
- 認証 と 構成 — セッション設定とテナントごとの既定値。
- グローバルオプション と 終了コード — すべての動詞で共有されるコントラクト。
uip resource— Orchestrator リソース CRUD (アセット、バケット、キュー、ライブラリ、トリガー、Webhook)。ローカルのソリューション リソース宣言を検査するuip solution resourceと混同しないようにしてください。