UIP ツール

uip tools は、CLI を拡張するインストール可能な ツール を管理します。概念については、 ツール (プラグイン) を参照してください。

CI ランナーでの自動インストールを制御する方法については、「 ツールの自動インストールの制御」を参照してください。

概要

uip tools list
uip tools search [<query>]
uip tools install <package-spec>
uip tools update [--name <package>] [--version <version>]
uip tools uninstall <package>

uip toolsすべてのサブコマンドは、グローバルオプション (--output、 --output-filter、 --log-level、 --log-file) を優先します。終了コードは 標準コントラクトに従います。

UIP ツールのリスト

CLI と共に現在インストールされているツールを一覧表示します。

引数

設定はありません。

オプション

設定はありません。

例

uip tools list --output table

Data shape (--output json)

{
  "Code": "ToolList",
  "Data": [
    {
      "name": "@uipath/orchestrator-tool",
      "version": "1.0.2",
      "commandPrefix": "or"
    },
    {
      "name": "@uipath/solution-tool",
      "version": "1.0.1",
      "commandPrefix": "solution"
    }
  ]
}

commandPrefix 、最上位のエイリアスを入力します (例: Orchestrator の or )。これを使用して、実際に実行される内容 uip <prefix> … を確認します。

UIP ツール検索

UiPath ツール カタログで、インストール可能なツールを検索します。結果は、ホワイトリストに登録された @uipath/ ツール (明示的なインストールを必要とする flow や rpa-legacyを含む) にフィルタリングされます。サードパーティのパッケージは返されません。

引数

• <query> (オプション) — 部分文字列はパッケージ名と説明と一致します。これがないと、ホワイトリストに登録されたすべてのツールが一覧表示されます。

オプション

設定はありません。

例

uip tools search orchestrator

Data shape (--output json)

{
  "Code": "SearchResult",
  "Data": [
    {
      "name": "@uipath/orchestrator-tool",
      "latestVersion": "1.0.2",
      "description": "Orchestrator jobs, folders, processes, packages, and resources",
      "availableVersions": ["1.0.0", "1.0.1", "1.0.2"]
    }
  ]
}

検索は、@uipathスコープ用に構成された npm レジストリから読み取ります (通常、既定の npm 構成、または.npmrcでオーバーライドされたレジストリ セットを介してhttps://registry.npmjs.org/)。結果はホワイトリストに対してクライアント側でフィルタリングされるため、ホワイトリストにない @uipath/ パッケージは省略されます。

UIP ツールのインストール

npm からホワイトリストに登録されたツールをインストールします。

引数

• <package-spec> (必須) — インストールするツールです。次のいずれか:
  • コマンドエイリアス: or、 solution、 tm、 is、 vss、 df、...
  • 短い名前: orchestrator-tool、 solution-tool、...
  • 完全な npm 名: @uipath/orchestrator-tool、 @uipath/solution-tool、...
  • 明示的なバージョン: orchestrator-tool@1.0.2、 @uipath/orchestrator-tool@1.0.2、 orchestrator-tool@beta。

オプション

設定はありません。

例

# by alias — simplest
uip tools install or

# by short name
uip tools install orchestrator-tool

# by full npm name
uip tools install @uipath/orchestrator-tool

# specific version
uip tools install orchestrator-tool@1.0.2

# preview channel (npm dist-tag)
uip tools install orchestrator-tool@beta

Version resolution

• 明示的なバージョン (@1.0.2 または @beta) では、そのバージョンがそのまま使用されます。
• バージョンがない場合、ホストはCLIの現在のメジャーに一致する最新の公開バージョンを選択します。MINOR 行 — したがって、CLI 1.0.x はツール 1.0.*をインストールします。これにより、ホストとツールのプロトコル互換性が維持されます。「バージョン管理と安定性」をご覧ください。

インストールターゲット:ツールはCLIのnpmパッケージの隣にインストールされます—CLIがグローバルインストールの場合はグローバルに、CLIがプロジェクトスコープのインストールの場合はローカル。スコープ フラグを渡しません。npm root -gを実行して、マシン上のグローバル インストール パスを見つけます。

ホワイトリストの適用: <package-spec> ホワイトリストに登録されている @uipath/ パッケージ (または rpa-legacy) のいずれかに解決する必要があります。他の値は ValidationError と終了コード 3 で失敗します — サードパーティツールは 1.x ではサポートされていません。

Data shape (--output json)

{
  "Code": "Message",
  "Data": { "Message": "Successfully installed @uipath/orchestrator-tool@1.0.2" }
}

UIP ツールの更新

インストールされている 1 つまたは複数のツールを互換性のある最新バージョンに更新します。

引数

設定はありません。

オプション

• --name <package> — 単一のツールを更新します。エイリアス、短い名前、または完全な npm 名を受け入れます。--nameしない場合、インストールされているすべてのツールが更新されます。
• --version <version> — ターゲット バージョン。デフォルトは latestで、 install と同じ方法で解決されます(CLI の MAJOR に固定されます。マイナーライン)。正確なバージョン (1.0.3) または dist-tag (beta) を渡して上書きします。

例

# update every installed tool to the latest version within the CLI's major.minor line
uip tools update

# update just the Orchestrator tool
uip tools update --name or

# pin a specific tool to an exact version
uip tools update --name orchestrator-tool --version 1.0.3

# switch a tool to a preview channel
uip tools update --name flow-tool --version beta

Data shape (--output json)

{
  "Code": "UpdateResult",
  "Data": [
    {
      "name": "@uipath/orchestrator-tool",
      "status": "updated",
      "from": "1.0.1",
      "to": "1.0.2"
    },
    {
      "name": "@uipath/solution-tool",
      "status": "up-to-date",
      "from": "1.0.1",
      "to": "1.0.1"
    }
  ]
}

ツールごとの結果は、部分的な失敗の場合でも常に出力されます。いずれかのツールが更新に失敗した場合、コマンドは 0 以外の終了コードで終了し、失敗したエントリには error フィールドが付きます。

uip ツールのアンインストール

インストール済みのツールを削除します。

引数

• <package> (必須) — エイリアス、短い名前、または完全な npm 名。

オプション

設定はありません。

例

uip tools uninstall or
uip tools uninstall @uipath/solution-tool

Data shape (--output json)

{
  "Code": "Message",
  "Data": { "Message": "Successfully uninstalled @uipath/orchestrator-tool" }
}

アンインストール後に uip or … を呼び出すと、自動インストールがブロックされていない限り (ネットワーク アクセスのないランナーなど)、次回の使用時に Orchestrator ツールが再度自動インストールされます。これを回避するには、明示的にインストールしてください。

終了コード

• 0 — 成功。
• 1 — 失敗(インストール、更新、アンインストール、またはツールレベルのエラー)。複数のツールを使用する update では、少なくとも 1 つが失敗していました。
• 3 — 検証エラー (不明なエイリアス、ホワイトリストに登録されていないパッケージ、無効なバージョン文字列)。

表全体については 、「終了コード 」を参照してください。

参照

• ツール (プラグイン) — プラグインのモデル、バージョンのピン留め、インストール場所、サードパーティのサポート。
• UiPath CLI をインストールする — ホストをインストールしてから、ツールを持ち込む。
• ツールの自動インストールの制御 — オプトアウトがない理由と、CI のビルド時間を決定論的に保つ方法。
• バージョン管理と安定性 — ホストとツール間での semver の契約。