- Vue d'ensemble (Overview)
- Démarrer
- Concepts
- Utilisation de la UiPath CLI
- UiPath pour les agents de codage
- Guides pratiques
- Revenus CI/CD
- Référence de commande
- Vue d'ensemble (Overview)
- Codes de sortie
- Options globales
- agent codé uip
- UiPath Docsai
- add-test-data-entity
- ajouter une file d'attente de données de test
- add-test-data-variation
- Analyser
- Construire
- créer-projet
- Différence
- recherche-activités
- Obtenir les règles de l'analyse
- récupérer-activité-xaml par défaut
- Récupérer les erreurs
- obtenir des cas de test manuels
- Obtenir les étapes de test manuelles
- Obtenir les versions
- exemple de workflow
- indiquer l'application
- indiquer l'élément
- inspecter-package
- install-data-fabric-entities
- installer-ou-Update-packages
- list-data-fabric-entités
- listes-exemples-workflow
- Créer un package
- restore
- Exécuter le fichier
- modèles-recherche
- Démarrer-Studio
- arrêter l'exécution
- UIA
- Traçages UIP
- Migration
- Vue d'ensemble (Overview)
- Migration depuis l’interface CLI.NET héritée
- Carte de commande (héritée vers uip)
- Indicateur des changements de nom
- Changements radicaux
- Référence et assistance
Guide de l'utilisateur de UiPath CLI
Cette page mappe des indicateurs uipcli individuels à leurs homologues uip . Utilisez-le avec la carte de commande - la carte de commande affiche le verbe à appeler; cette page indique ce qu'il faut faire avec chaque indicateur de ce verbe.
Les indicateurs sont regroupés par domaine. Authentifiez d'abord, car il change pour chaque commande à la fois. Le reste de la page couvre les indicateurs qui diffèrent par verbe: sortie de package/solution, exécution de tâche, sortie d'exécuteur de test, traçage, etc.
Les entrées d'indicateur hérité reflètent la surface d'indicateur public uipcli documentée pour 2025.10 et les versions antérieures. La colonne uip correspond aux pages de référence actuelles.
Comment lire la colonne « Où elle se trouve »
uip vous donne trois emplacements pour mettre une valeur qui était un indicateur dans uipcli:
- Indicateur sur chaque commande - transmettez-la littéralement à chaque fois (
--tenant <name>,--folder-path Shared). - État de la session à partir de
uip login— l'indicateur est devenu quelque chose que vous avez défini une fois avecuip login; les commandes suivantes le récupèrent automatiquement. Remplacez par appel par l'indicateur approprié. - Variable d'environnement — lue par la CLI au moment du runtime. Le cas échéant, préférez le formulaire de préfixe
--client-id env.VARNAME/--client-secret env.VARNAMEsuruip loginpour garder le secret en dehors de la ligne de commande.
La colonne « Où il réside» vous indique laquelle de ces situations s'applique.
Authentification
C'est le bloc qui change le plus. La CLI héritée acceptait trois modes d’informations d’identification par commande (utilisateur/passé, actualiser le jeton, application externe). La nouvelle CLI accepte uniquement les informations d’identification d’application externe et l’OAuth interactif — l’authentification par utilisateur/passif et par jeton d’actualisation est supprimée. Voir Modifications radicales - modes d'authentification supprimés.
Application externe (le flux CI)
| Indicateur hérité | Objectif hérité | uip Drapeau | Où il réside | Remarques |
|---|---|---|---|---|
-A, --accountForApp <name> | Nom de l’organisation pour l’application externe | --organization <name> | Indiquer sur uip login | Souvent facultatif: l'organisation est déduite de l'enregistrement de l'application externe. Transmettez-le lorsque vous devez désambiguiser. |
-I, --applicationId <id> | ID client de l’application externe | --client-id <id> (ou --client-id env.VARNAME ) | Indiquer sur uip login | Préférez env.VARNAME pour lire à partir d'une variable d'environnement. |
-S, --applicationSecret <secret> | Clé secrète de client d’application externe | --client-secret <secret> (ou --client-secret env.VARNAME ) | Indiquer sur uip login | Utilisez toujours le préfixe env. dans CI pour éviter de divulguer le secret dans l’historique du shell et la sortie ps . |
--applicationScope "<space-separated>" | Étendues OAuth | --scope "<space-separated>" / -s, --scope | Indiquer sur uip login | Même format séparé par des espaces. Les appels hérités répertorient généralement toutes les étendues OR.* ; Conserver la même liste. |
--identityUrl <url> | Autorité d’identité personnalisée (Automation Suite / PaaS) | --authority <url> | Indiquer sur uip login | Renommé; sémantique identique. Omit pour Automation Cloud. |
(positionnel) <orchestrator_url> | OrchestratorBaseURL | implicite de la session | L'indicateur uip login n'est pas nécessaire — la CLI résout l'URL Orchestrator du locataire/de l'organisation choisie lors de la connexion. | |
(positionnel) <orchestrator_tenant> | Nom de locataire | -t, --tenant <name> | Indicateur sur uip login (par défaut) ou par commande -t | Une fois défini lors de la connexion, toutes les commandes suivantes utilisent ce locataire; -t sur n'importe quelle commande le remplace pour cet appel. |
-o, --organizationUnit <folder> | Dossier par défaut pour la commande | --folder-path <path> ou --folder-key <guid> | Indicateur de la commande qui en a besoin | Il ne s'agit pas d'un concept au niveau de la session dans uip; le transmettre à chaque appel jobs/processes/resource * . Le fichier de configuration peut épingler les valeurs par défaut. |
Authentification utilisateur/passée — supprimée
| Indicateur hérité | Statut dans uip |
|---|---|
-u, --username <user> | a supprimé. Créez une application externe et utilisez --client-id. |
-p, --password <pass> | a supprimé. Utilisez --client-secret. |
La CLI héritée prenait en charge l’authentification utilisateur/mot de passe par rapport à Orchestrator pour les environnements où une application externe n’était pas encore enregistrée. uip ne l'est pas; consultez la section Modifications importantes - modes d'authentification supprimés.
Authentification par jeton d’actualisation — supprimée
| Indicateur hérité | Statut dans uip |
|---|---|
-t, --token <refresh-token> | a supprimé. L'héritage -t était le formulaire court de --token; dans uip, -t est la forme abrégée de --tenant. |
-a, --accountName <name> | a supprimé. Utilisez --organization avec une application externe à la place. |
Si un pipeline hérité utilisait l'authentification par jeton d'actualisation, migrez vers l'application externe. Automation Cloud n'enregistre plus le flux de jeton d'actualisation pour les nouvelles charges de travail.
Jeton en main (nouveau — aucun équivalent hérité)
Pour les conteneurs ou les exécuteurs qui détiennent déjà un jeton d'accès UiPath et n'ont pas besoin d'échanger des informations d'identification, uip prend en charge l'authentification variable: définissez UIPATH_CLI_ENABLE_ENV_AUTH=true et transmettez le jeton + org + locataire via des variables env. Voir Authentification — Flux 3. Aucun fichier n’est écrit; le jeton n'est pas actualisé.
préfixe env.var_name
uip login accepte un secret littéral sur --client-id / --client-secret, ou le formulaire de préfixe env.VAR_NAME qui lit la valeur d'une variable d'environnement au moment du runtime:
# Resolves at runtime from $UIPATH_CLIENT_SECRET; the secret never appears on the command line.
uip login \
--client-id env.UIPATH_CLIENT_ID \
--client-secret env.UIPATH_CLIENT_SECRET \
--tenant "$UIPATH_TENANT"
# Resolves at runtime from $UIPATH_CLIENT_SECRET; the secret never appears on the command line.
uip login \
--client-id env.UIPATH_CLIENT_ID \
--client-secret env.UIPATH_CLIENT_SECRET \
--tenant "$UIPATH_TENANT"
Contrairement à uipcli, uip ne lit pas implicitement UIPATH_CLIENT_ID / UIPATH_CLIENT_SECRET; vous devez les référencer via le préfixe env. (ou transmettre des valeurs littérales). Voir Authentification — env.VAR_NAME préfixe et Modifications radicales - lecture implicite env-var supprimée.
Sortie, journalisation et traçage
S'applique à chaque uipcli verbe.
| Indicateur hérité | Objectif hérité | uip Drapeau | Où il réside | Remarques |
|---|---|---|---|---|
--traceLevel <None|Critical|Error|Warning|Information|Verbose> | Commentaire du journal | --log-level <debug|info|warn|error> | Indicateur global sur chaque commande | Plage de valeurs réduite à quatre niveaux; info par défaut. Verbose → debug, Information → info, Warning → warn, tout le reste → error. Voir Options globales. |
| (texte hérité stdout; aucun indicateur) | Sortie structurée | --output <json|table|yaml|plain> | Indicateur global | La valeur par défaut est json pour chaque commande. Texte lisible par un humain imprimé; uip imprime JSON. Utilisez --output table pour la vue humaine. Voir Formats de sortie. |
| (aucun équivalent) | Sortie post-filtrage | --output-filter "<JMESPath>" | Indicateur global | Nouveautés uip. Permet aux pipelines d’extraire des champs spécifiques sans pipelines via jq. |
| (aucun équivalent) | Dupliquer les journaux dans un fichier | --log-file <path> | Indicateur global | Nouveautés uip. Ajoute des lignes JSON. |
-l, --language <locale> | Langue du journal | (aucun équivalent) | a supprimé. | La sortie du journal est en anglais dans uip. |
--captureCommandToJsonFile <path> | Sérialiser l’invocation en JSON | (aucun équivalent) | a supprimé. | Utilisé pour lecteur uipcli run, qui est également supprimé. Voir Carte de commande — Exécuter. |
Indicateurs de package
Les indicateurs PascalCase hérités deviennent kebab-case dans uip rpa. Pour chaque ligne ci-dessous, l'indicateur uip rpa pack équivalent est le nom hérité avec camelCase divisé en mots et joint à - (par exemple, --autoVersion → --auto-version). Exécutez uip rpa pack --help pour obtenir la liste complète de la version de votre outil installée.
Mise en package du package
| Indicateur hérité | uip rpa pack | Remarques |
|---|---|---|
<workspace_path> (positionnel) | <project> (positionnel) | Chemin d’accès au project.json ou au répertoire contenant. |
-o, --output <dir> | -o, --output <dir> | Même forme. Répertoire de sortie pour le fichier .nupkg généré. |
-v, --version <semver> | -v, --version <semver> | Définit la version du package. |
--autoVersion | --auto-version | Générer automatiquement la version à partir de la date/de l'horodatage. |
--outputType <Process|Library|Tests|Objects> | --output-type <Process|Library|Tests|Objects> | Forcez le type de sortie. |
--splitOutput | --split-output | Fractionnez les bibliothèques de runtime et de conception. |
--releaseNotes <text> | --release-notes <text> | Intégré dans les métadonnées .nupkg . |
--repositoryUrl, --repositoryCommit, --repositoryBranch, --repositoryType | --repository-url, --repository-commit, --repository-branch, --repository-type | Métadonnées VCS. |
--projectUrl <url> | --project-url <url> | URL de l'idée Automation Hub. |
--certificatePath, --certificatePassword, --timestampServerUrl | --certificate-path, --certificate-password, --timestamp-server-url | Signature du code. |
--author <name> | --author <name> | Auteur du package. |
--governanceFilePath <policy> | --governance-file-path <policy> | Exécuter l’analyseur dans le cadre du pack. |
Authentification de la bibliothèque (--libraryOrchestratorUrl, --libraryOrchestratorTenant, -u/-p/-t/-a/-A/-I/-S, --libraryOrchestratorApplicationScope, --libraryOrchestratorFolder, --libraryIdentityUrl, --libraryOrchestratorAccountForApp, --libraryOrchestratorAccountName, --libraryOrchestratorApplicationId, --libraryOrchestratorApplicationSecret, --libraryOrchestratorUsername, --libraryOrchestratorPassword, --libraryOrchestratorAuthToken) | Session depuis uip login | Tous les library* indicateurs d'authentification sont intégrés dans la session unique configurée par uip login. L'agent est hors ligne, sauf lorsqu'il doit résoudre les dépendances de bibliothèque à partir d'un flux privé; dans ce cas, la CLI utilise la session active. |
Analyse des packages
| Indicateur hérité | uip rpa analyze |
|---|---|
<workspace_path> (positionnel) | <project> (positionnel) |
--governanceFilePath <policy> | --governance-file-path <policy> |
--analyzerTraceLevel <Off|Error|Warning|Info|Verbose> | (pas encore documenté) |
--stopOnRuleViolation | (pas encore documenté — probablement un seuil de gravité) |
--treatWarningsAsErrors | (pas encore documenté) |
--resultPath <path> | (pas encore documenté) |
--ignoredRules <id1,id2> | (pas encore documenté) |
Déploiement du paquet
L'héritage deploy correspond désormais à deux appels uip ; consultez la section Carte de commande - déploiement du package. Par indicateur:
| Indicateur hérité | uip équivalent | Remarques |
|---|---|---|
<packages_path> (positionnel) | <file> (positionné sur uip or packages upload) | Fichier unique. Pour un dossier de .nupkgs, bouclez dans le shell. |
<orchestrator_url> (positionnel) | (session) | Déposez-le; fourni par uip login. |
<orchestrator_tenant> (positionnel) | -t, --tenant sur uip login ou la commande | La valeur par défaut est la session. |
-c, --createProcess <true|false> | implicite | uip or packages upload ne crée jamais le processus. Appelez uip or processes create après le téléchargement si vous souhaitez un processus. |
--processName <name> | --name <name> activé uip or processes create | Renommé; Remarque: --process <name> n'existe pas sur la nouvelle CLI. |
--processNames <csv> | (boucle dans le shell — aucun équivalent direct) | Scriptez l'itération du fichier CSV; appeler processes create par ligne. |
--processDescription <text> | -d, --description <text> activé uip or processes create | |
--use-package-description | (comportement par défaut) | processes create hérite de la description du paquet par défaut lors de la création. |
--ignoreLibraryDeployConflict | (aucun équivalent) | les téléchargements de bibliothèque via uip resource libraries upload échouent proprement sur la version en double; ajuster la logique du pipeline à ignorer si la version existe déjà. |
-e, --environments <csv> | (aucun équivalent; dossiers modernes uniquement) | Le concept « environnements» du dossier classique hérité n'est pas représenté dans le modèle de dossier moderne. |
-h, --entryPointsPath <csv> | --entry-point <path> activé uip or processes create | Point d’entrée unique par appel; boucle pour les packages multi-points d'entrée. |
restauration du package
| Indicateur hérité | uip rpa restore |
|---|---|
<workspace_path> (positionnel) | <project> (positionnel) |
--restoreFolder <dir> | [outputPath] (positionnel) |
--nugetConfigFilePath <path> | (pas encore documenté) |
| Indicateurs d’authentification de bibliothèque | Session depuis uip login |
Indicateurs de tâche (exécution de tâche uipcli → uip ou démarrage de tâches)
| Indicateur hérité | uip or jobs start | Remarques |
|---|---|---|
<process_name> (positionnel) | <process-key> (positionnel) | GUID, pas de nom. Résolvez avec uip or processes list --name <name> --output-filter 'Data[0].Key' --output plain. |
<orchestrator_url> (positionnel) | (session) | — |
<orchestrator_tenant> (positionnel) | -t, --tenant | La valeur par défaut est la session. |
-i, --input_path <file> | --input-file <path> (fichier) ou --input-arguments '<json>' (inline) | Deux alternatives s'excluant mutuellement. |
-P, --priority <Low|Normal|High> | --job-priority <Low|Normal|High> | — |
-j, --jobscount <n> | --jobs-count <n> | — |
-r, --robots <csv> | (pas d'équivalent direct) | Dossier classique uniquement hérité. Utilisez --machine-keys ou --user-keys pour les dossiers modernes. |
-U, --user <user> | --user-keys <guid[,guid]> | Vous devez d'abord résoudre le nom d'utilisateur en un GUID d'utilisateur (uip or users list). |
-M, --machine <hostname> | --machine-keys <guid[,guid]> | Vous devez d'abord résoudre le nom d'hôte en un GUID de machine (uip or machines list). |
-R, --result_path <file> | (direction stdout ou utilisation --output-filter) | uip imprime l'enveloppe de la tâche au format stdout. uip or jobs start <key> --wait-for-completion > result.json écrit l'enveloppe complète. |
-W, --timeout <seconds> | --timeout <seconds> | Nécessite --wait-for-completion. |
-f, --fail_when_job_fails <true|false> | (toujours activé) | Avec --wait-for-completion, le code de sortie est 1 si la tâche se termine Faulted. Pas de refus. |
-w, --wait <true|false> | --wait-for-completion (indicateur) | Le nouveau formulaire est un indicateur booléen (aucune valeur). |
-b, --job_type <Unattended|NonProduction> | --runtime-type <Unattended|Headless|Serverless|NonProduction|Development|TestAutomation> | Enum plus large. |
-o, --organizationUnit <folder> | --folder-path <path> ou --folder-key <guid> | Ou omettre - uip infère le dossier à partir de la clé du processus. |
Indicateurs de test
uipcli test → exécution des ensembles de tests uip tm + uip tm attente + uip tm rapport obtenir
| Indicateur hérité | uip target | Remarques |
|---|---|---|
-s, --testset <name> | --test-set-key <key> activé uip tm testsets run | Clé, pas de nom. Formater PROJECT:NN. Résolvez avec uip tm testsets list --project-key <key> |
-t, --testsetkey <key> | --test-set-key <key> | Même valeur. Remarque: l'ancien -t correspond au nouveau fichier CLI -t, --tenant; utiliser le formulaire long. |
-P, --project-path <project.json> | (révision) | Le flux de compression et de test à la volée hérité est divisé: uip rpa pack → uip or packages upload → auteur test défini dans Test Manager → uip tm testsets run. La création de l’ensemble de tests est une configuration unique. |
-a, --projectKey <key> | --project-key <key> sur uip tm wait / uip tm report get | Différent projectKey: l'indicateur hérité définir projectKey pour Test Manager; le nouvel indicateur étend l'attente/le rapport à un projet Test Manager. Même valeur sous-jacente. |
-e, --environment <name> | (aucun équivalent) | Concept de dossier classique. |
-o, --organizationUnit <folder> | --folder-path <path> activé uip tm testsets list | Utilisé pour trouver l'ensemble de test; pas sur execute |
--out <junit|uipath> | --output-format <junit|uipath> activé uip tm result download | Télécharger après l'exécution. |
-r, --result_path <file> | --destination <path> activé uip tm result download | Télécharger après l'exécution. |
-w, --timeout <seconds> | --timeout <seconds> activé uip tm wait | Mêmes sémantiques, verbe différent. |
-i, --input_path <file> | --input-path <file> activé uip tm testsets run | Exactement le même indicateur; Le schéma du fichier JSON est inchangé. |
--attachRobotLogs | (utilisez uip tm attachment download après l'exécution) | |
--retryCount <n> | uip tm executions retry --execution-id <id> | Réexécute les cas ayant échoué. Aucune nouvelle tentative automatique au lancement. |
--repositoryUrl, --repositoryCommit, --repositoryBranch, --repositoryType, --projectUrl, --releaseNotes, --disableBuiltInNugetFeeds, --nugetConfigFilePath, --author | (pas sur uip tm) | Il s'agissait d'entrées côté compressé lorsque test run devait d'abord compresser. Ils appartiennent à uip rpa pack. |
Parallèle de test uipcli
| Indicateur hérité | uip équivalent |
|---|---|
--testsConfigurationFilePath <file> | (aucun équivalent) — écrivez une boucle shell sur uip tm testsets run |
--projectsRootDirectoryPath <dir> | (aucun équivalent) |
--executionArtifactsDirectoryPath <dir> | --destination <path> sur uip tm result download et uip tm attachment download, exécuté par exécution |
--cliDirectoryPath <uipcli.dll> | (aucun équivalent) |
--out <junit|uipath> | --output-format activé uip tm result download |
--disableBuiltInNugetFeeds | (pas sur uip tm; utiliser sur uip rpa pack lors de la compression des projets de test) |
--projectKey <key> | --project-key <key> |
--author <name> | (pas sur uip tm) |
Indicateurs de ressource
Les deux verbes hérités (asset deploy et asset delete) utilisaient un fichier CSV; la nouvelle CLI n’a pas de déploiement en bloc — une boucle sur les lignes CSV et l’appel uip resource assets create / delete par ligne. Voir Carte de commande — ressource.
| Indicateur hérité | uip équivalent | Remarques |
|---|---|---|
<assets_file> (positionnel) | (analyser le fichier CSV dans le shell) | — |
<orchestrator_url> (positionnel) | (session) | — |
<orchestrator_tenant> (positionnel) | -t, --tenant | — |
Colonne CSV name | <name> (positionnel) sur uip resource assets create | — |
Colonne CSV value | <value> (positionnel) | — |
Colonne CSV type | --type <Text|Bool|Integer|Credential|Secret> | Insensible à la casse. |
Colonne CSV description | -d, --description <text> | — |
Indicateurs de solution
La structure des verbes est globalement conservée; les noms d'indicateur ont été normalisés en kebab-case et le bloc d'authentification a été réduit à la session.
| Indicateur hérité (entre les verbes) | uip équivalent | Remarques |
|---|---|---|
-o, --output <dir> activé solution pack | (position <outputPath>) | — |
-v, --version <semver> activé solution pack | --version <semver> | — |
-n, --name <name> activé solution pack | --name <name> | — |
Bloc d'authentification (sur chaque solution verbe qui affecte Orchestrator) | Session depuis uip login | — |
--packageName <n> activé solution deploy | --package-name <n> activé uip solution deploy run | — |
--packageVersion <v> activé solution deploy | --package-version <v> | — |
--folderName <n> activé solution deploy | --folder-name <n> | — |
Position <deploymentName> sur solution deploy-activate / solution deploy-uninstall | <deployment-name> sur uip solution deploy activate / uip solution deploy uninstall | — |
Télémétrie et indicateurs masqués
| Indicateur hérité | État (Status) |
|---|---|
-y, --disableTelemetry (masqué) | Remplacé par env var UIPATH_TELEMETRY_DISABLED=1. Consultez Nouveautés — Télémétrie. |
--origin (masqué) | a supprimé. |
--captureCommandToJsonFile (masqué) | Supprimé avec uipcli run. |
Voir également
- Carte de commande — mappage par verbe avec des extraits avant/après.
- Changements radicaux — auth, env vars, codes de sortie, format stdout.
- Authentification — les trois flux d'authentification pris en charge.
- Configuration — Variables d'environnement et priorité des indicateurs.
- Options globales —
--output,--output-filter,--log-level,--log-file.
- Comment lire la colonne « Où elle se trouve »
- Authentification
- Application externe (le flux CI)
- Authentification utilisateur/passée — supprimée
- Authentification par jeton d’actualisation — supprimée
- Jeton en main (nouveau — aucun équivalent hérité)
- préfixe env.var_name
- Sortie, journalisation et traçage
- Indicateurs de package
- Mise en package du package
- Analyse des packages
- Déploiement du paquet
- restauration du package
- Indicateurs de tâche (exécution de tâche uipcli → uip ou démarrage de tâches)
- Indicateurs de test
- uipcli test → exécution des ensembles de tests uip tm + uip tm attente + uip tm rapport obtenir
- Parallèle de test uipcli
- Indicateurs de ressource
- Indicateurs de solution
- Télémétrie et indicateurs masqués
- Voir également