ツール (プラグイン)

UiPath CLI のツール アーキテクチャでは、インストール可能な npm パッケージが新しいトップレベルのコマンドでホストを拡張する方法について説明します。

UiPath CLI は、インストール可能な ツールのセットをラップした小さなホストです。各ツールは、1つのトップレベルコマンド(およびそのサブコマンド)をホストに登録する通常のnpmパッケージです。これは、 uip がなぜそのように動作するのか、つまり、自動的にインストールされるもの、インストールされないもの、バージョンの同期を維持する方法、マシンごとに異なるコマンドが表示される理由を理解するための最も重要な概念です uip --help 。

ホストとツール

ホスト (@uipath/cli、 uip 実行可能ファイル) は、 限られた関心事のみを所有します。

• 認証 (uip login、 uip logout、 uip login status、 uip login tenant …)
• セッションと資格情報の管理。
• ツールのライフサイクル (uip tools list / search / install / update / uninstall
• エージェントをコーディングするためのスキル (uip skills install / update / uninstall)
• モデル コンテキスト プロトコル ブリッジ (uip mcp)。
• シェル補完インストール (uip completion)
• グローバル オプション (--output、 --output-filter、 --log-level、 --log-file)、および JSON 出力エンベロープ

UiPath サーフェスに触れるすべてのもの (Orchestrator、ソリューション、エージェント、フロー、Maestro、RPA パッケージ、Test Manager、Integration Service、Data Fabric、Insights、トレース、DocsAI、API ワークフロー、垂直ソリューション、コード化されたエージェント、コード化されたApps) は、ホストがオンデマンドで読み込む独立した npm パッケージに含まれています。

分割の理由:

• 独立したリリース周期 — Orchestrator ツールは、ホストを再リリースせずに出荷できます。また、その逆も同様です。
• インストールフットプリントの縮小 — テストパイプラインのみを実行するユーザーは、ディスク上にFlowまたはMaestroツールを必要としません。
• 安定したコントラクト — ツールは、共有内部ではなく、バージョン管理されたプログラムインターフェイス(コマンド登録、出力エンベロープ、コンテキスト、テレメトリ)を介してホストと通信します。
• 起動の高速化 — ツールコードは遅延して読み込まれます。ホストは、argvを解析して関連するツールを識別するために最小限のことを行い、そのツールのバンドルを一度要求します。

自動インストールのホワイトリスト

UiPath が所有する一連のツールは、 自動インストールのホワイトリストに登録されています。ホストはコマンドエイリアスでそれらを認識し、エイリアスをnpmパッケージにマッピングします。

エイリアス	パッケージ	長い名前
or	@uipath/orchestrator-tool	Orchestrator (ジョブ、フォルダー、プロセス、パッケージ、マシン、ユーザー、ロール、ライセンス、アセット、キュー、ストレージ バケット、ライブラリ、トリガー、Webhook)
solution	@uipath/solution-tool	解決策
rpa	@uipath/rpa-tool	RPA (Studio のパッケージ化、アナライザー、復元)
agent	@uipath/agent-tool	オペレーター
codedagent	@uipath/codedagent-tool	コード化されたエージェント
codedapp	@uipath/codedapp-tool	コード化されたアプリ
maestro	@uipath/maestro-tool	Maestro
tm	@uipath/test-manager-tool	Test Manager
is	@uipath/integrationservice-tool	Integration Service
vss	@uipath/vertical-solutions-tool	バーティカルソリューション
api-workflow	@uipath/api-workflow-tool	API ワークフロー
df	@uipath/data-fabric-tool	Data Fabric
insights	@uipath/insights-tool	Insights
traces	@uipath/traces-tool	トレース
docsai	@uipath/docsai-tool	DocsAI
rpa-legacy	@uipath/rpa-legacy-tool	RPA レガシ — クロスプラットフォームの rpa ツールにまだ移植されていない Studio のコマンド (debug、validate、find-activities、find-package、type-definition、package) をuipcli.exe囲む Windows 専用のラッパーです。詳しくは、「 uip rpa-legacy」をご覧ください。
eval	@uipath/eval-tool	デプロイ済みのパッケージを Orchestrator プロセス (評価器、評価セット、評価、スケジュール) に対して実行時に評価します。スタンドアロン パッケージであり、 orのサブコマンドではありません。
platform	@uipath/platform-tool	プラットフォーム — テナント ライセンス、ユーザー バンドル、グループ ルール、消費型
admin	@uipath/admin-tool	管理者 — ユーザー、グループ、ロボット アカウント、外部アプリ、SMTP、認可、IP 制限、組織、テナント、VPN ゲートウェイ、リソース カタログ、監査
gov	@uipath/gov-tool	ガバナンス — AOps ポリシー、アクセス ポリシー、コンプライアンス パッケージ
agenthub	@uipath/agenthub-tool	AgentHub — MCP サーバーの登録、ツール、リモート A2A エージェント
ah	@uipath/automation-hub-tool	Automation Hub — アイデア、パイプライン、タクソノミー、ユーザー
aops	@uipath/aops-tool	StudioAdmin AOps — コネクション、リポジトリ、プロジェクト、ソリューション、パイプライン、実行
coder	@uipath/coder-tool	Coder — AI コーディング エージェント (プレビュー ビルドのみ)
context-grounding	@uipath/context-grounding-tool	コンテキスト グラウンディング — Python ブリッジ
conversational	@uipath/conversational-tool	会話型 — チャット、エージェント、会話履歴、トランク
function	@uipath/function-tool	関数 — JS/TS および Python 関数のビルド、サーブ、パブリッシュ
guardrails	@uipath/guardrails-tool	ガードレール — BYO ガードレールの設定、AI Trust Layer
ixp	@uipath/ixp-tool	IXP — インテリジェントなドキュメント処理 (プロジェクト、タクソノミー、ドキュメント、デプロイ)
llm-configuration	@uipath/llmgw-tool	LLM の設定 — BYO LLM 接続、AI Trust Layerパッケージ名 (llmgw-tool) がエイリアスと一致しないことに注意してください。
llm-gateway	@uipath/llm-gateway-tool	LLM ゲートウェイ — 利用可能なモデルのリストを表示します。名前は似ていますが、上記の llm-configuration とは別のパッケージです。
model-hub	@uipath/model-hub-tool	モデル ハブ — LLM ゲートウェイのルーティング設定
pm	@uipath/pm-tool	Process Mining — アプリ、変換、データ取り込み
tasks	@uipath/tasks-tool	Action Center のタスク — カタログ、コメント、ラベル、メタデータ、データ

ホストは、他のすべてをツールではないものとして扱います。この表は現在の TOOLS_WHITELIST と完全に一致します — すべてのエントリには、このサイトの参照ページがあります。@uipath/flow-toolと @uipath/case-tool は意図的に欠落しています。つまり、個別にホワイトリストに登録されるのではなく、flowとcaseブランチを登録するためにインポート@uipath/maestro-tool依存関係です (「UiPath CLI について」の注をご覧ください)。

自動的にインストールされるものとインストールされないもの

何もプリインストールされていません。新しい npm install -g @uipath/cli では、ホストのみがディスクに配置されます。

マシンにツールをインストールするには、次の 2 つの方法があります。

1. 初回使用時に自動インストールされます。プレフィックスがホワイトリストのエントリと一致するコマンドを初めて呼び出すと (たとえば、Orchestrator ツールがインストールされる前 uip or folders list )、ホストは npm から @uipath/orchestrator-tool をダウンロードしてインストールし、コマンドを実行します。その後の呼び出しでは、インストールされているツールが直接使用されるため、2 回目の実行は高速です。

2. 明示的なインストール。uip tools install <alias> (または完全なパッケージ名) を実行します。同じ終了状態。自動インストールの手順が不要なため、実行時の処理時間が短縮されます。詳しくは、「 uip tools reference」をご覧ください。

CI ランナーとオフライン環境では明示的なインストールを使用して、ビルド時間が決定論的であり、ジョブの最初のコマンドで 1 回限りのダウンロード コストが支払われないようにします。完全なトレードオフについては、 インストールガイドの自動インストールセクションを参照してください 。

注:

CI=trueでは自動インストールは無効化されません。この変数は自動インストール パスのどこにも参照されません。実際のオプトアウトは UIPATH_CLI_DISABLE_AUTOINSTALL=trueです。この場合、ツールごとの鮮度を毎日チェックする場合を含め、暗黙的なツールのインストールを完全にオフにします (以下の 「バージョンの解決方法 」を参照)。これがない場合、実用的な回避策は、使用することがわかっているツールをプリインストールすることです — ツールがすでに存在する場合、自動インストールは動作しません。

サードパーティ ツールは UiPath CLI 1.x で はサポートされていません 。ホストはインストール時にホワイトリストに対して検証を行うため、uip tools install my-company/some-toolValidationErrorで失敗します。パブリック拡張メカニズムは、後のバージョンで表示される場合があります。現時点では、上記の表のツールのみが読み込まれ uip 。

ディスク上のツールが存在する場所

ツールは、CLI のエントリ スクリプトを所有する npm プレフィックスの下の @uipath/ フォルダーにインストールされます。

• @uipath/cli をグローバルにインストールした場合 (npm install -g @uipath/cli)、ツールはその隣にグローバルにインストールされます — $(npm root -g)/@uipath/<tool-name>/.
• CLI をローカル プロジェクト(パッケージ内のnpm install @uipath/cli )にインストールした場合、ツールはその隣に ローカル (そのプロジェクトの node_modules/@uipath/<tool-name>/)にインストールされます。

言い換えれば、ツールはCLIに従います:グローバルCLI、グローバルツール。ローカル CLI、ローカル ツール。これは自動的に処理され、スコープ フラグを渡す必要はありませんuip tools install

uip tools listを実行して、インストールされているツールとバージョンを確認します。npm root -gを実行して、マシン上のグローバル インストール パスを見つけます。

バージョンの解決 — ツールはホストを追跡します

デフォルトでは、 各ツールバージョンはCLIのmajor.minor行に固定されます。CLI 1.0.xを使用して uip tools install or を実行すると、ホストはバージョンが 1.0. で始まる最新の@uipath/orchestrator-toolを解決してインストールします。uip tools updateを実行すると、インストールされているすべてのツールが、CLIのmajor.minor行内の最新バージョンにバンプされます。

実際的な結果:

• CLI を新しいマイナー バージョンにアップグレードするには、2 段階の操作が必要です。npm install -g @uipath/cli@1.1.0後、uip tools updateを実行して、インストールされているすべてのツールを 1.1.x にします。行。
• CLI をピン留めすると、すべてのツールが効果的にピン留めされます。npm install -g @uipath/cli@1.0.3 、 uip tools update は、任意のマシン上で決定論的なツール バージョンのセットを生成します。
• ホストとツールは、互換性のあるプロトコルの変更を一緒に出荷します。1.1.x に対して構築されたツール1.0.x という内部コントラクトを呼び出すことができます知らない — CLI+ツールのバージョンを混在させると、ホストが理解できないツールをロードするリスクがあります。

既定値を上書きして、特定のツール バージョンを明示的にインストールできます。

uip tools install orchestrator-tool@1.2.3
uip tools update --name @uipath/orchestrator-tool --version 1.2.5

プレビュービルドは、install コマンドの @beta のように npm dist-tag を使用して選択されません — その構文は存在しません。代わりに、CLI 全体のリリース チャネルは構成設定 ( core.updateChannel) になりますuip configで管理されます。

uip config set updateChannel preview   # opt into preview tool builds
uip tools install orchestrator-tool    # now resolves the preview line

uip config set updateChannel stable    # switch back

updateChannel は stable (既定) または previewのいずれかです。mainからパブリッシュされた CLI ビルドには、アドバタイズされていない dev チャネルが 3 つ目に存在します。それ以外の点では安定したツール 内の プレビュー コマンドには、個別にラベル付けされます。詳しくは、「 バージョン管理と安定性」をご覧ください。

また、CLI 自体とそのツールは自動的に最新の状態に保たれます。1 日に 1 回、最初に適格な uip コマンドは、構成されたチャネルで新しい CLI バージョンをチェックし、存在する場合はそのバージョンで再実行します (新しい MAJOR バージョンを無人で交差することはありません)。これとは別に、インストールされた各ツールは、毎日初めて使用するときに、CLI 独自の行で最新バージョンに更新されます。どちらのチェックも失敗し、完了できない場合はサイレントにスキップされるのではなく、閉じられます。UIPATH_CLI_DISABLE_VERSION_SYNC=trueで両方を無効化します。「latest」を追跡する代わりに、自分でバージョン行をフリーズするには、uip config set version <major.minor[.patch]>でピン留めします — 正確なversion/updateChannel契約についてはuip configを参照してください。

ヒント:

デプロイ後にマシン上に存在するツールのバージョンを確認するために、 uip tools list --output json はインストールされた各ツールの名前、バージョン、およびコマンド プレフィックスを出力します。これを既知の正常なスナップショットと比較し、ドリフトをキャッチします。

ホストによるツールの読み込み方法

uip <alias> … が実行されると、以下のようになります。

1. ホストは argv を読み取り、グローバルフラグ (--output、 --log-levelなど) を取り除き、最初の非フラグトークンを潜在的なツールエイリアスとして識別します。
2. エイリアスがインストールされたツールと一致する場合、ホストはそのツールをオンデマンドでロードし、サブコマンドの登録を要求します。
3. エイリアスがホワイトリストにあるが、ツールがインストールされていない場合、ホストは自動インストール(上記を参照)を実行してから、ステップ2に進みます。
4. エイリアスがホワイトリストになく、認識されたホスト コマンドでない場合、ホストは "unknown command" で失敗し、使用状況を出力します。

これがローディングモデル全体です。プラグインマニフェスト、レジストリ設定ファイル、ユーザーが編集できるリストはありません。ホストパッケージに組み込まれているホワイトリストが信頼できる情報源です。

次に読むもの

• uip tools reference — すべての uip tools サブコマンドの完全な構文と例。
• UiPath CLI をインストールする — ホストをインストールします。そこからツールが続きます。
• 制御ツールの自動インストール — CI のUIPATH_CLI_DISABLE_AUTOINSTALLとインストール前の回避策です。
• ツールとスキルの管理 — 日常のワークフロー (アップグレード、バージョンのピン留め、ドリフトの検査)。
• スキル — コーディングエージェントに uipの使い方を教えるための並列システム。スキルはツールではなく、 uip skills は別のコマンドグループです。
• バージョン管理と安定性 — ホストとツールのバージョンが SEMVER の下でどのように調整されるか。