- 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
uip (commandes de base)
Commandes de base de la UiPath CLI qui ne nécessitent aucune installation d'outil, couvrant l'authentification, le cycle de vie de l'outil, les compétences, le pont MCP et l'achèvement du shell.
L'interface de commande de base correspond à tout ce qui est fourni par l'hôte (@uipath/cli) - aucune installation d'outil n'est nécessaire. Ces commandes gèrent l'authentification, le cycle de vie de l'outil, les compétences de l'agent de codage IA, le pont MCP et l'achèvement du shell. Chaque commande de cette page est disponible au moment où npm install -g @uipath/cli se termine.
Pour les commandes qui appellent une interface UiPath (Orchestrator, Solutions, Agents, etc.), consultez les pages de référence par outil - chacune est fournie par un package npm distinct que l'hôte charge à la demande.
Les commandes de l'hôte
L'hôte CLI enregistre 11 commandes de niveau supérieur (uip track est masquée dans la télémétrie interne et n'est pas visible par l'utilisateur — les 10 autres sont:
| Commande | Objectif | Connexion requise |
|---|---|---|
uip login | S’authentifier via OAuth2 interactif, une application externe, des variables d’environnement ou une identité fédérée/de charge de travail; changer de locataire. Écrit une session vers .uipath/.auth. | — |
uip logout | Supprimez le fichier d'informations d'identification. | — |
uip login status | Affichez l’organisation actuelle, le locataire, l’expiration et le fichier d’informations d’identification que la CLI lit. | Facultatif (rapports Not logged in dans le cas contraire) |
uip config | Obtenir, définir et effacer les valeurs de configuration de l’interface CLI locale (y compris les lectures de la version uip tools update). | — |
uip user | Affiche l’identité de l’utilisateur actuellement authentifié. | Oui (Yes) |
uip feedback | Envoyez des commentaires à propos de la CLI. | — |
uip tools | Répertorier, rechercher, installer, mettre à jour, désinstaller les outils installables (Orchestrator, Solution, Agent, Test Manager, …). | — |
uip skills | Installez des compétences UiPath dans des agents de codage d'IA. | — |
uip mcp | exposez la CLI en tant que serveur du protocole de contexte du modèle via stdio. | Par run_command (hérite de la session basée sur le fichier). |
uip update | Mettez à jour automatiquement la CLI, ses outils installés et ses compétences installées. | — |
uip completion | Installez ou imprimez l'achèvement des onglets du shell. | — |
Synthèse
uip login [--tenant <name>] [--organization <name>] [--authority <url>] [--client-id <id>] [--client-secret <secret> | --client-assertion <jwt>] [--scope <scopes>] [--no-browser] [-f <folder>]
uip login status [-f <folder>]
uip login refresh [--login-validity <minutes>]
uip login which [-f <folder>]
uip login tenant list [-f <folder>]
uip login tenant set <name> [-f <folder>]
uip logout [-f <folder>]
uip config get / set / clear <key>
uip user
uip feedback send
uip tools list / search / install / update / uninstall …
uip skills list / search / show / install / update / uninstall --agent <name>
uip mcp serve
uip update [--dry-run] [--tools-only] [--skills-only]
uip completion [shell] [--print] [--uninstall]
uip login [--tenant <name>] [--organization <name>] [--authority <url>] [--client-id <id>] [--client-secret <secret> | --client-assertion <jwt>] [--scope <scopes>] [--no-browser] [-f <folder>]
uip login status [-f <folder>]
uip login refresh [--login-validity <minutes>]
uip login which [-f <folder>]
uip login tenant list [-f <folder>]
uip login tenant set <name> [-f <folder>]
uip logout [-f <folder>]
uip config get / set / clear <key>
uip user
uip feedback send
uip tools list / search / install / update / uninstall …
uip skills list / search / show / install / update / uninstall --agent <name>
uip mcp serve
uip update [--dry-run] [--tools-only] [--skills-only]
uip completion [shell] [--print] [--uninstall]
Chaque commande respecte également l'indicateur --interactive/--no-interactive global (voir Options globales) — il n'y a pas de forme abrégée spécifique à la commande pour elle.
Toutes les commandes de base respectent les options globales (--output, --output-filter, --log-level, --log-file, --profile, --interactive/--no-interactive) et suivent le contrat de code de sortie standard.
Le lien entre la surface du noyau et les outils
Toutes les autres uip <tool> … invocations s’exécutent au-dessus de celles-ci:
- L'authentification est établie une fois avec
uip loginet héritée par chaque appel d'outil suivant (Orchestrator, Solution, Agent, …). - Le cycle de vie de l’outil (
uip tools install) contrôle les packages d’extension qui sont chargés la prochaine fois que vous invoquez un préfixe d’outil. - Les compétences se trouvent à côté des outils - elles apprennent aux agents d'IA à utiliser
uipplutôt que d'ajouter de nouvelles commandes. - MCP encapsule la surface entière ( erreur de base + outils installés) comme un seul outil MCP que tout client compatible MCP peut appeler.
- L'achèvement découvre les commandes au moment de l'installation, réexécutez donc
uip completionaprèsuip tools installsi vous souhaitez l'achèvement pour les commandes nouvellement ajoutées.
Consultez Comment UiPath CLI est organisée pour l'architecture hôte-vs-outil en détail.
Format d’authentification
Chaque commande de base, à l'exception des commandes d'authentification, fonctionne sans session — elles parlons simplement de fichiers locaux (config, manifeste, script de complétion). Les commandes d'authentification gèrent la session elle-même:
uip login— OAuth2 interactif (navigateur), une application externe (informations d'identification du client), un jeton variable dans l'environnement et une identité fédérée/de charge de travail (--client-assertion). Voir Authentification.--profileétend la session à un ensemble d'informations d'identification nommé, orthographique au flux que vous utilisez.uip logout— supprime le fichier. Le flux env-var n’a rien à effacer.uip login status— signale la session active.uip login refresh— actualise de manière proactive le jeton d'accès et génère une charge utile de session lisible par machine pour les utilisateurs programmatiques.uip login which— copie à partir de laquelle le fichier de session/d'informations d'identification actif a été résolu.uip login tenant list / set— changez de locataires sans réauthentifier.
Les commandes d’outil héritent de la session qui se trouve sur le disque au moment de l’invocation; --tenant remplacements par appel.
Où chaque commande envoie sa sortie
| Flux | Contenu (Content) |
|---|---|
| stdout | L'enveloppe JSON structurée (Result, Code, Data, …). Une par invocation. |
| Évaluation | Journaux ( contrôlés par --log-level), indicateurs de progression et texte d'erreur lisible par un humain. JSON jamais analysable par machine. |
Le fractionnement est appliqué partout; vous pouvez les rediriger indépendamment:
uip tools list > tools.json 2> uip.log
uip tools list > tools.json 2> uip.log
Voir Formats de sortie pour les cinq formats (json, table, yaml, plain, markdown) et le filtrage JMESPath.
Voir également
- Concepts: comment UiPath CLI est organisé — ce que signifie « hôte» et pourquoi le cœur est divisé des outils.
- Concepts: outils (extensions) — la liste blanche d'installation automatique et l'épinglage de version.
- Concepts: compétences — façon dont
uip skills installétend les agents d'IA. - Concepts: sessions et informations d’identification — ce que
uip loginécrit et où. - Authentification — les flux d'authentification en détail, y compris la connexion fédérée/workload-identity.
- Options globales, codes de sortie — contrats partagés par chaque commande.