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.

Hinweis:

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.

Unterbefehl	Zweck
add	Registrieren Sie einen Projektordner, der sich bereits im Lösungsverzeichnis befindet.
import	Kopieren Sie einen externen Projektordner in das Lösungsverzeichnis und registrieren Sie ihn dann.
remove	Die Registrierung eines Projekts bei .uipx aufheben (löscht keine Dateien auf der Festplatte).
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.

Zusammenfassung

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>]

Jeder Unterbefehl berücksichtigt die globalen Optionen und gibt die Standardaustrittscodes zurück.

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.
• Für jeden Projekteintrag, der dem Manifest hinzugefügt wird, wird eine eindeutige Id (UUID) generiert.

---

Hinzufügen

Registrieren Sie einen Projektordner, der sich bereits im Lösungsverzeichnis befindet . Der relative Pfad des Projektordners wird in .uipx aufgezeichnet, und ein übereinstimmender Eintrag wird im internen Ressourcengenerator der Lösung bereitgestellt.

Argumente

• <project-path> (required) — Path to the project folder. Must contain project.uiproj, project.json, or uipath.json.
• [solutionFile] (optional) – Der Pfad zum .uipx -Lösungsmanifest. Wenn keine Angabe erfolgt, müssen Sie den nächsten .uipx zu Beginn von <project-path> nach oben finden.

Beispiele

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

Datenform (--output json)

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

Fehlermodi

• Das Projekt befindet sich außerhalb des Lösungsordners. Der Befehl verweigert das Hinzufügen mit einem Verweis auf projects import, wodurch externe Projekte in kopiert werden.
• Project is already registered. Exits with 1 and a message naming the existing project path.

---

import

Kopieren Sie einen externen Projektordner in das Lösungsverzeichnis (unter Beibehaltung des Ordnernamens) und registrieren Sie ihn dann im .uipx. Verwenden Sie dies, wenn sich das Projekt, das Sie einschließen möchten, noch nicht unter dem Lösungsstamm befindet.

Argumente

• <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.

Optionen

Long	Wert	Standard	Beschreibung
--solutionFile	Pfad	nearest .uipx above the current directory	Path to the .uipx solution manifest.

Beispiele

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

Datenform (--output json)

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

Fehlermodi und Rollback

• Zielordner ist bereits vorhanden. Der Befehl kann nicht überschrieben werden; Benennen Sie den Quellordner um oder entfernen Sie zuerst das vorhandene Ziel.
• Projekt bereits im .uipx -Manifest. Abgelehnt, bevor Dateien kopiert werden.
• Kopier-, Schreib- oder Erstellungsschritt schlägt fehl. Der Befehl läuft zurück – das kopierte Verzeichnis wird entfernt und der .uipx wird in seinem ursprünglichen Inhalt wiederhergestellt.

---

remove

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.

Argumente

• <project-path> (erforderlich) – Der Pfad zum zu entfernenden Projektordner. Muss derzeit in .uipx registriert sein.
• [solutionFile] (optional) – Der Pfad zum .uipx -Lösungsmanifest. Standardmäßig wird der nächste .uipx verwendet, der gefunden wird, wenn Sie von <project-path> nach oben gehen.

Beispiele

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

Datenform (--output json)

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

Fehlermodi

• Das Projekt befindet sich außerhalb des Lösungsordners. Der relative Pfad darf nicht mit .. beginnen.
• Das Projekt befindet sich nicht im Manifest. Beendet mit 1 und dem relativen Pfad, der für die Suche verwendet wird.
• Project is the only one left in the solution. Refused unless it's of an unsupported project type.

---

Liste

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

Optionen

Long	Wert	Standard	Beschreibung
--solution-folder	Pfad	aktuelles Verzeichnis	Path to the solution root folder.

Beispiele

uip solution projects list

Datenform (--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"
    }
  ]
}

---

Veröffentlichen

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.

Optionen

Long	Wert	Standard	Beschreibung
--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	Sitzungsstandard	Tenant.
--timeout	Sekunden	360	Publish-polling timeout.
--poll-interval	ms	5000	Milliseconds between publish status polls.
--login-validity	Minuten	10	Minimum minutes before token expiration to trigger a refresh.

Beispiele

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

Datenform (--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.

Argumente

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

Optionen

Long	Wert	Standard	Beschreibung
--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	Sitzungsstandard	Tenant.
--timeout	Sekunden	360	Sync-polling timeout.
--poll-interval	ms	5000	Milliseconds between sync status polls.
--login-validity	Minuten	10	Minimum minutes before token expiration to trigger a refresh.

Beispiele

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

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

Datenform (--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.

---

Zugehörige Befehle

• uip solution init – Erstellen Sie ein Gerüst für die Lösung, bevor Sie Projekte hinzufügen.
• uip solution resources refresh – Synchronisierung von Ressourcen nach der Bearbeitung von Projektbindungen erneut.
• uip solution pack – Verpacken der Lösung, sobald ihre Projektliste finalisiert ist.

Siehe auch

• Ihre erste Pipeline – End-to-End-Beispiel.
• uip solution Übersicht.