- Vue d'ensemble (Overview)
- Démarrer
- Concepts
- Utilisation de la UiPath CLI
- Guides pratiques
- Revenus CI/CD
- Référence de commande
- Vue d'ensemble (Overview)
- Codes de sortie
- Options globales
- agent codé uip
- encodeur UIP
- uip ancrage dans le contexte
- UiPath Docsai
- Fonction UiP
- garde-fous UiP
- configuration llm uip
- uip llm-passerelle
- uip model-hub
- Tâches (Jobs)
- Dossiers
- Processus
- Paquets
- Machines
- Utilisateurs
- Rôles
- Licences
- Flux
- Pièces jointes (Attachments)
- Sessions
- Calendriers
- magasins d'informations d’identification
- journaux-audit
- paramètres
- Actifs
- Compartiments
- Compartiment-fichiers
- Bibliothèques
- Files d'attente (Queues)
- éléments de la file d'attente
- Déclencheurs (Triggers)
- Webhooks
- 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
- Get-Library-Object-Repository
- Récupérer le référentiel d'objets
- 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
- instances-liste
- listes-exemples-workflow
- Créer un package
- Publier
- Distant
- restore
- exécuter, déboguer et amp; Exécution
- Exécuter le fichier
- modèles-recherche
- Démarrer-Studio
- arrêter l'exécution
- TM
- UIA
- tâches UIP
- Traçages UIP
- Commentaires sur les traces UIP
- Migration
- Référence et assistance
Syntaxe et options pour `uip rpa run-file`, qui exécute ou débogue un workflow ou un fichier codé, avec prise en charge des options de démarrage, de pause, de séquence et de point d'arrêt.
uip rpa run-file exécute ou débogue un workflow ou un fichier codé. Le même verbe couvre le cycle de vie complet de l'exécution — démarrer, suspendre, reprendre, étape, redémarrer, arrêter, activer/désactiver un point d'arrêt — sélectionné par l'indicateur --command . Il s'agit de la passerelle entre un script ou un agent d'IA et le débogueur de Studio.
L'exécution se produit via Studio, de sorte que la commande ne fonctionne que sur les exécuteurs Windows (Studio est uniquement compatible Windows). Si Studio n'est pas déjà en cours d'exécution, l'outil l'affiche automatiquement. Exécuter uip rpa start-studio est d'abord facultatif, mais utile lorsque vous souhaitez que le coût de démarrage soit payé dans une étape de configuration dédiée.
run-file est désormais un alias hérité masqué - il fonctionne toujours, mais la source actuelle (tool-names.ts, CLI_DERIVED_COMMANDS) divise cette même opération sous-jacente en une famille détectable de verbes de haut niveau: uip rpa run (démarrer l’exécution), uip rpa debug start / start-from-here / test-activity / break / continue / resume / continue-retry / continue-ignore / step-into / step-over / step-out / state / set-breakpoints / apply-file-changes / toggle-breakpoint / restart-from-top et uip rpa execution cancel (remplace stop-execution). Chaque verbe dérivé prend uniquement les indicateurs qui lui sont pertinents, plutôt qu’une enum --command avec la liste complète des 19 valeurs. Les exemples de cette page fonctionnent toujours aujourd'hui via l'alias masqué - voir uip rpa run, debug & execution pour la surface principale actuelle.
Synthèse
uip rpa run-file --file-path <path> [--command <verb>] [options]
uip rpa run-file --file-path <path> [--command <verb>] [options]
Options
| Drapeau | Description |
|---|---|
--file-path <string> | Requis. Chemin d'accès au fichier à exécuter — workflow .xaml ou workflow codé .cs . |
--command <verb> | Que faire. La valeur par défaut est StartExecution. Voir les verbes de commande ci-dessous. |
--input-arguments <json> | Objet JSON avec des arguments d'entrée au niveau du projet. Utilisé par toutes les commandes. Pour StartExecution / StartDebugging, les valeurs sont en JSON brut ({"name":"John","age":30}). Pour TestActivity / StartDebuggingFromHere, les valeurs sont des expressions VB.NET ou C#. |
--input-variables <json> | Objet JSON avec des valeurs de variables au niveau du workflow. S'applique uniquement à TestActivity et StartDebuggingFromHere. Les valeurs sont des expressions de langage, et non des littéraux JSON. |
--log-level <level> | Niveau de journalisation minimum inclus dans le flux de sortie — Verbose, Trace, Information, Warning, Error, Critical La valeur par défaut est Trace. |
--skip-build | Ignorer la validation et la création pour StartExecution / StartDebugging. Supposons que le projet a déjà été créé — à utiliser pour une réexécution rapide lorsque le projet n'a pas changé. |
Pour obtenir la liste complète des options de votre version d'outil installée, exécutez:
uip rpa run-file --help
uip rpa run-file --help
Verbes de commande
L'indicateur --command couvre deux modes d'exécution: l'exécution non-debug et le contrôle de débogage. Les verbes sont sensibles à la casse et sont transmis à Studio.
Exécution
| Verbe | Effet |
|---|---|
StartExecution (par défaut) | Exécutez le workflow sur --file-path. Aucun débogueur joint. |
StartDebugging | Démarrez une session de débogage du workflow. |
Stop | Arrêtez la session d’exécution ou de débogage en cours. |
ForceSessionEnded | Forcez la fin de la session en cours si l'arrêt normal est bloqué. |
Contrôle du débogueur
| Verbe | Effet |
|---|---|
Break | Mettre en pause l'exécution. |
Continue | Reprenez à partir d'un état suspendu. |
Resume | Reprenez à partir d'un état suspendu. |
ContinueRetry | Reprendre; si elle est suspendue sur une exception, réessayez l'activité actuelle. |
ContinueIgnore | Reprendre; s'il est suspendu sur une exception, avaler l'exception. |
StepInto / StepOver / StepOut | Étape dans le sens standard du débogueur. |
RestartFromTop | Redémarrez le débogage depuis le début. |
ToggleBreakpoint | Activez un point d'arrêt au niveau de l'activité (.xaml) ou de la ligne (.cs) ciblée. Cycles XAML activés → désactivés → aucun; du cycle de workflows codés activé/désactivé. |
TestActivity | Isolez et exécutez l'activité ciblée, avec --input-variables / --input-arguments fournissant des expressions dans l'étendue. |
StartDebuggingFromHere | Commencez le débogage à partir de l’activité ciblée, en ignorant tout ce qui le précède. |
GetDebugState | Indiquez l’état actuel de la session de débogage sans impact secondaire (None lorsqu’aucune session n’est active). Toujours une sonde instantanée sur le backend de Studio; sur le backend Helm, il peut interroger longuement pour le prochain état stable. |
SetBreakpoints | Remplacez l’ensemble de points d’arrêt de la session de débogage active par --breakpoints. Helm backend uniquement — sur le backend de Studio, définissez des points d'arrêt via ToggleBreakpoint ou en les transmettant à StartDebugging à la place. |
ApplyFileChanges | Lorsque vous êtes en pause/suspendu dans une session de débogage, réconciliez les modifications de la propriété de l'activité sur le disque dans la session en cours d'exécution via le rechargement à grande échelle, afin qu'il les récupère sans redémarrage. Modifiez d'abord le fichier, puis appelez ce nom ce qui a changé. Renvoie { applied, rejected, debugState } au lieu d'un résultat d'exécution — les modifications structurées (non réutilisables) sont rejetées et nécessitent un redémarrage de la session. |
Exemples
# Run a workflow with input arguments
uip rpa run-file \
--file-path ./Main.xaml \
--input-arguments '{"customerId": "ACME-1234"}'
# Start a debug session
uip rpa run-file \
--file-path ./Main.xaml \
--command StartDebugging
# Toggle a breakpoint at the focused activity, then start debugging
uip rpa run-file --file-path ./Main.xaml --command ToggleBreakpoint
uip rpa run-file --file-path ./Main.xaml --command StartDebugging
# Test a single activity with a custom variable expression (VB.NET project)
uip rpa run-file \
--file-path ./Main.xaml \
--command TestActivity \
--input-variables '{"greeting": "\"Hello World\""}'
# Stop a runaway session
uip rpa run-file --file-path ./Main.xaml --command Stop
# Run a workflow with input arguments
uip rpa run-file \
--file-path ./Main.xaml \
--input-arguments '{"customerId": "ACME-1234"}'
# Start a debug session
uip rpa run-file \
--file-path ./Main.xaml \
--command StartDebugging
# Toggle a breakpoint at the focused activity, then start debugging
uip rpa run-file --file-path ./Main.xaml --command ToggleBreakpoint
uip rpa run-file --file-path ./Main.xaml --command StartDebugging
# Test a single activity with a custom variable expression (VB.NET project)
uip rpa run-file \
--file-path ./Main.xaml \
--command TestActivity \
--input-variables '{"greeting": "\"Hello World\""}'
# Stop a runaway session
uip rpa run-file --file-path ./Main.xaml --command Stop
Associé
uip rpa start-studio— payez le coût de démarrage de Studio dans une étape de configuration dédiée.uip rpa stop-execution— équivalent de--command Stopen tant que verbe autonome.uip rpa get-errors— inspecter les diagnostics après une exécution.