UiPath CLI の構成

UiPath CLI は、小規模なホストに一連のツール、およびいくつかの横断的なサービスを加えて構成されています。ピースがどのように組み合わされるかを理解することで、設計の選択(デフォルトの出力形式、自動インストール、セッションの解決、安定性契約)を簡単に推論できます。このページは、各レイヤーの 1 段落のマップであり、深いページへのリンクがあります。

ホスト

ホストは@uipath/cli npm パッケージであり、npm install -gPATHに配置する uip コマンドで呼び出されます。これは、以下を所有するシンコマンドラインプログラムです。

• Argv 解析とグローバルオプション ( --output、 --output-filter、 --log-level、 --log-fileの 4 フラグコントラクトを含む。グローバルオプションは、ツールのサブコマンドが引数を認識する前に argv から削除されるため、ツールが誤って引数をシャドウイングすることはできません。
• 3 つのフロー (対話型 OAuth2、外部アプリ、環境変数) による認証とセッション管理「セッションと資格情報」をご覧ください。
• 環境変数とコマンドごとのフラグを使用した設定。「設定」をご覧ください。
• uip tools install / update / uninstall / list / searchによるツールのライフサイクルツール (プラグイン) を参照してください。
• uip skills install / update / uninstallによるスキル ライフサイクルツールと直交します。詳しくは、「スキル」をご覧ください。
• uip completion (bash、zsh、fish、pwsh) によるシェル補完。
• MCP 対応クライアント用の uip mcpを介したモデル コンテキスト プロトコル ブリッジ。
• ログ記録、テレメトリ、出力形式、JSON エンベロープ — 一貫性のある出力を生成するためにすべてのコマンドが使用するランタイム サービスです。

ホストは npm に @uipath/cli としてパブリッシュされます。そのリリース周期は、ツールから独立しています。

ツール

Every UiPath surface — Orchestrator, Solutions, Agents, Flows, Maestro, RPA, Test Manager, Integration Service, Data Fabric, Insights, Traces, DocsAI, API Workflow, Vertical Solutions, Coded Agents, Coded Apps — is a separate npm package under the @uipath/ scope. ホストは、これらのパッケージの自動インストールホワイトリストを保持し、最初の使用時にインストールします。ツールは怠惰にロードされます。新規インストールでは、ディスク上のツールはゼロです。

ツールのバージョンは、ホストのMAJORを追跡します。MINOR行なので、CLIをアップグレードして uip tools update を実行すると、ツールチェーン全体が歩調を合わせることができます。

完全なモデルについては 「ツール (プラグイン)」 を、コマンドについては「 uip ツールのリファレンス 」を参照してください。オプトアウトなしの自動インストールの動作については、「 UiPath CLI をインストールする」の「 ツールの自動インストールの制御」をご覧ください。

スキル

スキルは、コマンド サーフェスではなく、AI コーディング エージェントを目的とした並列拡張メカニズムです。uip skills install --agent <name> は、UiPath 固有の命令のカタログを Claude Code、Cursor、GitHub Copilot、Gemini CLI、Codex、または OpenCode に書き込みます。エージェントはこれらの指示を読んで、一般的な UiPath タスク (ソリューションのパッケージ化、エージェントのデプロイ、テスト セットの実行など) に uip を使用する方法を把握します。

スキルとツールは独立しています。ツールはコマンドを追加します。スキルは、エージェントにコマンドの使用方法を教えます。ツールをインストールしてもスキルはインストールされません。その逆も同様です。詳しくは、「スキル」をご覧ください。

セッションと資格情報

uip login はセッション (組織、テナント、およびアクセス/更新トークンのペア) を確立し、 .uipath/ フォルダー内に保持します。CLI は、現在のディレクトリから移動してフォルダーを解決し、プロジェクト ローカル フォルダーが見つからない場合は ~/.uipath/ にフォールバックします。トークンは、更新トークン自体の有効期限が切れるか取り消されるまで、サイレントに更新されます。

3 番目の認証フローは、ディスク上の状態を完全にバイパスします。 UIPATH_CLI_ENABLE_ENV_AUTH=trueを使用すると、CLI はすべての呼び出しで環境変数からトークン + テナント + 組織を読み取り、コンテナーとエフェメラル ランナーに適しています。「 セッションと資格情報 」および「 認証」をご覧ください。

出力コードと終了コード

すべてのコマンドは、stdout に 1 つの構造化されたエンベロープを出力します。json(デフォルト)、table、yaml、plainの4つのフォーマットは、同じエンベロープを異なる方法でレンダリングします。エンベロープの Result フィールドは、スクリプトが文字列を解析せずに分岐できる終了コードの狭いセット(0 / 1 / 2 / 3 / 4 + 130 for user cancel)に1対1でマップされます。

Stdout はエンベロープ用に予約されています。ログ、進行状況インジケーター、人間が判読できるエラー テキストは常に stderr に送信されるため、パイプラインは 2 つのストリームを個別にリダイレクトできます。

「出力形式」、「終了コード」、および「スクリプト パターン」を参照してください。

ログとテレメトリ

ログは構造化された JSON 行です。それらはデフォルトでstderrに移動し、 --log-file <path>とともに、ログシッパーがピックアップするためのファイルに複製されます。--log-level は、冗長性を制御します (debug / info / warn / error)。

テレメトリとは、UiPath の Application Insights に送信される匿名の使用状況データです。UIPATH_TELEMETRY_DISABLED=1 で無効化したり、UIPATH_AI_CONNECTION_STRINGでリダイレクトしたりできます。コマンド引数、ファイルの内容、または資格情報は送信されません。

「 設定」と「 UiPath CLI をインストールする」の「テレメトリ」セクションをご覧ください。

完全なコマンド画面

uip <core-command> …                  # login, logout, tools, skills, mcp, completion
uip <tool-alias> <verb> [options]     # single-workflow tools (solution, agent, flow, maestro, rpa, codedagent, codedapp, api-workflow, vss)
uip <tool-alias> <resource> <verb>    # resource-first tools (or, tm, resource)
uip <tool-alias> [options]            # flat wrappers (df, insights, traces, docsai, is)

3つの形、1つの文法。各ツールのリファレンス ページには、正確な動詞とフラグが記載されています。すべてのツールは、同じグローバルオプションとエンベロープを継承します。

コマンドの実行方法

uip or folders list呼び出しのシーケンスの概要

1. グローバル オプションを解析します。ホストは argv から 、 --output-filter、 --log-level、 --log-file --outputを取り除き、ランタイムを設定します。
2. ツールを解決します。or はホワイトリストと照合されます。@uipath/orchestrator-toolがまだインストールされていない場合は、自動インストールが実行されます。それ以外の場合、ツールは動的に読み込まれます。
3. ツールはサブコマンドを登録します。ホストは uip or folders list およびその他の Orchestrator サブコマンドについて学習します。
4. 認証を解決します。ツールはホストにセッションを要求します。ホストは、 .uipath/ フォルダ(ウォークアップ)やenv-var認証から取得するか、何も利用できない場合は終了コード 2 で高速に失敗する。
5. 構成を解決します。環境変数とフラグは、優先順位チェーンに従って調整されます。
6. 動詞を実行します。ツールは、解決されたセッションと設定を使用して Orchestrator を呼び出し、ホストのフォーマッターを介してエンベロープを出力します。
7. 終了。ホストは、エンベロープの Result をプロセス終了コードに変換します。

このシーケンスに含まれる、Orchestrator に固有のものはありません。すべての uip <tool> … 呼び出しは同じ形状に従うため、スクリプトはツール間で移植できます。

参照

• ツール(プラグイン) — プラグインモデルの詳細。
• スキル — AI エージェントの並列拡張メカニズム。
• セッションと資格情報 — 資格情報フォルダーが存在する場所とその解決方法。
• 構成 — ファイル、環境変数、および優先順位。
• 出力フォーマット、 終了コード、 グローバルオプション — ランタイムコントラクト。