- 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
- Référence et assistance
Guide de l'utilisateur de UiPath CLI
uip rpa est l'outil RPA — le lien entre la CLI et une installation d'UiPath Studio. Il regroupe les projets Studio dans .nupkg archives, exécute l'analyseur et le compilateur de workflow, élabore et exécute les projets et expose les opérations Studio utilisées par les agents de codage d'IA et le système de compétences.
Installez-le avec uip tools install rpa, ou invoquez uip rpa … et laissez l’installation automatique s’exécuter. Voir Outils pour le modèle d'installation et Outils uip pour la commande qui gère l'installation de l'outil. rpa est le préfixe de la commande; le package sous-jacent est @uipath/rpa-tool.
Avant d'exécuter les verbes du package dans CI ou sur une nouvelle machine, assurez-vous que votre runtime et votre système d'exploitation d'exécution correspondent à la version du projet - voir Conditions préalables.
Commandes
Chaque uip rpa verbe a sa propre page de référence. Pour les listes d’arguments en direct sur votre version d’outil installée, exécutez uip rpa <verb> --help
| Verbe | Description |
|---|---|
add-test-data-entity | Ajoutez une entité Data Service en tant que source de données pour un cas de test. |
add-test-data-queue | Ajoutez une file d'attente de données de test d'Orchestrator comme source de données pour un cas de test. |
add-test-data-variation | Ajoutez un fichier de variation de données CSV / Excel à un cas de test. |
analyze | Exécutez l'analyseur de workflow par rapport à un projet avec une politique de gouvernance. |
build | Compilez un projet Studio sans produire de .nupkg. |
create-project | Élaborer un nouveau projet à partir d'un modèle. |
diff | Affichez les différences entre deux fichiers dans une fenêtre Diff de Studio. |
find-activities | Recherchez des activités correspondant à une requête et à des balises facultatives. |
get-analyzer-rules | Répertoriez les règles activées de l'analyseur de workflow pour le projet ouvert. |
get-default-activity-xaml | Récupérez la représentation XAML d'une activité avec des valeurs par défaut. |
get-errors | Récupérez les diagnostics d'un fichier ou du projet entier, filtrés par gravité. |
get-manual-test-cases | Obtenez des cas de test manuels à partir de Test Manager. |
get-manual-test-steps | Obtenez des étapes de test manuelles pour obtenir une liste d’ID de cas de test. |
get-versions | Répertorie les versions disponibles d'un package NuGet dans les flux configurés. |
get-workflow-example | Récupérez le XAML d'un exemple de workflow par clé. |
indicate-application | Indiquez une application à l’écran à l’aide de Studio. |
indicate-element | Indiquez un élément d’IU à l’écran à l’aide de Studio. |
inspect-package | Inspectez l'API publique d'un package NuGet via une réflexion. |
install-data-fabric-entities | Ajoutez ou supprimez des liaisons d'entité Data Fabric sur le projet actif. |
install-or-update-packages | Installez ou mettez à jour les packages NuGet dans le projet actuel. |
list-data-fabric-entities | Répertoriez les entités Data Fabric pertinentes pour le projet actif. |
list-workflow-examples | Recherchez des exemples de workflow RPA par balise de service. |
pack | Créez un package d'un projet Studio dans un .nupkg. |
restore | Téléchargez les dépendances déclarées dans project.json. |
run-file | Exécutez ou déboguez un workflow/un fichier codé. |
search-templates | Rechercher des modèles de projet dans des flux NuGet configurés. |
start-studio | Assurez-vous qu'une instance Studio est en cours d'exécution. |
stop-execution | Arrêtez une exécution en cours précédemment démarrée avec run-file. |
uia | Sous-groupe CLI UI Automation. |
list-instances est également enregistré, masqué dans --help — il répertorie les instances Studio en cours d'exécution visibles par le réviseur.
Synthèse
uip rpa pack <project> [options]
uip rpa build <projectDir> [options]
uip rpa analyze <project> --governance-file-path <policy> [options]
uip rpa restore <project> [outputPath] [options]
uip rpa start-studio [options]
uip rpa <verb> [options]
uip rpa pack <project> [options]
uip rpa build <projectDir> [options]
uip rpa analyze <project> --governance-file-path <policy> [options]
uip rpa restore <project> [outputPath] [options]
uip rpa start-studio [options]
uip rpa <verb> [options]
Tous les verbes uip rpa respectent les options globales (--output, --output-filter, --log-level, --log-file). Les codes de sortie standard s'appliquent.
Le groupe parent uip rpa accepte un petit ensemble d'options partagées par chaque verbe:
| Option parent | Description |
|---|---|
--project-dir <path> | Répertoire du projet sur lequel le verbe fonctionne. La valeur par défaut est le répertoire de travail actuel. |
--studio-dir <path> | Chemin d’accès à une installation de Studio lorsque la découverte ne peut pas en trouver une automatiquement. |
--robot-dir <path> | Chemin d’accès au répertoire d’installation du robot. |
--timeout <seconds> | Attente maximale pour l’opération sous-jacente. Par défaut: 300. |
--verbose | Journalisation détaillée. |
Ceux-ci peuvent être transmis avant ou après le nom de la sous-commande.
Aire d'indicateur
Les pages par verbe documentent les options principales. Étant donné que rpa-tool intègre le package Studio, une poignée d'indicateurs de package de créneau (matériel de signature, configuration des sources NuGet, filtres de type de sortie) suit les indicateurs natifs du package sous-jacent - exécutez uip rpa <verb> --help sur une installation en direct pour voir l'ensemble complet pour votre version de l’outil installée. Les noms d'indicateurs sont cohérents pour toutes les versions d'outils au sein de la ligne MAJOR.MINOR de la CLI; voir Contrôle de version et stabilité.
wrapper hérité Windows uniquement
Un outil frères, @uipath/rpa-legacy-tool (alias rpa-legacy), encapsule la version de la CLI .NET héritée 2025.10 pour les utilisateurs qui ont besoin de fonctionnalités Windows uniquement qui n'ont pas encore été portées à la multiplate-forme uip rpa. Il expose uip rpa-legacy <verb> pour package, validate, debug, find-package, find-activities et type-definition. Consultez la documentation de l'interface CLI.NET héritée 2025.10 pour connaître la référence de son indicateur. rpa-legacy est uniquement Windows; rpa couvre l'interface moderne.
Prérequis
Deux contraintes environnementales régissent quand et où les verbes du package peuvent s'exécuter.
Exécution.NET
Les verbes du package (pack, build, analyze, restore) encapsulent le package Studio et le compilateur de workflow — tous deux basés sur.NET. Un exécuteur qui l'invoque doit avoir un runtime.NET disponible.
Pour connaître le contexte complet de la raison pour laquelle rpa-tool conserve une dépendance.NET tandis que le reste de la CLI s’exécute sur Node.js, consultez Changements de rupture - Modification du runtime.
Système d'exploitation Trainer pour les projets Windows
Les projets Studio sont disponibles dans deux versions non héritées: multiplate-forme (targetFramework: "Portable" dans project.json) et Windows (targetFramework: "Windows"). Le système d'exploitation d'exécution doit correspondre à la version du projet:
- Les projets multiplate-formes peuvent être activés à partir de n’importe quel système d’exploitation: Windows, macOS ou Linux.
- Les projets Windows nécessitent un exécuteur Windows, quel que soit le verbe exécuté. La chaîne d’outils Linux et macOS ne peut pas résoudre les références Windows uniquement que ces projets extraient.
- Les projets hérités depuis Windows sont une catégorie distincte - ils nécessitent l'outil
uip rpa-legacy, qui est Windows uniquement par conception.
Faites correspondre le système d'exploitation du runtime dans votre CI à la saveur du projet, ou divisez le pipeline afin que le travail multiplateforme s'exécute sur Linux/macOS et que le travail de projet Windows s'exécute sur un agent Windows.
Voir également
- Outils (extensions) — installez le modèle pour
@uipath/rpa-tool. - Migration depuis la CLI.NET — carte complète de commande à commande pour les verbes du package.
uip tools— installer et gérer les outils.- Contrôle des versions et stabilité — contrat du serveur pour les versions d'outils.
- Compétences - comment les agents de codage d'IA pilotent
uip rpaverbes.