UiPath Documentation
uipath-cli
latest
false
UiPath CLI ユーザー ガイド
重要 :
このコンテンツは機械翻訳によって処理されています。 新しいコンテンツの翻訳は、およそ 1 ~ 2 週間で公開されます。

uip tools

「uip ツール」の構文とオプション - UiPath CLI を拡張する npm ベースのツールをインストール、更新、削除します。

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

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

概要​

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

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

uip tools list​

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

引数​

設定はありません。

オプション​

設定はありません。

uip tools list --output table
uip tools list --output table

データシェイプ (--output json)​

{
  "Code": "ToolList",
  "Data": [
    {
      "Name": "orchestrator-tool",
      "Version": "1.2.3",
      "Description": "UiPath Orchestrator Tool",
      "CommandPrefix": "or",
      "Status": "ok"
    },
    {
      "Name": "agent-tool",
      "Version": "1.1.7",
      "Description": "UiPath Agent Tool",
      "CommandPrefix": "agent",
      "Status": "needs update"
    }
  ]
}
{
  "Code": "ToolList",
  "Data": [
    {
      "Name": "orchestrator-tool",
      "Version": "1.2.3",
      "Description": "UiPath Orchestrator Tool",
      "CommandPrefix": "or",
      "Status": "ok"
    },
    {
      "Name": "agent-tool",
      "Version": "1.1.7",
      "Description": "UiPath Agent Tool",
      "CommandPrefix": "agent",
      "Status": "needs update"
    }
  ]
}
フィールド説明
Nameツール名。
VersionInstalled version.
Descriptionツールの説明
CommandPrefixThe top-level alias you type — for example, or for Orchestrator. Use it to confirm what uip <prefix> … runs.
Statusok when the installed version is on the running CLI's MAJOR.MINOR line. needs update when it is off that line; the CLI replaces the tool with a version on its line the next time you run one of the tool's commands. In an interactive table, needs update rows are highlighted.

UiPath のツール カタログでインストール可能なツールを検索します。結果は、許可リストに登録されている @uipath/ ツール (明示的なインストールが必要な rpa-legacyを含む) に絞り込まれます。他社製パッケージは返されません。

引数​

  • <query> (任意) — 部分文字列をパッケージ名および説明と照合します。追加しない場合は、許可リストに登録されたすべてのツールが一覧表示されます。

オプション​

設定はありません。

uip tools search orchestrator
uip tools search orchestrator

データシェイプ (--output json)​

{
  "Code": "SearchResult",
  "Data": [
    {
      "Name": "@uipath/orchestrator-tool",
      "LatestVersion": "1.2.3",
      "Description": "Manage UiPath Orchestrator resources from the CLI",
      "AvailableVersions": ["1.2.3", "1.2.2", "1.2.1"]
    }
  ]
}
{
  "Code": "SearchResult",
  "Data": [
    {
      "Name": "@uipath/orchestrator-tool",
      "LatestVersion": "1.2.3",
      "Description": "Manage UiPath Orchestrator resources from the CLI",
      "AvailableVersions": ["1.2.3", "1.2.2", "1.2.1"]
    }
  ]
}

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

uip tools install​

Install an allowlisted tool from the npm registry. The CLI resolves the version from whichever registry npm's own configuration sets for the @uipath scope (a scoped @uipath:registry entry in .npmrc, otherwise npm's default registry).

引数​

  • <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。@ の後の値は有効な semver 文字列 (例:1.0.2 または 1.0.0-preview.1) — @beta などのベア チャネル名は、 ValidationErrorで拒否されます。

オプション​

設定はありません。

# 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

# exact preview build
uip tools install orchestrator-tool@1.0.0-preview.1

# preview channel — switch the channel, then install normally
uip config set updateChannel preview
uip tools install orchestrator-tool
# 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

# exact preview build
uip tools install orchestrator-tool@1.0.0-preview.1

# preview channel — switch the channel, then install normally
uip config set updateChannel preview
uip tools install orchestrator-tool

バージョンの解決方法​

  • 明示的な semver バージョン (例:@1.0.2 または @1.0.0-preview.1) の場合、そのバージョンはそのまま使用されます。@beta のような npm-dist-tag の短縮形はありません — @ の後の値は semver として解析しないと、コマンドは ValidationErrorで失敗します。
  • バージョンがない場合、ホストは CLI の更新チャネル ( デフォルトではstable、または uip config set updateChannel <channel>を介して preview/dev ) と現在の MAJOR に対して解決します。MINOR 行 — そのため、stable CLI 1.0.xは、最新の一致する安定ツール 1.0.*をインストールします。これにより、ホストとツールのプロトコル互換性が維持されます。「 バージョン管理と安定性 」および「 uip 構成」をご覧ください。

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

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

データシェイプ (--output json)​

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

Failures​

When no version can be resolved for the CLI's line, the failure envelope carries an ErrorCode that names the cause. When npm's configuration can be read, the message also names the registry that was queried.

ErrorCode原因何をすべきか
authentication_requiredThe registry rejected the credentials.Fix that registry's credentials in .npmrc, then re-run.
network_errorThe registry could not be reached.Check network access and any proxy or registry configuration in .npmrc, then re-run.
not_foundThe registry has no version of the tool on the CLI's MAJOR.MINOR line.Install a build for this line with uip tools install <tool>@<version>, run uip update to move the CLI onto a line that publishes the tool, or point the @uipath scope at the registry that publishes it.
server_errorThe registry returned metadata the CLI could not read.Re-run. If it persists, check whether a proxy or mirror is rewriting the response.

uip tools update​

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

引数​

設定はありません。

オプション​

  • --name <package> — 単一のツールを更新します。エイリアス、短い名前、または完全な npm 名を受け入れます。--nameしない場合、インストールされているすべてのツールが更新されます。
重要:

uip tools updateには--versionフラグはなく、--nameのみが登録されます。すべてのツールは、アクティブなバージョン ポリシー (通常は CLI の MAJOR に固定されます) で許可されている最新バージョンに更新されます。マイナーライン);代わりに特定のバージョンをピン留めするには、 uip config set version <line> を使用するか、 uip tools install <package>@<version>を使用して明示的なバージョンで再インストールします。

# 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
# 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

データシェイプ (--output json)​

{
  "Code": "UpdateResult",
  "Data": [
    {
      "Name": "orchestrator-tool",
      "Status": "updated",
      "From": "1.2.2",
      "To": "1.2.3"
    },
    {
      "Name": "agent-tool",
      "Status": "up-to-date",
      "From": "1.2.3",
      "To": "1.2.3"
    }
  ]
}
{
  "Code": "UpdateResult",
  "Data": [
    {
      "Name": "orchestrator-tool",
      "Status": "updated",
      "From": "1.2.2",
      "To": "1.2.3"
    },
    {
      "Name": "agent-tool",
      "Status": "up-to-date",
      "From": "1.2.3",
      "To": "1.2.3"
    }
  ]
}

Status is updated or up-to-date. If any tool fails to update, the command emits a Failure envelope naming the number of tools that failed, and exits with code 1. Run with --log-level debug to see the per-tool error.

core.versionが正確なバージョン (MAJOR.MINOR行ではない) にピン留めされている場合、更新は完全にスキップされます — ピン留めされたインストールは意図的に移動しないため、コマンドは空の Data 配列とピンを説明するInstructions メモとともに0を終了します。

uip tools uninstall​

インストール済みのツールを 1 つ、またはインストール済みのすべてのツールを一度に削除します。

引数​

  • [package-name] (任意) — エイリアス、短縮名、または完全な NPM 名です。--allと相互に排他的です。引数または --all のいずれか 1 つのみを指定します。両方を省略するか、両方を渡すと、 ValidationErrorになります。

オプション​

  • --all — インストールされているすべてのツールをアンインストールします。[package-name]と相互に排他的です。
# uninstall a single tool
uip tools uninstall orchestrator
uip tools uninstall @uipath/solution-tool

# uninstall every installed tool
uip tools uninstall --all
# uninstall a single tool
uip tools uninstall orchestrator
uip tools uninstall @uipath/solution-tool

# uninstall every installed tool
uip tools uninstall --all

データシェイプ (--output json)​

1 つのツールをアンインストールすると、 Code: "Message"が出力されます。

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

--all は、ツールごとに 1 行の Code: "UninstallResult" を出力します。

{
  "Code": "UninstallResult",
  "Data": [
    { "Name": "orchestrator-tool", "Status": "uninstalled" },
    { "Name": "agent-tool", "Status": "uninstalled" }
  ]
}
{
  "Code": "UninstallResult",
  "Data": [
    { "Name": "orchestrator-tool", "Status": "uninstalled" },
    { "Name": "agent-tool", "Status": "uninstalled" }
  ]
}

Status is uninstalled, skipped for a tool that ships with the CLI itself, or failed. Skipped and failed rows carry an Error field. If any tool fails to uninstall in the --all path, the command exits with code 1 — the full per-tool breakdown is still emitted.

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

終了コード​

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

uninstall独自の引数検証エラー (パッケージ名が見つからない、またはパッケージ名と組み合わさった--all) は、応答本文で Result: "ValidationError" を報告するにもかかわらず、3ではなく 1 を終了します。この場合、このケースを他の失敗と区別する必要がある場合は、JSON 本文で終了コードではなく Result/ErrorCode で分岐します。

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

参照​

このページは役に立ちましたか?

接続

ヘルプ リソース サポート(opens in new window)

学習する UiPath アカデミー(opens in new window)

質問する UiPath フォーラム(opens in new window)

最新情報を取得