- 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
Les documents de référence pour chaque commande uip , indicateur et code de sortie. Utilisez-la comme fonction de recherche lorsque vous savez ce que vous voulez faire et que vous avez besoin de la syntaxe exacte. Pour l'apprentissage, commencez par le Quickstart ou comment UiPath CLI est organisé.
Comment la référence est organisée
La référence est divisée en trois types de pages:
- Couper - comportement qui s’applique à chaque invocation de
uipquel que soit l’outil. - Commandes de base - commandes que l'hôte possède (
login,logout,tools,skills,mcp,completion). - Par outil — une section par outil installable; chaque section a une vue d'ensemble plus une page par ressource (pour les outils basés sur les ressources) ou par verbe (pour les outils à workflow unique).
Couper
| Page | Ce que cela couvre |
|---|---|
| Options globales | --output, --output-filter, --log-level, --log-file — les quatre indicateurs disponibles sur chaque commande. |
| Codes de sortie | Le contrat de code de sortie à cinq niveaux (0 / 1 / 2 / 3 / 4) plus 130 pour l'annulation de l'utilisateur. |
Commandes Core
Commande l'hôte s'enregistre directement. Aucune installation d’outil requise.
| Commande | Objectif |
|---|---|
| connexion uip | Démarrez une session OAuth2 interactive, authentifiez-vous en tant qu’application externe ou changez de locataire. |
| Déconnexion de l’IU | Supprimez les informations d'identification stockées. |
| statut de connexion à l'IU | Affichez l’organisation, le locataire et l’expiration de la session actuelle. |
| Outils UIP | Répertorier, rechercher, installer, mettre à jour ou désinstaller des outils installables. |
| Compétences UIP | Installez les compétences UiPath dans des agents de codage (Claude Code, Cursor, GitHub Copilot, Gemini CLI, Codex, OpenCode). |
| MCP uip | Exposer les commandes uip via le protocole de contexte de modèle pour les clients compatibles MCP. |
| achèvement de l’IU | Installez, imprimez ou supprimez l'achèvement de l'onglet Shell pour bash, zsh, Assurez-vous et pwsh. |
Outils
Chaque outil est un package npm installable. Exécutez uip tools install <alias> pour l’ajouter, ou invoquez-le une fois et laissez l’installation automatique faire le travail. Voir Outils pour le modèle et Outils uip pour la commande qui les gère.
| Alias | Outil | Référence (Reference) |
|---|---|---|
or | Orchestrator | UIP ou |
platform | Plate-forme (licences de locataire, bundles d’utilisateurs, règles de groupe, consommables) | plate-forme uip |
solution | Solution | solution UiP |
agent | Agent (Agent) | Agent UIP |
flow | Flux (installation explicite uniquement — pas sur la liste blanche d'installation automatique) | Flux UIP |
maestro | Maestro | UIP Maestro |
tm | Test Manager | Horodatage UIP |
rpa | RPA (empaquetage de Studio, analyse, restauration) | RPA de l’UIP |
rpa-legacy | RPA Legacy - Enveloppeur Windows uniquement autour de uipcli.exe (débogage, validation, recherche d'activités, recherche-package, définition de type, package) | uip rpa-legacy |
resource | Ressource (ressources, files d'attente, compartiments, déclencheurs, webhooks) | Ressource de l’IU |
is | Integration Service | l’uip est |
codedagent | Agent codé | agent codé uip |
codedapp | Application codée | application codée uip |
api-workflow | Workflow d’API | workflow d’API uip |
vss | Solutions verticales | UIP vss |
df | Data Fabric | df UiP |
insights | Insights | résultats de l’IU |
traces | Traçages | Traçages UIP |
docsai | DocsAI | UiPath Docsai |
Comment lire une page de commande
La page de référence de chaque commande suit la même structure:
- Syntaxe — la forme de commande en une ligne, montrant les arguments positionnels et l'ensemble d'indicateurs communs.
- Description : un paragraphe ou deux décrivant ce que fait la commande et où elle s'intègre dans un workflow.
- Arguments — tableau des arguments positionnels: nom, requis/facultatif, objectif.
- Options — tableau des indicateurs regroupés par préoccupation (identité, filtrage, sortie, comportement). Chaque ligne indique le nom court, le nom long, le type de valeur, la valeur par défaut et une description en une ligne.
- Exemples — trois exemples ou plus travaillés: minimaux, cas courants, conviviaux pour les scripts (avec gestion
--output-filterou JSON explicite). - Codes de sortie — un pointeur vers Codes de sortie plus tous les remplacements spécifiques à la commande.
- Commandes associées — commandes fréquemment utilisées avec celle-ci.
- Voir aussi — les pages de concept et de procédure qui couvrent le contexte de la commande.
Toutes les pages héritent des options globales; elles ne sont pas répétées à chaque commande.
Conventions
- Préfixe de commande.
uipest l'exécutable; chaque exemple commence par lui. - Espaces réservés.
<angle-brackets>pour les valeurs requises,[square-brackets]pour les valeurs facultatives. Remplacez par vos valeurs réelles. - Indicateurs courts. Lorsqu'un indicateur a une forme courte (par exemple,
-tpour--tenant), les deux sont répertoriés dans le tableau des options; les exemples utilisent le formulaire long pour la lisibilité. - Exemples JSON.
--output jsonest la valeur par défaut. Les exemples qui affichent les champs non pertinents avec…pour conserver le focus. - Notes de version. Les commandes ou les indicateurs intitulés « Aperçu» peuvent être modifiés sans qu'une version majeure soit affectée. Les commandes libellées Obsolète continuent de fonctionner pendant au moins un cycle MAJOR. Voir Contrôle des versions et stabilité.