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.

Pipelines uip aops

Syntaxe et options pour `uip aops pipeline` et `uip aops execution`, qui gèrent les pipelines CICD et inspectent ou contrôlent leurs exécutions.

uip aops pipeline gère les pipelines CI/CD — liste, récupérer, créer, mettre à jour, exécuter, supprimer. uip aops execution inspecte et contrôle une exécution de pipeline - récupère les métadonnées, les journaux de flux, récupère les détails de la tâche ou l'arrête. Tous deux appellent le service CICD, un espace de noms d'identification distinct depuis les commandes ContrôleSource sur les pages des connexions/projets . Voir la vue d’ensembleuip aops pour les concepts partagés.

Remarque :

pipeline update <id> --file est un remplacement complet (sémantique HTTP PUT) et attend la forme EditPipelineDto , et non la PipelineDto que pipeline get renvoie par défaut. Ne passez pas pipeline get <id> > p.json directement dans update --file p.json — utilisez pipeline get <id> --for-update --output-file <path> à la place, qui écrit la forme déjà transformée.

Synthèse​

uip aops pipeline list [--repository-ids <csv>] [--offset <n>] [--limit <n>] [--search <term>]
uip aops pipeline state
uip aops pipeline processes
uip aops pipeline process <process-id>
uip aops pipeline repos
uip aops pipeline get <pipeline-id> [--for-update] [--output-file <path>]
uip aops pipeline search [--name <name> | --prefix <prefix>]
uip aops pipeline create --file <path> [--telemetry-flow-id <id>]
uip aops pipeline update <pipeline-id> --file <path>
uip aops pipeline delete <pipeline-id> -y
uip aops pipeline run <pipeline-id>
uip aops pipeline save-and-run --file <path> [--telemetry-flow-id <id>]
uip aops pipeline executions <pipeline-id> [--offset <n>] [--limit <n>]
uip aops pipeline executions-bulk --ids <csv>

uip aops execution get <execution-id> [--with-arguments]
uip aops execution logs [execution-id] [--job-key <key>] [--follow] [--limit <n>] [--poll-interval <ms>] [--timeout <ms>]
uip aops execution details [execution-id] [--job-key <key>]
uip aops execution stop [execution-id] [--job-key <key>] [--wait] [--poll-interval <ms>] [--timeout <ms>]
uip aops pipeline list [--repository-ids <csv>] [--offset <n>] [--limit <n>] [--search <term>]
uip aops pipeline state
uip aops pipeline processes
uip aops pipeline process <process-id>
uip aops pipeline repos
uip aops pipeline get <pipeline-id> [--for-update] [--output-file <path>]
uip aops pipeline search [--name <name> | --prefix <prefix>]
uip aops pipeline create --file <path> [--telemetry-flow-id <id>]
uip aops pipeline update <pipeline-id> --file <path>
uip aops pipeline delete <pipeline-id> -y
uip aops pipeline run <pipeline-id>
uip aops pipeline save-and-run --file <path> [--telemetry-flow-id <id>]
uip aops pipeline executions <pipeline-id> [--offset <n>] [--limit <n>]
uip aops pipeline executions-bulk --ids <csv>

uip aops execution get <execution-id> [--with-arguments]
uip aops execution logs [execution-id] [--job-key <key>] [--follow] [--limit <n>] [--poll-interval <ms>] [--timeout <ms>]
uip aops execution details [execution-id] [--job-key <key>]
uip aops execution stop [execution-id] [--job-key <key>] [--wait] [--poll-interval <ms>] [--timeout <ms>]

liste des pipelines uip aops​

Répertoriez les pipelines visibles dans l'environnement de runtime actif (défini via l'interface utilisateur de StudioAdmin — changez les locataires/dossiers si vous ne voyez pas ce que vous attendez).

Options​

LongValeur (Value)Description
--repository-ids <csv>Séparé par des virgulesAccédez à un ou plusieurs UUID du référentiel SC (depuis connection repos).
--offset <n>IntegerNombre à ignorer. Doit être un multiple de --limit. Par défaut 0.
--limit <n>IntegerMaximum à renvoyer. Par défaut 20.
--search <term>stringFiltre de sous-chaîne côté serveur sur le nom du pipeline.

Format des données (--sortie json)​

{
  "Code": "PipelineList",
  "Data": [
    { "PipelineId": "11111111-2222-3333-4444-555555555555", "Name": "release-main", "Repository": "automation-hub", "LastRunState": "Successful", "LastRunEnd": "2026-05-05T14:23:00.000Z" }
  ]
}
{
  "Code": "PipelineList",
  "Data": [
    { "PipelineId": "11111111-2222-3333-4444-555555555555", "Name": "release-main", "Repository": "automation-hub", "LastRunState": "Successful", "LastRunEnd": "2026-05-05T14:23:00.000Z" }
  ]
}

Une ligne sélectionnée par pipeline — utilisez pipeline get <id> pour le DTO complet, y compris la liaison de branche et de projet.

état du pipeline uip aops​

Récupérez un instantané de l'état des pipelines à l'échelle de l'environnement de runtime - comptages et état de défilement utilisés par le tableau de bord StudioAdmin. Un moyen économique de confirmer que l’environnement du runtime est accessible avant l’énumération ou la transformation.

Format des données (--sortie json)​

{ "Code": "PipelinesState", "Data": {} }
{ "Code": "PipelinesState", "Data": {} }

Processus de pipeline uip aops​

Répertoriez les processus d’automatisation auxquels les pipelines peuvent être liés.

Format des données (--sortie json)​

{
  "Code": "PipelineProcesses",
  "Data": [ { "ProcessId": "33333333-4444-5555-6666-777777777777", "Name": "InvoiceProcessing", "Description": "Daily invoice ingest", "Package": "MyOrg.Invoice.Processing", "Version": "1.2.0" } ]
}
{
  "Code": "PipelineProcesses",
  "Data": [ { "ProcessId": "33333333-4444-5555-6666-777777777777", "Name": "InvoiceProcessing", "Description": "Daily invoice ingest", "Package": "MyOrg.Invoice.Processing", "Version": "1.2.0" } ]
}

Une ligne sélectionnée par processus - utilisez le ProcessId renvoyé comme processIdentifier de PipelineDto lors de la création d'un pipeline. Explorez-en un avec pipeline process <process-id> pour obtenir le DTO complet, y compris les arguments.

Processus de pipeline uip aops​

Résoudre un processus d'automatisation unique par identifiant.

Arguments​

NomRequisObjectif
<process-id>ouiIdentificateur de processus de pipeline processes.

Format des données (--sortie json)​

{ "Code": "PipelineProcess", "Data": {} }
{ "Code": "PipelineProcess", "Data": {} }

référentiels de pipeline uip aops​

Répertoriez les référentiels de contrôle de code source qui ont au moins un pipeline.

Format des données (--sortie json)​

{ "Code": "PipelineRepos", "Data": [] }
{ "Code": "PipelineRepos", "Data": [] }

Obtenir le pipeline uip aops​

Récupérer un pipeline par identifiant.

Arguments​

NomRequisObjectif
<pipeline-id>ouiIdentifiant du pipeline de pipeline list.

Options​

LongValeur (Value)Description
--for-updateDrapeauRenvoyez la forme EditPipelineDto au lieu de la forme PipelineDto complète, avec des champs spécifiques au serveur uniquement — flux le résultat directement dans pipeline update --file sans transformation manuelle.
--output-file <path>Chemin d'accèsÉcrivez également la charge utile dans ce fichier au format JSON (UTF-8, retrait de 2 espaces). Stdout va toujours émettre l’enveloppe structurée complète.

--for-update conserve la casse propre du DTO dans Data (pas PascalCase). --output-filter s'exécute par rapport à Data sous forme imprimé et est sensible à la casse — avec --for-update, correspond aux propres noms de champ du DTO.

Exemples​

uip aops pipeline get 11111111-2222-3333-4444-555555555555

uip aops pipeline get 11111111-2222-3333-4444-555555555555 --for-update --output-file ./pipeline.json
uip aops pipeline get 11111111-2222-3333-4444-555555555555

uip aops pipeline get 11111111-2222-3333-4444-555555555555 --for-update --output-file ./pipeline.json

Format des données (--sortie json)​

{ "Code": "PipelineGet", "Data": { "identifier": "11111111-2222-3333-4444-555555555555", "name": "release-main" } }
{ "Code": "PipelineGet", "Data": { "identifier": "11111111-2222-3333-4444-555555555555", "name": "release-main" } }

Recherchez un pipeline par nom.

Options​

LongValeur (Value)Description
--name <name>stringRecherche de correspondance exacte. Renvoie un seul PipelineDto.
--prefix <prefix>stringCommence par la requête. Renvoie un tableau.

Il est obligatoire de spécifier l'un des éléments --name/--prefix - la transmission des deux, ou ni l'un ni l'autre, échoue côté client avant tout appel réseau.

Exemples​

uip aops pipeline search --name "release-main"

uip aops pipeline search --prefix "release-"
uip aops pipeline search --name "release-main"

uip aops pipeline search --prefix "release-"

Format des données (--sortie json)​

{ "Code": "PipelineSearch", "Data": {} }
{ "Code": "PipelineSearch", "Data": {} }

Aucune correspondance n’échoue avec Pipeline '<name>' not found. (pour --name) ou No pipelines matched prefix '<prefix>'. (pour --prefix) plutôt qu’une réussite vide.

création de pipeline uip aops​

Créez un nouveau pipeline à partir d'un fichier JSON conforme à PipelineDto.

Options​

LongValeur (Value)RequisDescription
--file <path>Chemin d'accèsouiFichier JSON contenant le PipelineDto à créer. N'incluez pas un identifier attribué par le serveur.
--telemetry-flow-id <id>stringnonID de flux de télémétrie pour la corrélation côté serveur.

Format des données (--sortie json)​

{ "Code": "PipelineCreated", "Data": { "identifier": "11111111-2222-3333-4444-555555555555" } }
{ "Code": "PipelineCreated", "Data": { "identifier": "11111111-2222-3333-4444-555555555555" } }

Capturez le identifier renvoyé pour les appels de suivi run/update/delete. Une erreur de conflit signifie généralement qu'un pipeline du même nom existe déjà.

mise à jour du pipeline uip aops​

Mettez à jour un pipeline existant. Remplacement complet : tout champ que le fichier omet est effacé côté serveur.

Arguments​

NomRequisObjectif
<pipeline-id>ouiPipeline à mettre à jour. Doit correspondre au champ identifier du fichier si ce champ est défini.

Options​

LongValeur (Value)RequisDescription
--file <path>Chemin d'accèsouiFichier JSON contenant le EditPipelineDto à appliquer.

Seules les propres clés de EditPipelineDto sont envoyées - un fichier portant une clé non reconnue (y compris une clé simplement mal lue) est rejeté indépendamment plutôt que de se déposer silencieusement sous forme d'effacement partiel.

Format des données (--sortie json)​

{ "Code": "PipelineUpdated", "Data": { "Pipeline": { "identifier": "11111111-2222-3333-4444-555555555555", "name": "release-main" } } }
{ "Code": "PipelineUpdated", "Data": { "Pipeline": { "identifier": "11111111-2222-3333-4444-555555555555", "name": "release-main" } } }

Data.Pipeline répète la requête qui a été envoyée, et non le fichier tel qu’il est lu à partir du disque.

suppression du pipeline uip aops​

Supprimer un pipeline par identifiant. Continu: les exécutions en cours ne sont pas arrêtées automatiquement, mais les nouvelles exécutions sont immédiatement rejetées.

Arguments​

NomRequisObjectif
<pipeline-id>ouiIdentifiant du pipeline de pipeline list.

Options​

LongDescription
-y, --yesRequis. Confirme cette opération irréversible.

Format des données (--sortie json)​

{ "Code": "PipelineDeleted", "Data": { "PipelineId": "11111111-2222-3333-4444-555555555555" } }
{ "Code": "PipelineDeleted", "Data": { "PipelineId": "11111111-2222-3333-4444-555555555555" } }

Exécution du pipeline uip aops​

Déclencher l'exécution d'un pipeline. Renvoie 202 immédiatement — l'exécution est mise en file d'attente de manière asynchrone.

Arguments​

NomRequisObjectif
<pipeline-id>ouiIdentifiant du pipeline de pipeline list.

Format des données (--sortie json)​

{ "Code": "PipelineRunStarted", "Data": { "PipelineId": "11111111-2222-3333-4444-555555555555" } }
{ "Code": "PipelineRunStarted", "Data": { "PipelineId": "11111111-2222-3333-4444-555555555555" } }

Utilisez pipeline executions <pipeline-id> pour découvrir le nouvel ID d’exécution, puis execution logs --follow pour le suivre.

uip aops pipeline enregistrer-et-exécuter​

Conservez un DTO de pipeline depuis JSON et exécutez-le immédiatement.

Options​

LongValeur (Value)RequisDescription
--file <path>Chemin d'accèsouiFichier JSON contenant le PipelineDto à enregistrer et exécuter.
--telemetry-flow-id <id>stringnonID de flux de télémétrie pour la corrélation côté serveur.

Format des données (--sortie json)​

{
  "Code": "PipelineSavedAndRunStarted",
  "Data": { "pipeline": { "identifier": "11111111-2222-3333-4444-555555555555" }, "executionId": "22222222-3333-4444-5555-666666666666" }
}
{
  "Code": "PipelineSavedAndRunStarted",
  "Data": { "pipeline": { "identifier": "11111111-2222-3333-4444-555555555555" }, "executionId": "22222222-3333-4444-5555-666666666666" }
}

executionId est supprimé du latestPipelineExecution du pipeline persistant pour un enchaînement immédiat dans execution logs --follow; il s'agit de null si le champ est absent.

exécutions de pipeline uip aops​

Répertorier les exécutions d'un pipeline.

Arguments​

NomRequisObjectif
<pipeline-id>ouiIdentifiant du pipeline de pipeline list.

Options​

LongValeur (Value)Description
--offset <n>IntegerNombre à ignorer. Doit être un multiple de --limit. Par défaut 0.
--limit <n>IntegerMaximum à renvoyer. Par défaut 20.

Format des données (--sortie json)​

{
  "Code": "PipelineExecutions",
  "Data": [ { "ExecutionId": "22222222-3333-4444-5555-666666666666", "BuildNumber": "42", "CommitRef": "0123456789abcdef0123456789abcdef01234567", "State": "Successful", "EnqueuedAt": "2026-05-05T14:21:00.000Z", "EndedAt": "2026-05-05T14:23:00.000Z" } ]
}
{
  "Code": "PipelineExecutions",
  "Data": [ { "ExecutionId": "22222222-3333-4444-5555-666666666666", "BuildNumber": "42", "CommitRef": "0123456789abcdef0123456789abcdef01234567", "State": "Successful", "EnqueuedAt": "2026-05-05T14:21:00.000Z", "EndedAt": "2026-05-05T14:23:00.000Z" } ]
}

Explorez-en un avec execution get <execution-id> pour le DTO complet (mode exécution, utilisateur déclencheur, jobExecutionIdentifier, code d'échec).

uip aops pipeline executions-Bulk​

Récupérez les métadonnées de plusieurs exécutions de pipeline dans un même aller-retour.

Options​

LongValeur (Value)RequisDescription
--ids <csv>Séparé par des virgulesouiIdentificateurs d'exécution de pipeline (depuis pipeline executions) — et non les identifiants de pipeline.

Format des données (--sortie json)​

{ "Code": "PipelineExecutionsBulk", "Data": [] }
{ "Code": "PipelineExecutionsBulk", "Data": [] }

exécution uip aops​

Inspecter et contrôler l'exécution des pipelines. Tous les verbes, à l'exception de get, acceptent soit une position <execution-id> (la CLI recherche le jobKey sous-jacent pour vous) ou --job-key <key> pour ignorer cette recherche lorsque vous l'avez déjà. get est saisi uniquement par ID d'exécution.

Obtenir l’exécution uip aops​

Récupérez les métadonnées d'une exécution de pipeline par ID d'exécution.

Arguments​
NomRequisObjectif
<execution-id>ouiDe: pipeline executions <pipeline-id>.
Options​
LongDescription
--with-argumentsRécupérez également les arguments d'entrée du runtime avec lesquels le pipeline a été exécuté (JSON analysé, ou la chaîne brute si l'analyse échoue). Un aller-retour supplémentaire.
Format des données (--sortie json)​
{ "Code": "ExecutionGet", "Data": { "identifier": "22222222-3333-4444-5555-666666666666", "state": "Successful", "inputArguments": { "ArgumentName": "value" } } }
{ "Code": "ExecutionGet", "Data": { "identifier": "22222222-3333-4444-5555-666666666666", "state": "Successful", "inputArguments": { "ArgumentName": "value" } } }

Utilisez le jobExecutionIdentifier renvoyé comme --job-key pour logs/details/stop afin d'ignorer leur recherche automatique.

journaux d’exécution uip aops​

Récupérer les journaux d'une exécution.

Arguments​
NomRequisObjectif
[execution-id]ConditionnelObligatoire si --job-key n'est pas défini; requis, que --follow soit défini (l'interrogation de l'état est exécutée sur la clé ID d'exécution).
Options​
LongValeur (Value)Description
--job-key <key>stringUtilisez cette clé de tâche directement, en évitant la recherche de l'ID d'exécution.
--followDrapeauFlux les journaux jusqu’à ce que l’exécution atteigne un état terminal (Successful/Faulted/Stopped).
--limit <n>IntegerTaille de la page par extraction de journal. Par défaut 200.
--poll-interval <ms>IntegerIntervalle entre les interrogations lorsque --follow est défini. Par défaut 2000.
--timeout <ms>IntegerDélai maximum à suivre avant d'abandonner. Par défaut 1800000 (30 minutes).

Sans --follow: imprime la tranche de journal actuelle et se termine (Code: "ExecutionLogs"). Avec --follow: les lignes de journal sont transmises à stderr dès qu'elles arrivent (non soumis à --log-level, non capturé par --log-file — rediriger explicitement stderr pour les conserver), et stdout génère une enveloppe finale avec l'état terminal et le nombre de lignes (Code: "ExecutionLogsFollowed").

Exemples​
uip aops execution logs 22222222-3333-4444-5555-666666666666

uip aops execution logs 22222222-3333-4444-5555-666666666666 --follow 2> build.log
uip aops execution logs 22222222-3333-4444-5555-666666666666

uip aops execution logs 22222222-3333-4444-5555-666666666666 --follow 2> build.log
Format des données (--sortie json)​
{ "Code": "ExecutionLogsFollowed", "Data": { "state": "Successful", "lineCount": 42 } }
{ "Code": "ExecutionLogsFollowed", "Data": { "state": "Successful", "lineCount": 42 } }

détails de l’exécution uip aops​

Récupérez le document sous-jacent des détails de l'exécution de la tâche — robot, machine, version et contexte de l'hôte. Utile lors du triage d'un échec pour voir sur quel runtime il a été exécuté.

Arguments​
NomRequisObjectif
[execution-id]ConditionnelObligatoire si --job-key n'est pas défini.
Options​
LongValeur (Value)Description
--job-key <key>stringUtilisez cette clé de tâche directement, en évitant la recherche de l'ID d'exécution.
Format des données (--sortie json)​
{ "Code": "ExecutionDetails", "Data": {} }
{ "Code": "ExecutionDetails", "Data": {} }

arrêt d’exécution uip aops​

Demander l'arrêt d'une exécution de pipeline. Idempotente : l'appeler sur une exécution déjà terminée renvoie l'état actuel sans erreur.

Arguments​
NomRequisObjectif
[execution-id]ConditionnelObligatoire si --job-key n'est pas défini; requis, que --wait soit défini.
Options​
LongValeur (Value)Description
--job-key <key>stringUtilisez cette clé de tâche directement, en évitant la recherche de l'ID d'exécution.
--waitDrapeauInterrogez jusqu'à ce que l'exécution s'installe sur le terminal au lieu de revenir immédiatement.
--poll-interval <ms>IntegerIntervalle entre les interrogations lorsque --wait est défini. Par défaut 2000.
--timeout <ms>IntegerDurée d’attente maximale lorsque --wait est défini. Par défaut 300000 (5 minutes).
Exemples​
uip aops execution stop 22222222-3333-4444-5555-666666666666

uip aops execution stop 22222222-3333-4444-5555-666666666666 --wait
uip aops execution stop 22222222-3333-4444-5555-666666666666

uip aops execution stop 22222222-3333-4444-5555-666666666666 --wait
Format des données (--sortie json)​
{ "Code": "ExecutionStopRequested", "Data": { "identifier": "22222222-3333-4444-5555-666666666666", "state": "Stopping" } }
{ "Code": "ExecutionStopRequested", "Data": { "identifier": "22222222-3333-4444-5555-666666666666", "state": "Stopping" } }

Avec --wait, l'enveloppe finale est Code: "ExecutionStopped" avec le paramètre state défini. L'appel de stop sur une exécution qui est déjà terminée renvoie Code: "ExecutionAlreadyTerminal" au lieu de relancer l'arrêt.

  • uip aops — Vue d'ensemble et concepts.
  • connections — découvrez le référentiel à partir duquel un pipeline est construit.
  • projects — découvrez le processus auquel un pipeline est lié.

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