uip solution projects

Syntax and options for `uip solution projects`, which manages the projects listed in a `.uipx` solution manifest, plus cloud-project publish and sync.

uip solution projects manages the projects listed inside a .uipx solution manifest — RPA processes, tests, agents, Maestro flows, case and BPMN projects, coded apps, functions, API workflows, and other buildable project types. A library is not a project — publish it on its own, then attach it with uip solution resources add --source remote --kind Library.

注:

This group was previously documented as project (singular). The singular form still works — it's kept registered as a hidden, deprecated alias for back-compat — but projects is canonical going forward.

サブコマンド	目的
add	ソリューション ディレクトリに既に存在するプロジェクト フォルダーを登録します。
import	外部プロジェクト フォルダーをソリューション ディレクトリにコピーして登録します。
remove	.uipxからプロジェクトの登録を解除します (ディスク上のファイルは削除されません)。
list	List the projects registered in the local .uipx.
publish	Publish a cloud solution project as a solution package.
resync	Sync or reset a cloud solution project.

add, import, remove, and list operate on local files only — no authentication required. publish and resync operate on a cloud solution project and require an active session.

概要

uip solution projects add <project-path> [solutionFile]
uip solution projects import <source> [--solutionFile <path>]
uip solution projects remove <project-path> [solutionFile]
uip solution projects list [--solution-folder <path>]
uip solution projects publish --project-name <name> --package-name <name> --package-version <version> [--folder-name <name>] [--description <text>] [--release-notes <text>] [-t <tenant-name>]
uip solution projects resync [project-name] [--project-name <name>] [--sync-option <Sync|Reset>] [-t <tenant-name>]

各サブコマンドは 、グローバルオプション を尊重し、 標準の終了コードを返します。

Common behaviour (add / import / remove)

• The target project folder must contain a project.uiproj, legacy project.json, or uipath.json descriptor. The command auto-detects which one.
• When [solutionFile] is omitted, the command searches upward from the project path (or the current directory, for import) for the nearest .uipx. If none is found, or if multiple .uipx files live in the same folder, the command fails and exits with 1.
• マニフェストに追加されたプロジェクトエントリごとに一意の Id (UUID)が生成されます。

---

追加

ソリューション ディレクトリ に既に存在する プロジェクト フォルダーを登録します。プロジェクト フォルダーの相対パスが .uipxに記録され、一致するエントリがソリューションの内部リソース ビルダーにプロビジョニングされます。

引数

• <project-path> (required) — Path to the project folder. Must contain project.uiproj, project.json, or uipath.json.
• [solutionFile] (任意) — .uipx ソリューションのマニフェストへのパスです。省略した場合、最も近い .uipx は <project-path>から歩いて位置します。

例

uip solution projects add ./my-solution/my-project ./my-solution/my-solution.uipx

# Auto-detect the .uipx
uip solution projects add ./my-solution/my-project

データシェイプ(--output json)

{
  "Code": "ProjectAdd",
  "Data": {
    "Status": "Added successfully",
    "Project": "my-project/project.uiproj",
    "Solution": "/workspace/my-solution/my-solution.uipx"
  }
}

故障モード

• プロジェクトがソリューション フォルダーの外部にあるこのコマンドは、外部プロジェクトをコピーする projects importへのポインタを使用して追加を拒否します。
• Project is already registered. Exits with 1 and a message naming the existing project path.

---

import

外部プロジェクト フォルダーをソリューション ディレクトリにコピーし (フォルダー名は保持)、.uipxに登録します。含めるプロジェクトがまだソリューションのルート下にない場合に使用します。

引数

• <source> (required) — Path to the external project folder to import. Must be a directory containing project.uiproj, project.json, or uipath.json. This is a positional argument, not a flag — earlier docs on this page showed it as --source <path>, which is wrong.

オプション

長押し	値 (Value)	既定 (Default)	説明
--solutionFile	パス	nearest .uipx above the current directory	Path to the .uipx solution manifest.

例

uip solution projects import ./external-project \
  --solutionFile ./my-solution/my-solution.uipx

# From inside the solution directory (auto-detect .uipx)
cd ./my-solution
uip solution projects import ../shared-library

データシェイプ(--output json)

{
  "Code": "ProjectImport",
  "Data": {
    "Status": "Imported successfully",
    "Project": "external-project/project.uiproj",
    "Solution": "/workspace/my-solution/my-solution.uipx"
  }
}

失敗モードとロールバック

• 保存先フォルダーは既に存在します。このコマンドは上書きを拒否します。移動元のフォルダーの名前を変更するか、先に既存の保存先を削除します。
• プロジェクトが既に .uipx マニフェストに含まれています。ファイルがコピーされるまで拒否されます。
• コピー、書き込み、またはビルダーのステップが失敗します。コマンドがロールバックされ、コピーされたディレクトリが削除され、 .uipx が元の内容に復元されます。

---

削除

Unregister a project from the .uipx solution manifest and remove its entry from the internal resource builder. Files on disk are not deleted. Refuses to remove the last project in a solution (an empty Projects[] is only valid immediately after init) — the one exception is a project of an unsupported type, which can always be removed to unblock pack.

引数

• <project-path> (必須) — 削除するプロジェクト フォルダーのパスです。現在 .uipxに登録されている必要があります。
• [solutionFile] (任意) — .uipx ソリューションのマニフェストへのパスです。既定値は、<project-path>から歩いて上って見つけた最も近い.uipxです。

例

uip solution projects remove ./my-solution/my-project ./my-solution/my-solution.uipx

データシェイプ(--output json)

{
  "Code": "ProjectRemove",
  "Data": {
    "Status": "Removed successfully",
    "Project": "my-project",
    "Solution": "/workspace/my-solution/my-solution.uipx"
  }
}

故障モード

• プロジェクトがソリューション フォルダーの外部にある相対パスの先頭に ..を含めることはできません。
• プロジェクトがマニフェストにありません。1と検索に使用する相対パスで終了します。
• Project is the only one left in the solution. Refused unless it's of an unsupported project type.

---

リスト (List)

List the projects registered in the local .uipx solution manifest. Reads only on-disk metadata — no backend call.

オプション

長押し	値 (Value)	既定 (Default)	説明
--solution-folder	パス	現在のディレクトリ	Path to the solution root folder.

例

uip solution projects list

データシェイプ(--output json)

{
  "Code": "SolutionProjectsList",
  "Data": [
    {
      "Name": "MyProject",
      "Type": "Process",
      "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "ProjectRelativePath": "MyProject/project.uiproj",
      "ProjectFilePath": "/workspace/my-solution/MyProject/project.uiproj"
    }
  ]
}

---

パブリッシュ

Publish a cloud solution project (one already living in Automation Cloud, not a local .uipx project) as a solution package, and wait for the publish operation to complete.

オプション

長押し	値 (Value)	既定 (Default)	説明
--project-name	text	—	Required. Cloud solution project name to publish.
--package-name	text	—	Required. Solution package name to create.
--package-version	text	—	Required. Solution package version to create.
--folder-name	text	—	Root folder name to store in the solution package.
--description	text	—	Solution package description.
--release-notes	text	—	Solution package release notes.
-t, --tenant	name	セッションの既定値	Tenant.
--timeout	秒	360	Publish-polling timeout.
--poll-interval	ms	5000	Milliseconds between publish status polls.
--login-validity	分	10	Minimum minutes before token expiration to trigger a refresh.

例

uip solution projects publish --project-name MyProject \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution

データシェイプ(--output json)

{
  "Code": "SolutionProjectPublish",
  "Data": {
    "ProjectName": "MyProject",
    "PackageName": "my-package",
    "PackageVersion": "1.0.0",
    "Status": "Completed"
  }
}

---

resync

Sync or reset a cloud solution project, and wait for the operation to complete. Sync reconciles the project with its source; Reset discards local cloud changes.

引数

• [project-name] (optional) — Cloud solution project name to sync. Can also be provided with --project-name; providing both with different values is an error.

オプション

長押し	値 (Value)	既定 (Default)	説明
--project-name	text	—	Cloud solution project name to sync (alternative to the positional argument).
--sync-option	Sync | Reset	Sync	Which sync operation to run.
-t, --tenant	name	セッションの既定値	Tenant.
--timeout	秒	360	Sync-polling timeout.
--poll-interval	ms	5000	Milliseconds between sync status polls.
--login-validity	分	10	Minimum minutes before token expiration to trigger a refresh.

例

uip solution projects resync --project-name MyProject --sync-option Sync

# Positional form, reset instead of sync
uip solution projects resync MyProject --sync-option Reset

データシェイプ(--output json)

{
  "Code": "SolutionProjectResync",
  "Data": {
    "ProjectName": "MyProject",
    "Status": "Successful",
    "SyncOption": "Sync",
    "SyncErrors": []
  }
}

On failure, Instructions lists each sync error by service name and affected resource keys.

---

関連コマンド

• uip solution init — プロジェクトを追加する前にソリューションを素早く作成します。
• uip solution resources refresh — プロジェクトのバインドを編集した後、リソースを再同期します。
• uip solution pack — プロジェクト リストが完成したら、ソリューションをパッケージ化します。

参照

• 最初のパイプライン — エンドツーエンドの例。
• uip solutionの概要。