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.

Remarque :

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.

Sous-commande	Objectif
add	Enregistrez un dossier de projet qui se trouve déjà dans le répertoire de la solution.
import	Copiez un dossier de projet externe dans le répertoire de la solution, puis enregistrez-le.
remove	Annule l’enregistrement d’un projet à partir du .uipx (ne supprime pas les fichiers sur le disque).
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.

Synthèse

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

Chaque sous-commande respecte les options globales et renvoie les codes de sortie standard.

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.
• Un Id unique est généré pour chaque entrée de projet ajoutée au manifeste.

---

Ajouter (Add)

Enregistrez un dossier de projet qui se trouve déjà dans le répertoire de la solution. Le chemin relatif du dossier du projet est enregistré dans .uipx, et une entrée correspondante est enregistrée dans le générateur de ressources interne de la solution.

Arguments

• <project-path> (required) — Path to the project folder. Must contain project.uiproj, project.json, or uipath.json.
• [solutionFile] (facultatif) : chemin d'accès au manifeste de la solution .uipx . Si ce champ est omis, le .uipx le plus proche se trouve en montant à partir de <project-path>.

Exemples

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

Format des données (--sortie json)

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

Modes d’échec

• Le projet se trouve en dehors du dossier de la solution. La commande refuse l'ajout avec un pointeur sur projects import, qui copie les projets externes dans.
• Project is already registered. Exits with 1 and a message naming the existing project path.

---

import

Copiez un dossier de projet externe dans le répertoire de la solution (en conservant son nom de dossier), puis enregistrez-le dans le .uipx. Utilisez cette option lorsque le projet que vous souhaitez inclure ne se trouve pas déjà sous la racine de la solution.

Arguments

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

Options

Long	Valeur (Value)	Default	Description
--solutionFile	Chemin d'accès	nearest .uipx above the current directory	Path to the .uipx solution manifest.

Exemples

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

Format des données (--sortie json)

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

Modes de défaillance et restauration

• Le dossier de destination existe déjà. La commande refuse de remplacer; renommez le dossier source ou supprimez d’abord la destination existante.
• Projet déjà dans le manifeste .uipx . Refusé avant que les fichiers ne soient copiés.
• L’étape de copie, d’écriture ou de générateur échoue. La commande est annulée: le répertoire copié est supprimé et le contenu de .uipx est restauré.

---

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.

Arguments

• <project-path> (requis) : chemin d'accès au dossier du projet à supprimer. Doit actuellement être enregistré dans le .uipx.
• [solutionFile] (facultatif) : chemin d'accès au manifeste de la solution .uipx . Par défaut, le .uipx le plus proche trouvé en remontant le <project-path>.

Exemples

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

Format des données (--sortie json)

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

Modes d’échec

• Le projet se trouve en dehors du dossier de la solution. Le chemin relatif ne doit pas commencer par ...
• Le projet n’est pas dans le manifeste. Se termine par 1 et le chemin relatif utilisé pour la recherche.
• 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.

Options

Long	Valeur (Value)	Default	Description
--solution-folder	Chemin d'accès	Répertoire actuel	Path to the solution root folder.

Exemples

uip solution projects list

Format des données (--sortie 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"
    }
  ]
}

---

Publier

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.

Options

Long	Valeur (Value)	Default	Description
--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	session par défaut	Tenant.
--timeout	secondes	360	Publish-polling timeout.
--poll-interval	ms	5000	Milliseconds between publish status polls.
--login-validity	minutes	10	Minimum minutes before token expiration to trigger a refresh.

Exemples

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

Format des données (--sortie 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.

Arguments

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

Options

Long	Valeur (Value)	Default	Description
--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	session par défaut	Tenant.
--timeout	secondes	360	Sync-polling timeout.
--poll-interval	ms	5000	Milliseconds between sync status polls.
--login-validity	minutes	10	Minimum minutes before token expiration to trigger a refresh.

Exemples

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

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

Format des données (--sortie 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.

---

Commandes associées

• uip solution init — élaboration de la solution avant d'ajouter des projets.
• uip solution resources refresh — synchronisez à nouveau les ressources après avoir modifié les liaisons du projet.
• uip solution pack — empaqueter la solution une fois sa liste de projets finalisée.

Voir également

• Votre premier pipeline — exemple de bout en bout.
• Vue d’ensemble du typeuip solution .