UiPath Documentation
uipath-cli
latest
false
Guide de l'utilisateur de UiPath CLI
Important :
Ce contenu a été traduit à l'aide d'une traduction automatique. La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.

projets de solution uip

Syntaxe et options pour `uip solution projects`, qui gère les projets répertoriés dans un manifeste de solution `.uipx`, plus la publication et la synchronisation de projets cloud.

uip solution projects gère les projets répertoriés dans un manifeste de solution .uipx — Processus RPA, tests, agents, flux Maestro, cas et projets BPMN, applications codées, fonctions, workflows d'API et autres types de projets modifiables. Une bibliothèque n'est pas un projet - publiez-la sur sa propre machine, puis joignez-la avec uip solution resources add --source remote --kind Library

Remarque :

Ce groupe était précédemment documenté sous la forme project (singulaire). Le formulaire unique fonctionne toujours - il est conservé en tant qu'alias masqué et obsolète pour la rétrocompatibilité - mais projects est canonique à l'avenir.

Sous-commandeObjectif
addEnregistrez un dossier de projet qui se trouve déjà dans le répertoire de la solution.
importCopiez un dossier de projet externe dans le répertoire de la solution, puis enregistrez-le.
removeAnnule l’enregistrement d’un projet à partir du .uipx (ne supprime pas les fichiers sur le disque).
listRépertoriez les projets enregistrés dans le fichier .uipx local.
publishPubliez un projet de solution cloud sous forme de package de solution.
resyncSynchronisez ou réinitialisez un projet de solution cloud .

add, import, remove et list fonctionnent uniquement sur les fichiers locaux; aucune authentification n’est requise. publish et resync fonctionnent sur un projet de solution cloud et nécessitent une session active.

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

Comportement commun (ajouter/importer/supprimer)​

  • Le dossier de projet cible doit contenir un descripteur project.uiproj, hérité project.json ou uipath.json . La commande détecte automatiquement lequel.
  • Lorsque [solutionFile] est omis, la commande recherche vers le haut à partir du chemin du projet (ou du répertoire actuel, pour import) pour le .uipx le plus proche. Si aucun n'est trouvé, ou si plusieurs fichiers .uipx se trouvent dans le même dossier, la commande échouera et se fermera avec 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> (obligatoire) : chemin d'accès au dossier du projet. Doit contenir project.uiproj, project.json ou 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
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"
  }
}
{
  "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.
  • Le projet est déjà enregistré. Se termine par 1 et un message nommant le chemin du projet existant.

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> (obligatoire) : chemin d'accès au dossier du projet externe à importer. Doit être un répertoire contenant project.uiproj, project.json ou uipath.json. Il s'agit d'un argument de position, et non d'un indicateur - les documents antérieurs sur cette page l'affichaient comme --source <path>, ce qui est faux.

Options​

LongValeur (Value)DefaultDescription
--solutionFileChemin d'accès.uipx le plus proche au-dessus du répertoire actuelChemin d’accès au manifeste de la solution .uipx.

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
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"
  }
}
{
  "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​

Annulez l’inscription d’un projet au manifeste de .uipx solution et supprimez son entrée du générateur de ressources internes. Les fichiers sur le disque ne sont pas supprimés. Refuser de supprimer le dernier projet dans une solution (un Projects[] vide n’est valide qu’immédiatement après init) — l’exception est un projet d’un type non pris en charge, qui peut toujours être supprimé pour débloquer 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
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"
  }
}
{
  "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.
  • Le projet est le seul projet restant dans la solution. Refusé, sauf s’il s’agit d’un type de projet non pris en charge.

Répertoriez les projets enregistrés dans le manifeste de .uipx solution locale. Lit uniquement les métadonnées sur le disque — aucun appel backend.

Options​

LongValeur (Value)DefaultDescription
--solution-folderChemin d'accèsRépertoire actuelChemin d’accès au dossier racine de la solution.

Exemples​

uip solution projects list
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"
    }
  ]
}
{
  "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​

Publiez un projet de solution cloud (un projet qui existe déjà dans Automation Cloud, et non un projet .uipx local) en tant que package de solution, et attendez la fin de l’opération de publication.

Options​

LongValeur (Value)DefaultDescription
--project-nametext—Requis. Nom du projet de solution cloud à publier.
--package-nametext—Requis. Nom de package de solution à créer.
--package-versiontext—Requis. Version du package de solution à créer.
--folder-nametext—Nom du dossier racine à stocker dans le package de solution.
--descriptiontext—Description du package de solutions.
--release-notestext—Notes de version du package de solutions.
-t, --tenantnamesession par défautlocataire.
--timeoutsecondes360Délai d'attente de la publication d'interrogation.
--poll-intervalms5000Millisecondes entre les interrogations du statut de publication.
--login-validityminutes10Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation.

Exemples​

uip solution projects publish --project-name MyProject \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution
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"
  }
}
{
  "Code": "SolutionProjectPublish",
  "Data": {
    "ProjectName": "MyProject",
    "PackageName": "my-package",
    "PackageVersion": "1.0.0",
    "Status": "Completed"
  }
}

Resynchroniser​

Synchronisez ou réinitialisez un projet de solution cloud et attendez la fin de l'opération. Sync réconcilier le projet avec sa source; Reset ignore les modifications apportées au cloud local.

Arguments​

  • [project-name] (facultatif) — Nom du projet de solution cloud à synchroniser. Peut également être fourni avec --project-name; fournir les deux avec des valeurs différentes est une erreur.

Options​

LongValeur (Value)DefaultDescription
--project-nametext—Nom du projet de solution cloud à synchroniser (alternative à l’argument de position).
--sync-optionSync | ResetSyncQuelle opération de synchronisation exécuter.
-t, --tenantnamesession par défautlocataire.
--timeoutsecondes360Délai d'attente de l'interrogation par synchronisation.
--poll-intervalms5000Millisecondes entre les interrogations de l’état de synchronisation.
--login-validityminutes10Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation.

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
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": []
  }
}
{
  "Code": "SolutionProjectResync",
  "Data": {
    "ProjectName": "MyProject",
    "Status": "Successful",
    "SyncOption": "Sync",
    "SyncErrors": []
  }
}

En cas d'échec, Instructions répertorie chaque erreur de synchronisation par nom de service et par clés de ressource affectées.


Voir également​

Cette page vous a-t-elle été utile ?

Connecter

Besoin d'aide ? Assistance

Vous souhaitez apprendre ? UiPath Academy

Vous avez des questions ? UiPath Forum

Rester à jour