uip solution

「uip solution」ツールを使用して、UiPath ソリューションを構築、パブリッシュ、デプロイし、スキャフォールディング アンド パックから Orchestrator のアクティベーションまでを行えます。

uip solution が構築、パブリッシュ、デプロイする ソリューション (UiPath プロジェクト (RPA ワークフロー、テスト ケース、ライブラリ、エージェント、Maestro のフロー、アプリ) のバンドルで、単一の成果物として提供およびバージョン管理されます。ソリューションは、ソリューション ディレクトリのルートにある .uipx マニフェストによって定義されます。そのマニフェストにリストされているすべてのプロジェクトは、パック、発行、および配置を介して一緒に移動します。

このツールでは、ソリューションをローカルで素早く作成または編集し (init、 projects)、 .zip にパッケージ化 ( 、pack)、パッケージ化したバージョンを Orchestrator にデプロイする (publish + deploy runの 3 つのステップにほとんどの時間を費やします。エンドツーエンドのチュートリアルについては、「 最初のパイプライン 」をご覧ください。

動詞のタクソノミー

動詞ファミリー	動作対象	目的
init	ローカル ファイルシステム	空の .uipx ソリューション ディレクトリをスキャフォールディングします。
projects	ローカル .uipx /クラウド	ソリューション マニフェストに登録されているプロジェクトを追加、インポート、一覧表示、削除、パブリッシュ、または再同期します。
resources	ローカル ソリューション	ソリューション内のリソース宣言 (キュー、アセット、バケット、プロセス、コネクションなど) を一覧表示、取得、追加、削除、編集、更新します。
pack	ローカル ソリューション	ソリューション ディレクトリまたは .uis ファイルからデプロイ可能な .zip パッケージを作成します。また、 --dry-runを介して検証し、パッケージに署名し、ソース トレーサビリティ メタデータをスタンプします。
publish	テナント フィード/個人用ワークスペース/フォルダー フィード	パックした .zip を UiPath ソリューション フィードにアップロードします。
upload	Studio Web	Studio Web でブラウザーベースで編集するためのソリューションをアップロードします。
download	Studio Web	Studio Web ソリューションをダウンロードし、必要に応じて ID で抽出します。
list (プレビュー)	Studio Web/ローカル ファイル システム	Studio Web のソリューションのリストを表示するか、ディレクトリをスキャンしてローカルのソリューションを探します。
delete	Studio Web	Studio Web ソリューションを ID で削除する ( -y, --yesが必要です)。
cleanup	ローカル ファイルシステム	ソリューション内のすべてのプロジェクトから未使用の項目を削除します。
restore	ローカル ファイルシステム	ソリューション内のすべてのプロジェクトの NuGet 依存関係を解決します。
feeds	テナント/個人用ワークスペース/フォルダー	パブリッシュまたはデプロイできるフィード (パブリッシュ先) を一覧表示します。
packages	テナント フィード/個人用ワークスペース/フォルダー フィード	パブリッシュ済みのソリューション パッケージのリストを表示、ダウンロード、削除します (削除には -y, --yesが必要です)。
deploy	Orchestrator	新しいデプロイをインストールします (run)、既存のデプロイを新しいパッケージ バージョンに移行 (upgrade)、ステータスの確認、アクティベーション、アンインストール (必須 -y, --yes)、デプロイ構成ファイルの編集を行います。

uip solution は @uipath/solution-tool プラグインによって提供されます。まだインストールされていない場合は、 uip tools install solution によって追加されます。ツール (プラグイン) を参照してください。

注:

projects 以前は project (単数形) として文書化されていました。単数形は今でも機能します - それは後方互換性のための非推奨の隠されたエイリアスとして登録されたままです - しかし、 projects 今後は正規です。

概要

uip solution init <solutionName>

uip solution projects add <projectPath> [--solution-folder <path>]
uip solution projects import --source <path> [--solution-folder <path>]
uip solution projects remove <projectPath> [--solution-folder <path>]
uip solution projects list [--solution-folder <path>]
uip solution projects publish --project-name <name> --package-name <name> --package-version <version> [--folder-name <name>]
uip solution projects resync [project-name] [--sync-option <Sync|Reset>]

uip solution resources list [--solution-folder <path>] [--kind <kind>] [--search <term>] [--source <all|local|remote>]
uip solution resources get <resource-key> [--solution-folder <path>]
uip solution resources add --source <local|remote> --kind <kind> --name <name>
uip solution resources remove <resource-key>
uip solution resources edit <resource-key> --patch <json>
uip solution resources refresh [--solution-folder <path>]

uip solution pack <solutionPath> [outputPath] [--name <name>] [--version <version>] [--dry-run]
uip solution publish <packagePath> [--feed <name-or-key> | --personal-workspace] [--wait]
uip solution upload <solutionPath>
uip solution download <solution-id> [-d <destination>] [--extract]
uip solution list [--local [directory]] [--check-cloud]
uip solution delete <solution-id> -y
uip solution cleanup <solutionPath> [--dry-run]
uip solution restore <solutionPath>
uip solution feeds list

uip solution packages list [--personal-workspace | --feed <name-or-key>] [--limit <n>] [--offset <n>]
uip solution packages download <packageName> [packageVersion] [-d <path>]
uip solution packages delete <packageName> <packageVersion> --yes [--personal-workspace | --feed <name-or-key>]

uip solution deploy run --name <n> --package-name <n> --package-version <v> --folder-name <n> [--parent-folder-path <path> | --personal-workspace] [--feed <name-or-key>] [-y]
uip solution deploy upgrade <deployment-key> [--version <v>] [--no-wait]
uip solution deploy status <pipeline-deployment-id>
uip solution deploy activate <deployment-name>
uip solution deploy list [--folder-path <path>] [--operation-status <s>] [--activation-status <s>]
uip solution deploy uninstall <deployment-name> -y
uip solution deploy config get <package-name> [--package-version <v>] [-d <path>] [--format json|yaml]
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 です。deploy run は既存のデプロイを更新しません — 新しいデプロイを作成するか、すでにデプロイされている場合 --name は、 -y, --yes が渡されない限り拒否します (2 番目の独立したコピーがインストールされます)。既存のデプロイを新しいパッケージ バージョンに移動するには、 を使用します deploy upgrade。上記の pack/publish/packages/deploy の概要行は省略されています — 検証済みの完全なフラグリストについては、各コマンドの独自のページを参照してください。

エンドツーエンドのフロー

┌──────────┐   ┌────────────┐   ┌──────────┐   ┌──────────────┐   ┌──────────────────┐
│ solution │   │ solution   │   │ solution │   │ solution     │   │ solution deploy  │
│ init     │ → │ projects   │ → │ pack     │ → │ publish      │ → │ run              │
│          │   │ add/import │   │          │   │ (tenant feed)│   │ (Orchestrator)   │
└──────────┘   └────────────┘   └──────────┘   └──────────────┘   └──────────────────┘

1. 足場。uip solution init my-solution 空の .uipx マニフェスト (および AGENTS.md/CLAUDE.md のブリーフィング ファイル) を含むディレクトリを作成します。
2. 設定。uip solution projects add ./my-solution/my-project はプロジェクトのサブフォルダーを登録するか、外部プロジェクトを uip solution projects import --source ./external にコピーします。
3. パック。uip solution pack ./my-solution ./dist --version 1.0.0 は ./dist/my-solution_1.0.0.zipを生成します。
4. パブリッシュ。uip solution publish ./dist/my-solution_1.0.0.zip.zipをソリューション フィードにアップロードします。
5. 展開。uip solution deploy run --name my-deployment --package-name my-solution --package-version 1.0.0 --folder-name MySolution --parent-folder-path Shared Orchestrator フォルダーを作成し、リソース (キュー、アセット、プロセス) をプロビジョニングして、ソリューションをアクティブ化します。

対話型の作成の場合は、手順 3 を uip solution upload ./my-solution に置き換えて、ソリューションをデプロイ用にパッケージ化するのではなく 、UiPath Studio Web で開きます。

このフローの各ステップは、上記の 動詞の分類 の表にリンクされているページに記載されています。完全な作業例は 、最初のパイプラインにあります。

認証とフィードのモデル

Orchestrator またはソリューション フィードと通信するコマンド ( publish、 upload、 download、 list (クラウド モード)、 delete、 packages *、 feeds list、 resources list/add/refresh (リモート パス)、およびすべての deploy … サブコマンド) には、アクティブなセッションが必要です。uip login を 1 回実行します。「 認証」をご覧ください。

一部のコマンドは、既定のテナント フィードではなく、特定のソリューション フィードをターゲットとする --personal-workspace または --feed <name-or-key> を追加で受け入れます。uip solution feeds list を使用して、フィードの名前またはキーを検索します。

ローカル コマンド (init、 projects add/import/remove/list、 pack、 cleanup、 restore、 resources get/remove/edit、 list --local) は、ディスク上のファイルに対してオフラインで動作します。

参照

• uip solution feeds — publish --feedのフィードのリストを表示します。
• uip solution list、 uip solution download — Studio Web のソリューションを検索して取得します。
• uip solution cleanup、 uip solution restore — 梱包前のローカル プロジェクトのメンテナンス。
• 最初のパイプライン — パッケージ→パブリッシュ→デプロイの実行の実践的なチュートリアル。
• ツール (プラグイン) — ソリューション ツールの配布方法とバージョン管理方法。
• 認証 と 構成 — セッション設定とテナントごとの既定値。
• グローバルオプション と 終了コード — すべての動詞で共有されるコントラクト。
• uip or — Orchestrator リソースの CRUD (アセット、バケット、キュー、ライブラリ、トリガー、Webhook)、およびジョブ、プロセス、フォルダー。