Premières commandes (démarrage rapide)

Ce guide de démarrage rapide vous présente cinq commandes qui vous font passer d’une nouvelle installation à une tâche exécutée dans Orchestrator. Prévoyez cinq minutes.

Avant de commencer

• Installez UiPath CLI. Voir Installation de UiPath CLI.
• Disposer d'un compte UiPath Automation Cloud ou Automation Suite avec accès à au moins un locataire.
• Connaître le nom (ou le chemin d’accès) d’un dossier dans Orchestrator qui contient au moins un processus. Le dossier par défaut Shared fonctionne pour la plupart des essais.

Ouvrez un terminal. Toutes les commandes ci-dessous sont saisies ici.

Étape 1. Se connecter

Démarrez la connexion interactive:

uip login

uip ouvre votre navigateur par défaut, vous invite à vous connecter à UiPath et, après vous être authentifié, vous demande de choisir un locataire. Lorsque l'onglet du navigateur signale le succès, revenez au terminal — la session est active. La session est conservée dans ~/.uipath/ (ou dans un dossier .uipath/ local du projet s’il en existe un dans le dossier actuel ou un ancêtre).

Astuce :

Si vous connaissez déjà le locataire et que vous souhaitez ignorer le sélecteur, exécutez uip login --tenant DefaultTenant Si vous êtes dans un environnement CI, consultez Authentification pour les flux non interactifs.

Étape 2. Confirmer la session

uip login status --output table

Sortie attendue :

Status         Organization   Tenant          Expiration Date
Logged in      my-org         DefaultTenant   2026-04-24T18:42:00Z

Remarque :

Chaque commande uip envoie JSON par défaut. Transmettez --output table pour obtenir la vue conviviale en lecture. Voir les options globales pour les quatre formats de sortie (table, json, yaml, plain) et l'indicateur JMESPath --output-filter .

Si la commande signale Not logged in, réexécutez uip login.

Étape 3. Répertorier les dossiers

Votre première requête réelle arrive dans Orchestrator:

uip or folders list

Cela renvoie les 50 premiers dossiers du locataire. La sortie inclut le fichier Key , Name, Path et Type de chaque dossier.

Pour filtrer ou examiner plus en détail, saisissez --all pour déverrouiller les filtres:

uip or folders list --all --name Shared
uip or folders list --all --top-level

Remarque :

--all est requis avant que les indicateurs de filtre (--name, --path, --type, --top-level, --order-by) n'aient un effet. Il s’agit d’un réseau de sécurité délibéré - une faute de frappe dans un filtre sur un grand locataire renverrait silencieusement la première page non filtrée.

Étape 4. Trouver un processus à exécuter

Choisissez un dossier à l'étape 3 — Shared est utilisé ici comme exemple et répertoriez ses processus:

uip or processes list --folder-path Shared

La sortie affiche le fichier Key , Name, Version et Type de chaque processus. Copiez le Key d'un processus que vous souhaitez exécuter. Remplacez <process-key> dans l'étape suivante par ce GUID.

Étape 5. Démarrer une tâche

uip or jobs start <process-key>

uip se renvoie immédiatement après qu'Orchestrator a accepté la requête. La réponse affiche le Key de la nouvelle tâche, State (généralement Pending au début) et le ProcessName résolu.

Pour bloquer jusqu'à ce que la tâche se termine et voir sa sortie, ajoutez --wait-for-completion:

uip or jobs start <process-key> --wait-for-completion --timeout 600

Avec --wait-for-completion, la commande s'interroge toutes les cinq secondes (par défaut) et se termine lorsque la tâche atteint un état terminal (Successful, Faulted, Stopped). Le code de sortie n'est pas nul sur Faulted. --timeout est en secondes et est par défaut de 300.

Transmettez les arguments d'entrée avec --input-arguments (chaîne JSON) ou --input-file (chemin vers un fichier JSON):

uip or jobs start <process-key> \
  --input-arguments '{"invoiceNumber":"INV-001","customer":"Contoso"}'

Ce que vous venez de faire

Dans cinq commandes, vous vous authentifiez, interrogez deux ressources Orchestrator et démarrez une tâche. Chaque commande uip suit la même forme ( uip <tool> <resource> <verb> pour les outils avec plusieurs ressources ou uip <tool> <verb> pour les outils à workflow unique) et chacune prend en charge les mêmes indicateurs globaux pour le format de sortie, le filtrage et la journalisation. Voir Options globales.

Prochaines étapes

• Votre premier pipeline : compressez une solution localement, publiez-la sur votre locataire et déployez-la sur Orchestrator.
• Authentification — connexion interactive en détail, informations d'identification du client de l'application externe pour CI et flux variable d'environnement pour les conteneurs.
• Formats de sortie - basculez entre table, json, yaml et plain, et utilisez le filtrage JMESPath avec --output-filter.
• Référence des commandes Orchestrator — chaque commande, chaque indicateur.
• Utilisation de UiPath CLI avec des agents de codage — permet à Claude Code, Cursor, GitHub Copilot et d'autres agents de créer des automatisations UiPath avec uip.