UiPath CLI をインストールする

UiPath CLI は @uipath/cli で npm で配布され、 uip コマンドをグローバルにインストールします。Node.js 18 以降でサポートされているすべてのプラットフォーム (Windows、macOS、Linux、x64 と ARM64 の両方) で実行されます。

前提条件

• Node.js 18 以降。Node.js には npmが付属しています。これは、 uipをインストールして実行するのに十分です。
• 任意のプラットフォーム — Windows (x64、ARM64)、macOS (x64、ARM64)、Linux (x64、ARM64)。

Node のバージョンを確認します。

node --version

Node.js が 18 より古い場合、またはインストールされていない場合は、nodejs.org からダウンロードするか、nvm (macOS/Linux) や nvm-windowsなどのバージョン マネージャーを使用してください。

インストール

NPM

npm install -g @uipath/cli

pnpm(英語)

pnpm add -g @uipath/cli

注:

どちらのパッケージ マネージャーも、パブリック npm レジストリから同じ @uipath/cli パッケージをインストールします。チームがすでに設置している方を使用してください。

インストールすると、 uip 実行可能ファイルが PATHに配置されます。Windowsでは、 uip.cmd / uip.ps1 ランチャーは %APPDATA%\npm\の下にあります。macOSおよびLinuxでは、 uip ランチャー( node ./dist/index.jsの周りの小さなシム)は、 npm config get prefix によって報告されたプレフィックス(通常は /usr/local/bin または ~/.npm-global/bin)の下にあります。

インストールの検証

uip --version

インストールされているバージョン番号が表示されます (例: 1.0.0)。

uip --help

コアコマンドのリスト ( login ( status、 tenant list、 tenant set サブコマンドを使用)、 logout、 tools、 skills、 mcp、 completion のリストと、マシンにインストールされている、または登録されているツールが表示されます。

uipランチャーとそのツールがどこにあるかを確認するには:

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

最初のコマンド

UiPath CLI には、ホストと少数のコア コマンドのみが付属しています。ツールはプリインストールされていません。自動インストール ホワイトリストにあるツールと一致するプレフィックスを持つコマンドを初めて呼び出すと、ホストはそのツールを npm から自動的にダウンロードしてインストールします。

たとえば、Orchestrator のコマンドを初めて実行すると、 uip によって以下の @uipath/orchestrator-toolがインストールされます。

uip or folders list

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

それ以降の uip or ... 呼び出しでは、インストールされているツールが直接使用されます。また、CIランナーや制限されたネットワークで役立つツールを明示的にインストールすることもできます uip tools install:

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

完全なホワイトリストについては 「ツール (プラグイン)」 を、日常的なツール管理については「 ツールとスキルを管理する 」をご覧ください。

ツールの自動インストールの制御

自動インストールは、呼び出された動詞がホワイトリストにあり、ツールがまだインストールされていない場合に実行されます。オプトアウトフラグや環境変数はありません CI=true 特に、自動インストールは無効 になりません 。ステートレス CI ランナーでは、ビルドの最初のコマンドでツールがダウンロードされ、同じジョブ内の後続のコマンドで、すでにインストールされているコピーが再利用されます。そのため、プリインストールしない限り、最初のコマンドが後続のコマンドよりも遅くなります。

CI のビルド時間を決定論的に保つには、使用するツールを別のステップとしてプリインストールして、その後の uip 呼び出しごとに既に存在するツールを見つけるようにします。

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

ツールがすでにインストールされている場合は自動インストールは不要であるため、必要な動作の変更はプレインストール手順だけです。

シェル補完を有効にする

UiPath CLI には、 bash、 zsh、 fish、 pwsh のタブ補完が用意されています。完了はCLI自体内からインストールします。

uip completion

ターミナルでは、 uip completion は $SHELL / $PSModulePath / プラットフォームからシェルを検出し、変更する対象の rc ファイルを出力し、確認を求めます。プロンプトを受け入れてシェルを再度開く — これで uip <TAB> サブコマンドとオプションが補完されます。

スクリプト化された設定の場合は、補完スクリプトをrcファイルに直接パイプします。

# zsh
uip completion zsh >> ~/.zshrc

# bash
uip completion bash >> ~/.bashrc

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

# PowerShell
uip completion pwsh >> $PROFILE

その他のオプション:

• uip completion --print — ファイルシステムを変更せずに、ターゲットパスと書き込まれるブロックをプレビューします。
• uip completion --uninstall — 管理完了ブロックを削除します。

注:

フラグ値の動的な補完 (例: uip or packages upload --package-name <TAB>) は zsh のみであり、PATHに jq ユーティリティが必要です。jqがない場合、動的な候補は抑制されます。static サブコマンドとオプション名補完は、4 つのシェルすべてで機能します。

警告:

CLI またはツールをアップグレードするたびに完了を再実行

補完スクリプトは、実行時に既知のサブコマンドとオプション名の静的なスナップショットuip completion。npm install -g @uipath/cli@<new-version>、uip tools install <new-tool>、または uip tools updateの後にuip completionを再実行して、新しく追加したコマンドとフラグにインデックスが付けられるようにします。

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

更新しないと、新しい動詞 (たとえば、ツールの MINOR リリースで追加された動詞) は、コマンド ラインで機能していてもオートコンプリートされません。

プラットフォーム ノート

Windows

PowerShell、Windows ターミナル、または cmd からコマンドを実行します。インストール後に uip が認識されない場合は、新しいターミナル ウィンドウを開いて更新された PATH を有効にするか、以下を実行します。

npm config get prefix

をクリックし、返されたディレクトリが PATH上にあることを確認します。

macOS と Linux

ほとんどのパッケージマネージャーは、 uip 実行可能ファイルをデフォルトの PATHに配置します。npm グローバルをユーザーローカルディレクトリにインストールする場合(推奨どおり — sudo回避)、そのディレクトリが PATH上にあることを確認してください。たとえば、プレフィックスが ~/.npm-global の場合は次のようになります。

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

この行をシェルプロファイル(~/.zshrc、 ~/.bashrcなど)に追加して保持します。

企業委任状の背後に

UiPath CLI は、CLI 自体とツールの自動インストールの両方で、標準の HTTP プロキシ環境変数に従います。

変数	目的
HTTP_PROXY / http_proxy	HTTP 要求のプロキシ
HTTPS_PROXY / https_proxy	HTTPS 要求のプロキシ
NO_PROXY / no_proxy	プロキシをバイパスするホストのコンマ区切りリスト

例:

# 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

基本認証のプロキシは、URL に資格情報を含めることでサポートされます: http://user:[e-mail]:8080。

ヒント:

CLI にはプロキシ対応の fetch 実装がバンドルされているため、 で追加の設定を行うことなく HTTPS_PROXY / HTTP_PROXY を使用できますNode.js。

テレメトリ

UiPath CLI は、製品の改善を目的として、使用状況の匿名のテレメトリを UiPath に送信します。コマンド引数、ファイルの内容、または資格情報は送信されません。

変数	動作
UIPATH_TELEMETRY_DISABLED	オプトアウトするには、[ 1 ] または [ true ] に設定します。
UIPATH_AI_CONNECTION_STRING	Application Insights の接続文字列をオーバーライドします — たとえば、テレメトリを独自のインスタンスにルーティングする場合などです。

# Opt out for the current shell
export UIPATH_TELEMETRY_DISABLED=1

# Or just for one command
UIPATH_TELEMETRY_DISABLED=1 uip login

CI/CD にインストールする

CLI をパイプラインのステップとしてインストールします。uip にはツールがプリインストールされていないため、ツールを最初の使用時に自動インストールするか、明示的にプリインストールします — ツールのダウンロードはすべてのコマンドではなくステップごとに 1 回行われるため、ステートレス ランナーでは後者の方が高速です。

GitHub Actions

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 (宣言型パイプライン)

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'
    }
  }
}

パック、パブリッシュ、テスト ステージを含む完全なパイプライン例については、 CI/CD レシピ を参照してください。

ヒント:

ビルド間で npm グローバルディレクトリをキャッシュして、実行のたびに @uipath/cli とそのツールが再インストールされないようにします。GitHub Actions では、ピン留めする CLI バージョンをキーとする actions/cache を使用します。

GitHub の npm レジストリからインストールする

@uipath/*ツール パッケージのサブセット (現在@uipath/rpa-toolおよび@uipath/flow-tool) は、パブリック npm レジストリではなく、GitHub npm レジストリ (https://npm.pkg.github.com) に公開されます。uip tools install解決する前に、GitHub のレジストリを介して@uipathスコープをルーティングするように npm を構成します。

以下を使用して、 ~/.npmrc (ユーザー レベル) または ./.npmrc (プロジェクト レベル) を作成 (または更新) します。

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

GITHUB_TOKEN 少なくとも read:packages 範囲が必要です。パブリックGitHubパッケージの認証されていないプルの場合、token行を省略できます(動作はパッケージによって異なります—リポジトリの可視性を確認してください)。

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

構成が完了すると、 uip tools install と uip tools update は、パブリック パッケージを取得するのと同じ方法で GitHub に登録されたパッケージを取得します。

注:

ホスト パッケージ @uipath/cli 自体は、パブリック npm レジストリにあります。リリース ノートで GitHub 登録済みとしてマークされているツールにのみ、追加の.npmrcが必要です。

グローバル インストールなしで実行する

アドホックで使用するパイプラインや、グローバルにインストールしないパイプラインの場合は、以下の手順で CLI を実行できますnpx

npx -y @uipath/cli <command>

例:

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

最初の呼び出しでは、パッケージがダウンロードされます。後続の呼び出しでは、npm キャッシュが再利用されます。

アップグレード

インストールに使用したのと同じコマンドでパッケージを再インストールし、最新リリースまたはピン留めされたバージョンを選択します。

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

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

同等の pnpm コマンドは pnpm add -g @uipath/cli@latestです。

ヒント:

CI で正確なバージョンをピン留めします。@uipath/cliセマンティック バージョニングに従いますが、JSON 出力のDataの形状はコマンド固有であり、マイナー リリース間で変わる可能性があります (「バージョニングと安定性」をご覧ください)。ピン留めにより、JSON を解析するパイプラインでのビルド時の驚きを回避できます。バンプするときは、特定のフィールド名に依存するスクリプトを再検証します。

バージョン間の変更点については、 リリース ノート をご覧ください。

ホストをアップグレードしても、インストール済みのツールは自動的にアップグレードされません。ツールを更新するには:

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

デフォルトでは、各ツールバージョンはCLIのMAJORを追跡します。MINOR 行があるため、CLI のアップグレード後に uip tools update を実行すると、インストールされているすべてのツールがステップを踏むようになります。ピン留めコントラクトについては、 ツール (プラグイン) を参照してください。

アンインストールする

インストールに使用したパッケージ マネージャーで CLI を削除します。

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

これにより、 uip 実行可能ファイルとインストール済みのツールが削除されます。

資格情報とデータを削除する

パッケージをアンインストールすると、ディスク上の状態がいくつか残されます。最初からやり直す場合や、マシンを使用停止にする必要がある場合は、手動でクリーンアップしてください。

セッション資格情報

uip login では、既定でホーム ディレクトリの [ ~/.uipath/ ] 内でセッションが保持されます。CLI が起動すると、現在のディレクトリから最初に .uipath/ フォルダを探して移動するため、プロジェクト フォルダはユーザーのホーム ディレクトリを変更することなく独自のセッションを実行できます。クリーンアップするときは、両方の場所を確認してください。

# macOS / Linux
rm -rf ~/.uipath

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

また、あなたが携わった各プロジェクトで、地元の .uipath/ も確認してください。完全なレイアウトについては 、「セッションと資格情報 」をご覧ください。

シェル補完

uip completionを実行した場合、アンインストール後も完了ブロックはシェルの rc ファイルに残っています。@uipath/cliをアンインストールする前に削除するか、~/.zshrc、~/.bashrc、または$PROFILEから手動でクリーンアップしてください。

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

npm グローバル キャッシュ

npm は、ダウンロードされた tarball のローカルキャッシュを npm config get cacheによって報告されたパスに保持します。これは、ほとんどのユーザーにとってクリーンアップする必要はありません。ディスク領域を回復するため、または破損したダウンロードをトラブルシューティングするためにのみ、クリーンアップします。

npm cache clean --force

トラブルシューティング

uip: インストール後にコマンドが見つからない

npm グローバル ディレクトリが PATH上にありません。npm config get prefixを実行してnpmがuipランチャーを配置した場所を確認し、そのディレクトリのbinサブフォルダーをPATHに追加して、新しいターミナルを開きます。

インストール時の EACCES またはアクセス許可エラー

macOS と Linux では、 sudo npm installを避けてください。ユーザーローカルプレフィックスを一度だけ使用するようにnpmを構成します。

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

次に、 npm install -g @uipath/cliを再インストールします。

ツールの自動インストールがハングまたはタイムアウトする

npmをブロックするプロキシの背後にいる可能性があります。「企業プロキシの背後」の説明に従ってHTTPS_PROXYを構成するか、インターネットにアクセスできるマシンにツールをプレインストールし、グローバル node_modulesドキュメントをターゲット マシンにコピーします。

ノードのバージョンが古すぎる

uip には Node.js 18 以降が必要です。[ nvm use 20] を使用してNode.jsバージョンをアップグレードしたり、バージョンを切り替えたりできます。

その他のエラーとその解決策については 、「トラブルシューティング 」をご覧ください。

次のステップ

• クイックスタート — 5 分でログインし、Orchestrator のフォルダーの一覧を表示して、ジョブを実行できます。
• 最初のパイプライン — プロジェクトをパッケージ化し、CI からデプロイします。
• 認証 — CI の対話型ログイン、外部アプリケーションクライアント認証情報、環境変数認証。
• UiPath CLI をコーディング エージェントと使用する — スキルを Claude Code、Cursor、GitHub Copilot、または Gemini CLI にインストールします。