- 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
Vue d’ensemble de référence
Index de référence pour chaque commande, indicateur et code de sortie `uip`, organisé par outil et divisé en pages liées.
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, Codex, OpenCode, Autopilot, Kiro, Windsurf, Antigravity, Devin). |
| 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. |
| Configuration UIP | Obtenir, définir ou effacer les préférences de configuration de l’interface CLI locale (format de sortie, niveau du journal, version/politique de mise à jour du canal). |
| utilisateur de l’IU | Afficher les informations d’identité sur la session actuellement connectée. |
| mise à jour de l’IU | Mettez à jour les outils et les compétences installés, et vérifiez ou appliquez une version de CLI plus récente. |
| Commentaires de l’IU | Envoyez un rapport de bogue ou une suggestion d’amélioration à l’équipe UiPath. |
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 (tâches, processus, dossiers, machines, licences et ressources d’exécution — ressources, compartiments, files d’attente, déclencheurs, bibliothèques, webhooks) | 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 |
maestro | Maestro — un package installable, trois surfaces frères indépendantes; il n'y a pas de commande uip maestro à barres | bpmn uip maestro, flux uip maestro, cas 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 |
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 |
eval | Évaluation Runtime des packages Orchestrator — évaluateurs, ensembles d'évaluation, évaluations, planifications | Évaluation UIP |
admin | Admin (utilisateurs, groupes, comptes Robot, applications externes, SMTP, autorisation, restriction IP, organisations, locataires, passerelles VPN, catalogue de ressources, audit) | Administrateur UIP |
agenthub | AgentHub (enregistrements de serveurs MCP, outils, agents A2A distants) | Hub d’agent de l’IU |
ah | Automation Hub (idées, pipeline, taxonomie, utilisateurs) | ah uip |
aops | StudioAdmin AOps (connexions, référentiels, projets, solutions, pipelines, exécutions) | Aops de l’IU |
coder | Coder — Agent de codage d'IA (version préliminaire uniquement) | encodeur UIP |
context-grounding | Ancrage dans le contexte (pont Python) | uip ancrage dans le contexte |
conversational | Conversationnel (chat, agents, historique des conversations, coffres) | conversationnel UiP |
function | Fonctions: créer, servir, publier JS/TS et Fonctions Python | Fonction UiP |
gov | Gouvernance (politiques AOps, politiques d’accès, packs de conformité) | Gouvernance de l’UIP |
guardrails | Garde-fous (configurations de garde-fous BYO, AI Trust Layer) | garde-fous UiP |
ixp | IXP – Traitement intelligent des documents (projets, taxonomie, documents, déploiements) | Extraction et IXP intelligents de l’UIP |
llm-configuration | Configuration LLM — Connexions BYO LLM (AI Trust Layer) | configuration llm uip |
llm-gateway | Passerelle LLM — répertorier les modèles disponibles | uip llm-passerelle |
model-hub | Model Hub - Configuration du routage de la passerelle LLM | uip model-hub |
pm | Process Mining (applications, transformations, ingestion de données) | il y a |
tasks | Tâches Action Center (Catalogues, Commentaires, Libellés, Métadonnées, Données) | tâches UIP |
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é.