Installation de UiPath CLI

La UiPath CLI est distribuée sur npm en tant que @uipath/cli et installe la commande uip dans le monde entier. Il s'exécute sur n'importe quelle plate-forme prise en charge par Node.js 18 ou version ultérieure - Windows, macOS et Linux, sur x64 et ARM64.

Prérequis

• Node.js 18 ou version ultérieure. Node.js est fourni avec npm, ce qui est suffisant pour installer et exécuter uip.
• N'importe quelle plate-forme: Windows (x64, ARM64), macOS (x64, ARM64), Linux (x64, ARM64).

Vérifiez la version de votre nœud:

node --version

Si Node.js est plus ancien que 18 ou n'est pas installé, téléchargez-le depuis nodejs.org ou utilisez un gestionnaire de version tel que nvm (macOS/Linux) ou nvm-windows.

Installer

NPM

npm install -g @uipath/cli

pnpm

pnpm add -g @uipath/cli

Remarque :

Les deux gestionnaires de package installent le même package @uipath/cli à partir du registre npm public. Utilisez celui que votre équipe a déjà en place.

L'installation place l'exécutable uip sur votre PATH. Sur Windows, le lanceur uip.cmd / uip.ps1 se trouve sous %APPDATA%\npm\; sur macOS et Linux, le lanceur uip (un petit utilisation de node ./dist/index.js) se trouve sous le préfixe indiqué par npm config get prefix (généralement /usr/local/bin ou ~/.npm-global/bin).

Vérifier l’installation

uip --version

Vous devriez voir le numéro de version installé (par exemple, 1.0.0).

uip --help

Vous devriez voir une liste de commandes de base - login (avec les sous-commandes status, tenant list, tenant set ), logout, tools, skills, mcp, completion — suivi par les outils qui ont été installés ou enregistrés sur votre machine.

Pour confirmer l'emplacement du lanceur uip et de ses outils:

npm root -g              # directory holding @uipath/cli and installed tools
npm config get prefix    # parent directory whose bin/ folder holds the uip launcher

Première commande

UiPath CLI est fournie avec uniquement l’hôte et un petit ensemble de commandes de base. Aucun outil n’est préinstallé. La première fois que vous invoquez une commande dont le préfixe correspond à un outil sur la liste blanche d'installation automatique, l'hôte télécharge et installe automatiquement cet outil depuis npm.

Par exemple, la première fois que vous exécutez une commande Orchestrator, uip installe @uipath/orchestrator-tool:

uip or folders list

Installing @uipath/orchestrator-tool...
✓ Installed @uipath/orchestrator-tool
...

Les uip or ... invocations suivantes utilisent directement l’outil installé. Vous pouvez également installer des outils explicitement — utiles sur les exécuteurs CI et les réseaux restreints — avec uip tools install:

uip tools install @uipath/orchestrator-tool
uip tools install @uipath/solution-tool

Voir Outils pour la liste blanche complète et Gestion des outils et des compétences pour la gestion quotidienne des outils.

Contrôle de l’installation automatique de l’outil

L'installation automatique s'exécute chaque fois que le verbe invoqué se trouve sur la liste blanche et que l'outil n'est pas encore installé. Il n'y a pas d'indicateur de refus ni de variable d'environnement, en particulier, CI=true ne désactive pas l'installation automatique. Sur les exécuteurs CI sans état, cela signifie que la première commande d'une construction télécharge son outil, et les commandes ultérieures de la même tâche réutilisent la copie déjà installée. Cela rend la première commande plus lente que les suivantes, sauf si vous préinstallez.

Pour garder les temps de build de CI déterministes, préinstallez les outils que vous utilisez comme une étape distincte, afin que chaque appel uip ultérieur les trouve déjà présents:

uip tools install @uipath/orchestrator-tool @uipath/solution-tool

L'installation automatique n'est pas compatible lorsque l'outil est déjà installé, de sorte que l'étape de pré-installation est le seul changement de comportement dont vous avez besoin.

Activer la complétion du shell

UiPath CLI fournit l'achèvement des onglets pour bash, zsh, flow et pwsh. L'achèvement est installé depuis la CLI elle-même:

uip completion

Dans un terminal, uip completion détecte votre shell depuis $SHELL / $PSModulePath / platform, imprime le fichier rc cible qu’il modifiera et demande la confirmation. Acceptez l'invite et rouvrez votre shell - uip <TAB> exécute désormais les sous-commandes et options.

Pour la configuration scriptée, acheminez le script de complétion dans votre fichier rc directement:

# zsh
uip completion zsh >> ~/.zshrc

# bash
uip completion bash >> ~/.bashrc

# fish
uip completion fish > ~/.config/fish/completions/uip.fish

# PowerShell
uip completion pwsh >> $PROFILE

Autres options:

• uip completion --print — prévisualisez le chemin cible et le bloc qui serait écrit sans modifier le système de fichiers.
• uip completion --uninstall — supprimer le bloc d'achèvement géré.

Remarque :

L'achèvement dynamique de la valeur de l'indicateur (par exemple, uip or packages upload --package-name <TAB>) est zsh uniquement et nécessite l'utilitaire jq sur votre PATH. Sans jq, les candidats dynamiques sont supprimés; La sous-commande statique et la complétion de nom d'option fonctionnent toujours sur les quatre shells.

Avertissement :

Achèvement de la réexécution après chaque mise à niveau de la CLI ou de l’outil

Le script de complétion est un instantané statique des sous-commandes et des noms d'options connus au moment où uip completion a été exécuté. Après npm install -g @uipath/cli@<new-version>, uip tools install <new-tool>, ou uip tools update, réexécutez uip completion afin que les commandes et les indicateurs nouvellement ajoutés soient indexés:

uip completion              # interactive — refreshes the existing block
uip completion zsh >> ~/.zshrc   # or pipe into the rc file directly

Sans actualisation, les nouveaux verbes (par exemple, un verbe ajouté dans la version mineure d'un outil) ne seront pas remplis automatiquement, même s'ils fonctionnent sur la ligne de commande.

Notes de la plateforme

Windows

Exécutez les commandes depuis PowerShell, le terminal Windows ou cmd. Si uip n’est pas reconnu après l’installation, ouvrez une nouvelle fenêtre de terminal afin que le PATH mis à jour prenne effet, ou exécutez:

npm config get prefix

et confirmez que le répertoire renvoyé se trouve sur votre PATH.

macOS et Linux

La plupart des gestionnaires de packages placent l'exécutable uip sur le PATH par défaut. Si vous installez npm globals dans un répertoire user-local (comme recommandé - évite sudo), assurez-vous que ce répertoire se trouve sur votre PATH. Par exemple, avec un préfixe ~/.npm-global :

export PATH="$HOME/.npm-global/bin:$PATH"

Ajoutez la ligne à votre profil Shell (~/.zshrc, ~/.bashrc, etc.) pour la conserver.

derrière un proxy d’entreprise

UiPath CLI respecte les variables d'environnement du proxy HTTP standard pour la CLI elle-même et l'installation automatique de l'outil:

Variable	Objectif
HTTP_PROXY / http_proxy	Proxy pour les requêtes HTTP
HTTPS_PROXY / https_proxy	Proxy pour les requêtes HTTPS
NO_PROXY / no_proxy	Liste d'hôtes qui contournent le proxy, séparés par des virgules

Exemples :

# macOS / Linux
export HTTPS_PROXY=http://proxy.example.com:8080
export NO_PROXY=localhost,127.0.0.1,.internal.corp
uip login

# Windows PowerShell
$env:HTTPS_PROXY = "http://proxy.example.com:8080"
$env:NO_PROXY = "localhost,127.0.0.1,.internal.corp"
uip login

:: Windows cmd
set HTTPS_PROXY=http://proxy.example.com:8080
set NO_PROXY=localhost,127.0.0.1,.internal.corp
uip login

Les proxys avec authentification de base sont pris en charge en incluant les informations d’identification dans l’URL: http://user:[e-mail]:8080.

Astuce :

La CLI inclut une implémentation fetch compatible proxy, de sorte que HTTPS_PROXY / HTTP_PROXY sont respectés sans configuration supplémentaire sur Node.js.

Télémétrie

UiPath CLI envoie une télémétrie d'utilisation anonyme à UiPath pour aider à améliorer le produit. Aucun argument de commande, aucun contenu de fichier ou aucune information d’identification n’est transmis.

Variable	Comportement
UIPATH_TELEMETRY_DISABLED	Définissez sur 1 ou true pour refuser.
UIPATH_AI_CONNECTION_STRING	Remplacez la chaîne de connexion Application Insights, par exemple pour acheminer la télémétrie vers votre propre instance.

# Opt out for the current shell
export UIPATH_TELEMETRY_DISABLED=1

# Or just for one command
UIPATH_TELEMETRY_DISABLED=1 uip login

Installation dans CI/CD

Installez la CLI en tant qu'étape dans votre pipeline. Étant donné que uip n'a aucun outil préinstallé, laissez les outils s'installer automatiquement lors de la première utilisation ou les préinstaller explicitement - ce dernier est plus rapide sur les exécuteurs sans état, car le téléchargement de l'outil se produit une fois par étape plutôt que sur chaque commande.

Actions de GitHub

steps:
  - uses: actions/setup-node@v4
    with:
      node-version: '20'

  - name: Install UiPath CLI
    run: npm install -g @uipath/cli

  - name: Pre-install tools
    run: uip tools install @uipath/orchestrator-tool @uipath/solution-tool

  - name: Authenticate
    run: uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET
    env:
      UIPATH_CLIENT_ID: ${{ secrets.UIPATH_CLIENT_ID }}
      UIPATH_CLIENT_SECRET: ${{ secrets.UIPATH_CLIENT_SECRET }}

  - name: Run CLI commands
    run: uip or folders list --output json

Azure DevOps

steps:
  - task: NodeTool@0
    inputs:
      versionSpec: '20.x'
    displayName: 'Use Node.js 20'

  - script: npm install -g @uipath/cli
    displayName: 'Install UiPath CLI'

  - script: uip tools install @uipath/orchestrator-tool @uipath/solution-tool
    displayName: 'Pre-install UiPath CLI tools'

  - script: uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET
    displayName: 'Authenticate'
    env:
      UIPATH_CLIENT_ID: $(UIPATH_CLIENT_ID)
      UIPATH_CLIENT_SECRET: $(UIPATH_CLIENT_SECRET)

Jenkins: pipeline déclaratif

stage('Install UiPath CLI') {
  steps {
    sh 'npm install -g @uipath/cli'
    sh 'uip tools install @uipath/orchestrator-tool @uipath/solution-tool'
  }
}

stage('Authenticate') {
  steps {
    withCredentials([
      string(credentialsId: 'UIPATH_CLIENT_ID', variable: 'UIPATH_CLIENT_ID'),
      string(credentialsId: 'UIPATH_CLIENT_SECRET', variable: 'UIPATH_CLIENT_SECRET')
    ]) {
      sh 'uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET'
    }
  }
}

Voir les instructions CI/CD pour obtenir des exemples de pipelines complets, y compris les étapes de compression, de publication et de test.

Astuce :

Mettez en cache le répertoire global npm entre les versions pour éviter de réinstaller @uipath/cli et ses outils à chaque exécution. Sur les actions de GitHub, utilisez actions/cache clé sur la version de CLI que vous épinglez.

Installation à partir du registre npm de GitHub

Un sous-ensemble de @uipath/* packages d'outils — actuellement @uipath/rpa-tool et @uipath/flow-tool — est publié dans le registre npm GitHub (https://npm.pkg.github.com) plutôt que dans le registre npm public. Avant que uip tools install puisse les résoudre, configurez npm afin d’acheminer l’étendue @uipath via le registre de GitHub.

Créez (ou mettez à jour) ~/.npmrc (au niveau utilisateur) ou ./.npmrc (au niveau du projet) avec:

@uipath:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}

GITHUB_TOKEN a besoin d’au moins l’étendue read:packages ; pour une extraction non authentifiée d'un package GitHub public, la ligne de jeton peut être omise (le comportement varie par package — vérifiez la visibilité du référentiel).

export GITHUB_TOKEN=<your-pat>
npm install -g @uipath/cli
uip tools install @uipath/rpa-tool

Une fois configurés, uip tools install et uip tools update récupèrent les packages enregistrés par GitHub de la même manière qu'ils récupèrent les packages publics.

Remarque :

Le package d’hôte @uipath/cli se trouve dans le registre npm public. Seuls les outils marqués dans les notes de publication comme enregistrés par GitHub ont besoin de l'élément .npmrc supplémentaire.

Exécution sans installation globale

Pour une utilisation ad-hoc ou des pipelines qui préfèrent ne pas installer globalement, vous pouvez exécuter la CLI via npx:

npx -y @uipath/cli <command>

Par exemple :

npx -y @uipath/cli login
npx -y @uipath/cli or folders list

La première invocation télécharge le package; les invocations suivantes réutilisent le cache npm.

Mise à niveau

Réinstallez le package avec la même commande que vous avez utilisée pour l'installer, en choisissant soit la dernière version, soit une version épinglée:

# latest release
npm install -g @uipath/cli@latest

# pinned version
npm install -g @uipath/cli@1.0.0

La commande pnpm équivalente est pnpm add -g @uipath/cli@latest.

Astuce :

Épinglez une version exacte dans CI. @uipath/cli suit un contrôle de version sémantique, mais la forme de Data dans la sortie JSON est spécifique à la commande et peut changer entre les versions mineures (voir Contrôle des versions et stabilité). L'épinglage évite les surprises lors de la création d'un pipeline qui analyse JSON. Lorsque vous sautez, validez à nouveau les scripts qui dépendent de noms de champs spécifiques.

Consultez les notes de publication pour connaître les modifications apportées entre les versions.

La mise à niveau de l’hôte ne met pas automatiquement à niveau les outils installés. Pour mettre à jour les outils:

uip tools update                        # update all installed tools
uip tools update --name <package>       # update a single tool
uip tools update --name <package> --version <version>   # pin to a specific version

Par défaut, chaque version d’outil suit la ligne MAJOR.MINIOR de la CLI, par conséquent, l’exécution de uip tools update après une mise à niveau de la CLI place chaque outil installé dans l’étape. Voir Outils pour le contrat d'épinglage.

Désinstallation

Supprimez la CLI avec le gestionnaire de package que vous avez utilisé pour l'installer:

npm uninstall -g @uipath/cli
# or
pnpm remove -g @uipath/cli

Cela supprime l'exécutable uip et les outils installés.

Supprimer les informations d’identification et les données

La désinstallation du package laisse plusieurs éléments de l'état sur le disque. Nettoyez-les manuellement lorsque vous souhaitez un nouveau départ ou que vous devez désaffecter une machine.

Informations d’identification de session

uip login conserve la session à l'intérieur ~/.uipath/ dans votre répertoire personnel par défaut. Lorsque la CLI démarre, elle démarre d'abord à partir du répertoire actuel et recherche un dossier .uipath/ afin qu'un dossier de projet puisse effectuer sa propre session sans modifier le répertoire de base de l'utilisateur. Vérifiez les deux emplacements lors du nettoyage:

# macOS / Linux
rm -rf ~/.uipath

# Windows PowerShell
Remove-Item -Recurse -Force "$env:USERPROFILE\.uipath"

Vérifiez également chaque projet dans lequel vous avez travaillé pour une .uipath/ locale. Voir Sessions et informations d’identification pour la mise en page complète.

Achèvement de l’shell

Si vous avez exécuté uip completion, le bloc de complétion se trouve toujours dans votre fichier rc shell après la désinstallation. Supprimez-le avant de désinstaller @uipath/cli, ou remplacez-le manuellement depuis ~/.zshrc, ~/.bashrc ou $PROFILE:

# Before uninstalling, while uip is still available:
uip completion --uninstall

cache global npm

npm conserve un cache local des tarballs téléchargées au niveau du chemin indiqué par npm config get cache. Cela n’a pas besoin d’être nettoyé pour la plupart des utilisateurs; le nettoyer uniquement pour récupérer de l'espace disque ou pour résoudre le problème d'un téléchargement corrompu:

npm cache clean --force

Résolution des problèmes

uip: commande introuvable après l'installation

Le répertoire global npm ne se trouve pas sur votre PATH. Exécutez npm config get prefix pour voir où npm a placé le lanceur uip , puis ajoutez le sous-dossier bin de ce répertoire à votre PATH et ouvrez un nouveau terminal.

Erreurs EACCE ou autorisation lors de l’installation

Sur macOS et Linux, évitez sudo npm install. Configurez npm pour utiliser un préfixe local utilisateur une fois:

mkdir -p ~/.npm-global
npm config set prefix ~/.npm-global
export PATH="$HOME/.npm-global/bin:$PATH"

Ensuite, réinstallez: npm install -g @uipath/cli.

L’installation automatique de l’outil se bloque ou expire

Vous pouvez être derrière un proxy qui bloque npm. Configurez HTTPS_PROXY comme décrit dans derrière un proxy d'entreprise, ou préinstallez les outils sur une machine avec accès à Internet et copiez le node_modules global sur la machine cible.

Version du nœud trop ancienne

uip nécessite Node.js 18 ou une version ultérieure. Mettez à niveau Node.js ou changez de version avec nvm use 20

Voir Résolution des problèmes pour plus d'erreurs et leurs résolutions.

Prochaines étapes

• Démarrage rapide : connectez-vous, répertoriez les dossiers Orchestrator et exécutez une tâche en cinq minutes.
• Votre premier pipeline : compressez un projet et déployez-le à partir du CI.
• Authentification — connexion interactive, informations d'identification du client de l'application externe et authentification variable d'environnement pour CI.
• Utilisation de la UiPath CLI avec des agents de codage : installez les compétences dans Claude Code, Cursor, GitHub Copilot ou la CLI Gemini.