- 概要
- はじめに
- 概念
- UiPath CLI を使用する
- UiPath for Coding Agents
- 使用ガイド
- CI/CD レシピ
- コマンド リファレンス
- 概要
- 終了コード
- グローバル オプション
- uip codedagent
- uip docsai
- add-test-data-entity
- テスト データのキューを追加
- 追加-テスト-データ-バリエーション
- 分析
- 開発
- プロジェクトを作成
- 差分
- アクティビティを検索
- GET-ANALYZER-RULES
- get-default-activity-xaml
- エラーを取得
- 手動テスト用のテスト ケースを取得
- 手動テストステップを取得
- get-versions
- Get-workflow-example
- indicate-application
- 要素を示す
- inspect-package
- install-data-fabric-entities
- パッケージのインストールまたは更新
- list-data-fabric-entities
- list-workflow-examples
- パッケージ化
- 元に戻す
- ファイル名を実行
- 検索テンプレート
- スタートスタジオ
- 実行を停止
- UIA
- UIP トレース
- 移行
- 参照とサポート
UiPath CLI ユーザー ガイド
UiPath CLI は、コマンド ライン ツールをゼロから書き直したもので、API 2025.10で使用されていたuipcli.exe .NET ツールを置き換えるものです。v2025.10 のパイプラインから移行する場合は、 移行ガイド をお読みください。このページでは、変更内容とその理由を要約しています。
別のツール
UiPath CLI は @uipath/cli として npm で配布され、uipとして呼び出される TypeScript CLI です。Windows、macOS、Linux の Node.js 18+ で動作します。ホストとほとんどのツールは .NET に依存しません。rpa-toolは例外で、Studio パッケージャーとワークフロー コンパイラーをラップしますが、どちらも .NET ランタイムを必要とします。すべての環境で同じ方法でホストをインストールします。
npm install -g @uipath/cli
npm install -g @uipath/cli
CLI はプラグイン ホストです。UiPath の各サーフェス (Orchestrator、ソリューション、エージェント、フロー、Maestro、Test Manager など) のコマンドは、個別の npm パッケージとして提供され、初回使用時に uip が自動インストールされます。ツール (プラグイン) を参照してください。
セマンティック バージョン管理
カレンダーベースのバージョン管理 (2023.10、 2024.10、 2025.10) はなくなりました。1.0.0 は、 semver コントラクトの開始点です。
- MAJOR — 最初に完全な非推奨化サイクルを伴う重大な変更。
- MINOR — 新しいコマンド、新しいフラグ、加算のみ。
Data形は進化することができます。 - PATCH — バグ修正のみ。
ホストとツールのバージョンの調整: 各ツールは CLI のメジャーを追跡します。MINOR 行です。「バージョン管理と安定性」をご覧ください。
CI/CD 以上のもの
レガシCLIは、テストのパッケージ化、分析、デプロイ、実行を行うCI/CDツールでした。UiPath CLI 1.x は、構築、管理、運用、デプロイといったプラットフォーム全体に対応しており、開発者による対話的使用だけでなく、パイプラインによるプログラムによる使用も目的で使用できるように設計されています。これで次の操作が可能になります。
- プロジェクトを素早く作成し、検証します (
uip solution new、uip agent init、uip flow init、uip maestro init)。 - Orchestrator のリソース (フォルダー、プロセス、パッケージ、マシン、ユーザー、ロール、ライセンス、キュー、アセット、バケット、Webhook) を管理します。
- ジョブ (
uip or jobs start、uip or jobs get) を開始および監視します。必要に応じて--wait-for-completionを使用します。 - 評価 (
uip agent evalを含む、エージェントのライフサイクル全体を推進します。 - Flow および Maestro のインスタンスとインシデントを検証します。
- Data Fabric エンティティと Integration Service のコネクションを管理します。
どのコマンドも同じ構造化された JSON エンベロープを返すため、手動でできることはすべてスクリプト化できます。
既定では JSON です
既定では 、stdout では JSON が出力され、エンベロープは安定しています (Result、 Code、 Data、 Message、 Instructions)。人間は --output tableでテーブルビューを選択します。パイプラインと AI エージェントは、余分なフラグなしで、クリーンで構造化されたデータを取得します。詳しくは、「出力形式」をご覧ください。
人間に優しい対話型ログイン
uip login ブラウザーを開いて UiPath にサインインし、更新されたセッションを [ ~/.uipath/] 内に保持します。クライアント資格情報を開発者ワークステーションに埋め込む必要がなくなりました。CI パイプラインは引き続き外部アプリケーション クライアント資格情報 (現在は --client-id env.UIPATH_CLIENT_IDAPI 経由で渡されます) を使用し、コンテナーは不透明なアクセス トークンで環境変数認証を使用できます。「 認証」をご覧ください。
AI コーディング エージェント用に構築
uip skills システムでは、Claude Code、Cursor、GitHub Copilot、Gemini CLI、Codex、および OpenCode にuipの使用方法を教えます。スキルは UiPath によってパブリッシュされ、エージェントごとにインストールされます。エージェントをインストールすると、各コマンドを入力しなくても、完全なパック-パブリッシュ-デプロイのフローを推進できます。「 UiPath CLI をコーディング エージェントと使用する」をご覧ください。
シェル補完
uip completion は、bash、zsh、fish、PowerShell のタブ補完をインストールします。動的フラグ値補完 (例えば、 uip or packages upload --package-name <TAB>) は、 jq が PATH 上にある場合、zsh で使用できます。static サブコマンドとオプション名補完は、4 つのシェルすべてで機能します。
その他の有意義な変化
- 暗黙的な env-var auth の読み取りはありません。
UIPATH_CLIENT_IDとUIPATH_CLIENT_SECRETは自動的に読み取られなくなりました。変数を--client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRETに渡します (env.プレフィックスは、コマンド ラインで公開することなく、実行時に変数を検索します)。 - 終了コードは 5 つの値 (0 / 1 / 2 / 3 / 4 に、ユーザーのキャンセルの場合は 130 を加えた値) に厳しくなりました。契約はメジャーリリース内で安定しています—それらに対するスクリプト。「終了コード」を参照してください。
- 解析時にすべてのコマンドでJMESPathフィルタリング(
--output-filter)を行い、構文エラーで終了コード3ため、タイプミスでAPI呼び出しが無駄になりません。 - クロスプラットフォーム。ARM64 Windows、macOS、Linux がサポートされており、これは Node.js ランタイムを反映しています。
- テレメトリのオプトアウト変数の名前 を
UIPATH_EXTENSIONS_CLI_TELEMETRY_ENABLED=FalseからUIPATH_TELEMETRY_DISABLED=1に変更しました。どちらの世代もデフォルトでオプトアウトされています—古い名前に依存していたCIランナーを更新します。
どこから始めるか
- 新しいユーザーですか?クイックスタート
- 2025.10 から移行しますか?移行ガイド。
- CIの設定?最初のパイプライン では→ CI/CD レシピを選択します。
- AI エージェントを使用する場合コーディング エージェントで UiPath CLI を使用する。
変更の完全なリストと、それ以降に出荷される内容については、 リリース ノート をご覧ください。