- 概要
- はじめに
- 概念
- UiPath CLI を使用する
- 使用ガイド
- CI/CD レシピ
- コマンド リファレンス
- 概要
- 終了コード
- グローバル オプション
- uip codedagent
- UIP コーダー
- UIP のコンテキスト グラウンディング
- uip docsai
- uip 関数
- UIP ガードレール
- uip llm - 構成
- uip llm-gateway
- uip model-hub
- add-test-data-entity
- テスト データのキューを追加
- 追加-テスト-データ-バリエーション
- 分析
- 開発
- プロジェクトを作成
- 差分
- アクティビティを検索
- GET-ANALYZER-RULES
- get-default-activity-xaml
- エラーを取得
- 手動テスト用のテスト ケースを取得
- 手動テストステップを取得
- get-library-object-repository
- オブジェクト リポジトリを取得
- get-versions
- Get-workflow-example
- indicate-application
- 要素を示す
- inspect-package
- install-data-fabric-entities
- パッケージのインストールまたは更新
- list-data-fabric-entities
- リスト - インスタンス
- list-workflow-examples
- パッケージ化
- パブリッシュ
- リモート
- 元に戻す
- 実行、デバッグ、実行
- ファイル名を実行
- 検索テンプレート
- スタートスタジオ
- 実行を停止
- TM
- UIA
- UIP タスク
- uip traces
- UIP トレースのフィードバック
- 移行
- 参照とサポート
ツールのインストール不要の UiPath CLI の主要なコマンド (認証、ツールのライフサイクル、スキル、MCP ブリッジ、シェルの完了など)
コアコマンドサーフェスは、ホスト(@uipath/cli)に付属しているすべてのものであり、ツールのインストールは必要ありません。これらのコマンドは、認証、ツールのライフサイクル、AI コーディングエージェントのスキル、MCP ブリッジ、およびシェルの完了を管理します。このページのすべてのコマンドは、完了した瞬間 npm install -g @uipath/cli 使用できます。
UiPath サーフェス (Orchestrator、ソリューション、エージェントなど) と通信するコマンドについては、ツールごとのリファレンス ページをご覧ください。各リファレンス ページは、ホストがオンデマンドで読み込む個別の npm パッケージで提供されます。
ホスト コマンド
CLI ホストは 11 個のトップレベル コマンド (uip track は非表示の内部テレメトリであり、ユーザ向けではありません。他の 10 個は次のとおりです。
| コマンド | 目的 | ログインが必要です。 |
|---|---|---|
uip login | 対話型 OAuth2、外部アプリ、環境変数、またはフェデレーション/ワークロード ID を介して認証するテナントを切り替えます。.uipath/.authにセッションを書き込みます。 | — |
uip logout | 資格情報ファイルを削除します。 | — |
uip login status | 現在の組織、テナント、有効期限、および CLI が読み取っているログイン情報ファイルを表示します。 | 任意 (それ以外の場合はレポート Not logged in ) |
uip config | ローカルの CLI 構成値を取得、設定、クリアします (バージョン ピン uip tools update 読み取りを含む)。 | — |
uip user | 現在認証されているユーザーの ID を表示する | はい |
uip feedback | CLI に関するフィードバックを送信してください。 | — |
uip tools | インストール可能なツール (Orchestrator、ソリューション、エージェント、Test Manager など) を一覧表示、検索、インストール、更新、アンインストールします。 | — |
uip skills | AI コーディング エージェントに UiPath スキルをインストールします。 | — |
uip mcp | CLI を stdio 上のモデル コンテキスト プロトコル サーバーとして公開します。 | run_command単位 (ファイルベースのセッションを継承) |
uip update | CLI、インストールされているツール、およびインストールされているスキルを自己更新します。 | — |
uip completion | シェルタブ補完(bash、zsh、fish、pwsh)をインストールまたは印刷します。 | — |
概要
uip login [--tenant <name>] [--organization <name>] [--authority <url>] [--client-id <id>] [--client-secret <secret> | --client-assertion <jwt>] [--scope <scopes>] [--no-browser] [-f <folder>]
uip login status [-f <folder>]
uip login refresh [--login-validity <minutes>]
uip login which [-f <folder>]
uip login tenant list [-f <folder>]
uip login tenant set <name> [-f <folder>]
uip logout [-f <folder>]
uip config get / set / clear <key>
uip user
uip feedback send
uip tools list / search / install / update / uninstall …
uip skills list / search / show / install / update / uninstall --agent <name>
uip mcp serve
uip update [--dry-run] [--tools-only] [--skills-only]
uip completion [shell] [--print] [--uninstall]
uip login [--tenant <name>] [--organization <name>] [--authority <url>] [--client-id <id>] [--client-secret <secret> | --client-assertion <jwt>] [--scope <scopes>] [--no-browser] [-f <folder>]
uip login status [-f <folder>]
uip login refresh [--login-validity <minutes>]
uip login which [-f <folder>]
uip login tenant list [-f <folder>]
uip login tenant set <name> [-f <folder>]
uip logout [-f <folder>]
uip config get / set / clear <key>
uip user
uip feedback send
uip tools list / search / install / update / uninstall …
uip skills list / search / show / install / update / uninstall --agent <name>
uip mcp serve
uip update [--dry-run] [--tools-only] [--skills-only]
uip completion [shell] [--print] [--uninstall]
また、すべてのコマンドはグローバル --interactive/--no-interactive フラグ ( グローバルオプションを参照) を尊重します — コマンド固有の短縮形はありません。
すべてのコア コマンドは、 グローバル オプション (--output、 --output-filter、 --log-level、 --log-file、 --profile、 --interactive/--no-interactive) を尊重し、標準の 終了コード コントラクトに従います。
コアサーフェスとツールの関係
他のすべての uip <tool> … 呼び出しは、次の上で実行されます。
- 認証 は
uip loginで一度確立され、後続のすべてのツール呼び出し (Orchestrator、ソリューション、エージェントなど) に継承されます。 - ツールのライフサイクル (
uip tools install) は、次回ツールのプレフィックスを呼び出したときに読み込まれる拡張機能パッケージを制御します。 - スキルは ツールの横にあり、新しいコマンドを追加するのではなく、AIエージェントに
uipの使い方を教えます。 - MCP は、サーフェス全体 (コア + インストールされているツール) を、MCP 対応クライアントが呼び出すことができる 1 つの MCP ツールとしてラップします。
- 完了はインストール時にコマンドを検出するため、新しく追加されたコマンドの完了が必要な場合は、
uip tools install後にuip completionを再実行してください。
ホストとツールのアーキテクチャに合わせて UiPath CLI がどのように構成されているか について詳しくは、こちらをご覧ください。
認証図形
authコマンド自体を除くすべてのコアコマンドは、セッションなしで動作します — ローカルファイル(config、manifest、completion script)と通信するだけです。auth コマンドは、セッション自体を管理します。
uip login— 対話型 OAuth2 (ブラウザー)、外部アプリ (クライアント資格情報)、環境変数トークン、フェデレーション/ワークロード ID (--client-assertion)。「 認証」をご覧ください。--profile、使用するフローに直交する、名前付き資格情報セットにセッションのスコープを設定します。uip logout— ファイルを削除します。env-var フローにはクリアするものは何もありません。uip login status— アクティブなセッションを報告します。uip login refresh— アクセス トークンをプロアクティブに更新し、プログラムによるコンシューマー向けに機械判読可能なセッション ペイロードを出力します。uip login which— アクティブなセッション/資格情報ファイルが解決された場所を出力します。uip login tenant list / set— 再認証せずにテナントを切り替えます。
ツールコマンドは、呼び出し時にディスク上にあるセッションを継承します。 --tenant は呼び出しごとにオーバーライドされます。
各コマンドの出力の送信先
| ストリーム | コンテンツ |
|---|---|
| Stdout | 構造化された JSON エンベロープ (Result、 Code、 Data、...)。呼び出しごとに 1 つ。 |
| Stderr | ログ ( --log-levelで制御)、進行状況インジケーター、人間が判読できるエラー テキスト。決してマシン解析不可能な JSON です。 |
分割はいたるところで実施されます。これらは個別にリダイレクトできます。
uip tools list > tools.json 2> uip.log
uip tools list > tools.json 2> uip.log
5 つの形式 (json、table、yaml、plain、markdown) および JMESPath フィルター処理の出力形式をご覧ください。
参照
- 概念: UiPath CLI の構成方法 — 「ホスト」の意味と、コアがツールから分離されている理由
- 概念: ツール (プラグイン) — 自動インストールのホワイトリストとバージョンのピン留め。
- 概念: スキル —
uip skills installAI エージェントを拡張する方法。 - 概念: セッションと資格情報 —
uip loginが書き込む内容と場所。 - 認証 — フェデレーション/ワークロード ID ログインなど、認証フローの詳細を指定します。
- グローバルオプション、 終了コード : すべてのコマンドで共有される限月。