UiPath CLI について

注:

UiPath CLI は現在 パブリック プレビューの段階です。バージョン 1.0.0 より前のリリースはすべてプレビュー リリースであり、バージョン間の重大な変更が含まれている場合があります。バージョン 1.0.0 は最初の安定版リリースとなります。

UiPath コマンド ライン インターフェイス (UiPath CLI、 uipとして呼び出される) は、UiPath Platform 用のクロスプラットフォーム コマンド ライン ツールです。開発者、RPA エンジニア、DevOps チームは、UiPath のオートメーション (Orchestrator のジョブとリソース、ソリューション、エージェント、フロー、Maestro プロセス、Test Manager のアセットなど) をターミナルまたは CI/CD パイプラインから 構築、管理、運用、デプロイ できます。

UiPath CLI は npm で配布され、 セマンティック バージョニング (MAJOR.MINOR.PATCH) に従います。これにより、 2025.10 まで使用されていたカレンダーベースのスキームと、従来の .NET CLI (uipcli.exe) が置き換えられます。

注:

これは、UiPath CLI (TypeScript ベースの uip コマンド) のドキュメントです。レガシ .NET CLI (uipcli.exe / dotnet uipcli.dll) については、 CI/CD との連携 2025.10 のドキュメントをご覧ください。移行ガイドが利用可能です。

Azure DevOps 拡張機能、Jenkins プラグイン、およびその他のパイプライン連携については、「CI/CD との連携」をご覧ください。

単なるCI/CDツールではない

以前の UiPath のコマンドライン ツールは、CI/CD タスク (テストのパッケージ化、分析、デプロイ、実行) に重点を置いていました。UiPath CLI 1.x では、これらの機能がすべて保持され、プラットフォーム全体のサーフェスが追加されています。uip を使用して、次のことができます。

• ビルド — プロジェクトをスキャフォールディング (uip solution new、 uip agent init、 uip flow init、 uip maestro init)、パック (uip rpa pack、 uip solution pack、 uip agent pack)、分析 (ガバナンス ポリシーを使用してuip rpa analyze )。
• 管理 — Orchestrator のフォルダー、ユーザー、ロール、ライセンスを操作します。アセット、キュー、ストレージ バケット、ライブラリ、トリガー、Webhook を作成および更新するTest Manager のプロジェクト、テスト セット、結果を管理するIntegration Service のコネクタとコネクションを管理する
• 運用 — Orchestrator のジョブを開始、停止、検査します。Flow および Maestro のインスタンスとインシデントを監視する。エージェントを実行し、データセットに照らして評価するテスト セットを実行し、結果を読み取る。
• デプロイ — パッケージのアップロード、プロセスの作成と更新、ソリューションとエージェントのパブリッシュ、ソリューションのデプロイのアクティブ化またはアンインストールを行います。

これは、ラップトップからプラットフォームを探索する開発者であっても、無人デプロイを実行するパイプライン開発者であっても同じツールです。動詞、フラグ、出力形式、および終了コードは、両方のコンテキストで同じです。

人間 および コーディング エージェント向けに設計

UiPath CLI は、次の 2 人のユーザーが同等に利用できるように設計されています。

• 人間 — インタラクティブな uip login、シェルタブの補完(uip completion)、色付きの --output table ビュー、およびすべてのコマンドに埋め込まれたヘルプ(uip <cmd> --help)を備えたターミナルファーストのエクスペリエンス。
• コーディング エージェント — uip skills システムでは、UiPath のスキルをコーディング エージェントにインストールし、コマンドの種類だけでなく、uipを使用して UiPath のオートメーションを構築、デプロイ、操作する方法を理解できるようにします。サポートされているエージェント: Claude Code、 Cursor、 GitHub Copilot、 Gemini CLI、 Codex、 OpenCode。

uip skills install は、GitHub から完全な UiPath スキル カタログを取得し、1 つ以上のコーディング エージェントにインストールします。ターゲット エージェント (個々のスキルではなく、エージェント自身が特定のタスクに適用するスキルを決定します) を選択します。 --agent <name> を渡すか、フラグを省略した場合はチェックボックス プロンプトから対話的に選択します。既定では、インストールはグローバルです。現在のプロジェクトのスコープ スキルに --local を追加します (エージェントがサポートしている場合 — たとえば、Claude Code はグローバル専用です)。

uip skills install                         # prompts you to pick one or more agents
uip skills install --agent claude          # non-interactive, skills installed globally for Claude Code
uip skills install --agent cursor --local  # non-interactive, skills installed into the current project for Cursor
uip skills update --agent claude           # re-fetch and reinstall to pick up new skills
uip skills uninstall --agent claude        # remove skills for Claude Code

どちらの方法でも同じコマンドが機能します。開発者が手動で入力する uip 呼び出しは、エージェントが行う呼び出しとまったく同じです。つまり、チームは対話形式でオートメーションを構築し、正確なシーケンスをスクリプトにパイプし、それを AI エージェントに渡してさらに反復処理することができます。

出力は デフォルトで JSON です — 開発者のラップトップとパイプラインで同じなので、スクリプトがインタラクティブに実行されているかどうかで分岐する必要はありません。読みやすいビューには --output table を、YAML には --output yaml を、key=value行には --output plain を追加します。JMESPath フィルタリングは --output-filter "Data[*].Name"から利用できます。

UiPath CLI の構成

uip プラグインシステムを備えた小さなホストです。ホストは、認証、セッション管理、構成、およびツールのライフサイクルを処理します。それ以外のすべての機能 (Orchestrator、ソリューション、エージェント、Flow、Maestro、RPA、Test Manager など) は、npm にインストール可能な ツール として同梱されています。

uip <tool> <resource-or-command> [subcommand] [options]

例:

uip login                                # core command
uip or jobs list                         # orchestrator jobs (manage + operate)
uip solution pack ./MySolution ./dist    # solution packing (build)
uip rpa analyze ./MyProject              # workflow analyzer (build)
uip agent deploy my-agent                # agent deploy (deploy)

新しい npm install -g @uipath/cli には、host コマンドと core コマンドのみが含まれており、 ツールはプリインストールされていません。プレフィックスがホワイトリストのツールと一致するコマンドを初めて呼び出すと、ホストはそのツールを npm から自動的にインストールします。また、 uip tools install <name> でツールを明示的にインストールすることもでき、オフラインの準備や CI ランナーに役立ちます。詳しくは 「ツール (プラグイン)」 をご覧ください。

組み込みツール

以下のツールはすべて自動インストールのホワイトリストにあります—プレフィックスを入力するだけで十分です。表示されるプレフィックスは、ホストで定義されている正規名です。

ツール	プレフィックス	目的
Orchestrator	or	ジョブ、フォルダー、プロセス、パッケージ、マシン、ユーザー、ロール、ライセンス、フィード
解決策	solution	UiPath ソリューションのスキャフォールディング、パッケージ化、パブリッシュ、アップロード、デプロイ
リソース	resource	アセット、キュー、ストレージ バケット、ライブラリ、トリガー、Webhook
RPA	rpa	Studio とプロジェクトのパッケージ化、ワークフロー アナライザー、依存関係の復元
オペレーター	agent	ローコード エージェントの作成、パッケージ化、デプロイ、実行
コード化されたエージェント	codedagent	Python ベースのコード化されたエージェント
コード化されたアプリ	codedapp	コード化された Web アプリケーション プロジェクト
Maestro	maestro	Maestro プロジェクトのオーサリング、パッケージ化、実行時の運用
Test Manager	tm	テスト ケース、テスト セット、実行、結果、レポート
Integration Service	is	コネクタと接続
バーティカルソリューション	vss	垂直ソリューションの足場と生成
API ワークフロー	api-workflow	UiPath API ワークフローのローカル実行
Data Fabric	df	Data Fabric の操作
Insights	insights	Insights のダッシュボードとレポート
トレース	traces	実行トレースと診断
DocsAI	docsai	AI を活用した UiPath ドキュメント検索

ヒント:

uip --helpを実行してインストールの正確なプレフィックスを確認し、uip tools listを実行して、現在インストールされているツールを確認します。UiPath CLI 1.x では、上記のホワイトリストに登録された @uipath/ ツールのみがサポートされています。サードパーティの拡張機能はまだ利用できません。フローツール (@uipath/flow-tool) は公開されていますが、自動インストールのホワイトリストには載っていません — uip flow コマンドを使用する前に、uip tools install @uipath/flow-tool で明示的にインストールしてください。

認証の概要

UiPath CLI は、次の 3 つの認証フローをサポートしています。インタラクティブフローは1.xの新機能です。他の 2 つは、レガシ .NET CLI の類似物です。

フロー	使用すべきタイミング	使用方法
対話型 OAuth2 ユーザー ログイン (1.x の新機能)	ターミナルから作業する開発者。セッションを個人アカウントとその権限にバインドします。	uip login サインイン用のブラウザーを開き、テナントを選択します。セッション トークンは自動的に保存および更新されます。
外部アプリ (クライアント資格情報)	CI/CD パイプライン、サーバー、任意の非対話型コンテキスト。UiPath で作成した外部アプリに、明示的なスコープでセッションをバインドします。	uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant <name> — env.VAR プレフィックスは、コマンドラインで公開せずに環境変数からシークレットを読み取ります。
環境変数認証	UiPath アクセス トークンを既に保持しているコンテナーとエフェメラル ランナー。ブラウザーなし、外部アプリのラウンドトリップなし、ディスク上の状態なし。	UIPATH_CLI_ENABLE_ENV_AUTH=trueを設定し、UIPATH_CLI_AUTH_TOKEN + 組織/テナント変数を指定します。すべての uip コマンドは、環境変数から認証されます。更新はありません。

完全なフロー、テナントの選択、資格情報フォルダーのレイアウト、CI 用に外部Appsを事前設定する方法については、「 認証 」をご覧ください。

UiPath CLI とレガシ .NET CLI の比較

アスペクト	UiPath CLI ( 1.xuip、1.x)	レガシ .NET CLI ( 2025.10 以前uipcli)
実行時	Node.js (クロスプラットフォーム)	.NET 8 (Windows ファースト)
分布	npm install -g @uipath/cli	.nupkg MyGet / NuGet フィード
バージョン管理	セマンティック バージョニング (1.0.0、 1.1.0、...)	カレンダーのバージョン管理 (2023.10、 2024.10、 2025.10)
スコープ	プラットフォーム全体にわたって構築、管理、運用、デプロイ	CI/CD に重点を置いた — テストのパッケージ化、分析、デプロイ、実行
認証	対話型 OAuth2 (uip login) と 外部アプリ (クライアント資格情報)	外部アプリ (クライアント資格情報) に加えて非推奨となった Basic/Token Auth
アーキテクチャ	npmからの初回使用時に自動インストールされたモジュラーツール	モノリシック実行可能ファイル
出力形式	table、 json、 yaml、 plain JMESPath フィルタリングを使用	テキスト/JSON (制限あり)
AI との連携	エージェントをコーディングするためのスキルシステム	利用できません。
ワークフロー アナライザー	uip rpa analyzeとして保持され、ガバナンス ファイル ポリシーがサポートされます	CLI にバンドルされています ( のuipcli package analyze)
依存関係の復元	uip rpa restoreとして保持され、エアギャップと NuGet-config がサポートされています	CLI にバンドルされています ( のuipcli package restore)

今日から新しいパイプラインを開始する場合は、UiPath CLI 1.x を使用します。uipcli.exe上に構築された既存の Azure DevOps または Jenkins パイプラインを維持する場合は、コマンド マップ、フラグの名前の変更、および重大な変更については、移行ガイドをご覧ください。

UiPath CLI と CI/CD プラグインの比較

そのツールが UiPath CLI (uip) です。Azure DevOps 拡張機能、Jenkins プラグイン、および同様のパイプライン統合は、そのツールの ラッパー であり、UI 主導のタスク フォーム、セキュリティで保護された変数インジェクション、およびパイプライン ネイティブ ログの背後にある uip 呼び出しをパッケージ化します。今後、これらのプラグインの新しいバージョンは内部で uip を呼び出します。

このプラグインは、パイプラインの UI と変数を管理する場合に使用します。プラグインのリリースを待たずに最新のCLI機能が必要な場合、またはプラグインが公開しないコマンドが必要な場合は、 uip を直接( bash または pwsh ステップを介して)使用します。

プラグインのドキュメントについては 、「CI/CD との連携 」をご覧ください。

サポートされているプラットフォーム

UiPath CLI 1.x は、Node.js 18 以降をサポートするすべてのプラットフォームで実行されます。

• Windows (x64、ARM64)
• macOS (x64、ARM64)
• Linux (x64、ARM64)

安定性とリリース周期

UiPath CLI は、セマンティック バージョニングに従います。

• MAJOR — コマンド名、フラグ セマンティクス、または JSON エンベロープの重大な変更。非推奨化サイクルは、メジャー リリースの前に行われます。
• MINOR — 新しいコマンド、新しいフラグ、新しいツール。Additive のみ。JSON 出力のDataの形状はコマンド固有であり、マイナー リリースで変更される可能性があることに注意してください。パイプラインはピン留め@uipath/cli必要があります。
• PATCH — バグ修正;動作の変更は文書化されていません。

個々のコマンドとツールには、GA、Preview、または Deprecated というラベルが付けられます。プレビューコマンドは、メジャーバージョンのバンプなしで変更される場合があります。非推奨のコマンドは、少なくとも 1 つの MAJOR サイクルの間、機能し続けます。契約全体については、「 バージョン管理と安定性 」をご覧ください。

次のステップ

• UiPath CLI をインストールする — Windows、macOS、または Linux で UiPath uip を設定します。
• クイックスタート — 5 分でログインし、Orchestrator のフォルダーの一覧を表示して、ジョブを実行できます。
• 最初のパイプライン — プロジェクトをパッケージ化し、CI パイプラインからデプロイします。
• UiPath CLI をコーディング エージェントと使用する — スキルを Claude Code、Cursor、GitHub Copilot、または Gemini CLI にインストールし、 uipを使用して UiPath のオートメーションを構築できるようにします。
• コマンドリファレンス — すべてのコマンドの完全なリファレンス。
• レガシ .NET CLI から移行 する — uipcli.exe.