- 概要
- はじめに
- 概念
- 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 ユーザー ガイド
このページでは、個々の uipcli フラグを、対応する uip フラグにマッピングします。コマンドマップと一緒に使用してください — コマンドマップは呼び出す動詞を示します。このページでは、その動詞の各フラグをどうするかを示します。
フラグはドメイン別にグループ化されます。Auth は、コマンドごとに一度に変更されるため、最初です。このページの残りの部分では、動詞ごとに異なるフラグ (パッケージ/ソリューションの出力、ジョブの実行、テスト ランナーの出力、トレースなど) について説明します。
レガシ フラグ エントリは、2025.10 以前に文書化されたパブリック uipcli フラグ サーフェスを反映します。uip列は、現在のリファレンスページと一致します。
「住んでいる場所」コラムの読み方
uip 、フラグであった値を 3 つ配置する場所 uipcli:
- 各コマンドのフラグ — 毎回文字通り渡します(
--tenant <name>、--folder-path Shared)。 uip loginからのセッション状態 — フラグはuip loginで一度設定したものになりました。後続のコマンドは、自動的に取得します。呼び出しごとに適切なフラグでオーバーライドします。- 環境変数 — 実行時にCLIによって読み取られます。該当する場合は、
uip loginでは--client-id env.VARNAME/--client-secret env.VARNAMEプレフィックス形式を優先して、シークレットがコマンド ラインに入らないようにします。
「住んでいる場所」欄には、どれが当てはまるかがわかります。
認証
これは最も変更されるブロックです。レガシ CLI では、コマンドごとに 3 つの資格情報モード (ユーザー/パス、更新トークン、外部アプリ) を使用できます。新しいCLIは、外部アプリの認証情報とインタラクティブなOAuth — user/passおよびrefresh-token認証のみを受け入れます。Breaking changes — auth modes removed を参照してください。
外部アプリケーション (CI フロー)
| レガシ フラグ | レガシの目的 | uip フラグ | 生息場所 | 備考 |
|---|---|---|---|---|
-A, --accountForApp <name> | 外部アプリの組織名 | --organization <name> | フラグがオン uip login | 多くの場合、任意です。組織は外部アプリのレコードから推論されます。曖昧さを解消する必要があるときに渡してください。 |
-I, --applicationId <id> | 外部アプリ クライアント ID | --client-id <id> (または --client-id env.VARNAME) | フラグがオン uip login | 環境変数からの読み取りを優先 env.VARNAME 。 |
-S, --applicationSecret <secret> | 外部アプリのクライアント シークレット | --client-secret <secret> (または --client-secret env.VARNAME) | フラグがオン uip login | シークレットがシェル履歴とps出力に漏洩しないように、CI では常に env. プレフィックスを使用してください。 |
--applicationScope "<space-separated>" | OAuth のスコープ | --scope "<space-separated>" / -s, --scope | フラグがオン uip login | 同じスペース区切りの形式。レガシ呼び出しでは通常、すべての OR.* スコープが一覧表示されます。同じリストをキープしてください。 |
--identityUrl <url> | カスタム ID 認証局 (Automation Suite / PaaS) | --authority <url> | フラグがオン uip login | 変更;セマンティクスは同じです。Automation Cloud の場合は省略します。 |
(定位置指定) <orchestrator_url> | OrchestratorBaseURL | (セッションから暗黙的) | uip login時のフラグは不要 — CLI は、ログイン時に選択したテナント/組織の Orchestrator URL を解決します。 | |
(定位置指定) <orchestrator_tenant> | テナント名 | -t, --tenant <name> | uip loginのフラグ (既定) またはコマンドごとの-t | ログイン時に設定されると、以降のすべてのコマンドはこのテナントを使用します。コマンド -t は、その 1 回の呼び出しに対して上書きされます。 |
-o, --organizationUnit <folder> | コマンドの既定のフォルダーです | --folder-path <path> OR --folder-key <guid> | 必要なコマンドのフラグ | uipのセッションレベルの概念ではありません。これを各jobs/processes/resource *呼び出しに渡します。構成ファイルはデフォルトをピン留めできます。 |
ユーザー/パス認証 — 削除
| レガシ フラグ | ステータス uip |
|---|---|
-u, --username <user> | 削除。外部アプリケーションを作成して --client-idを使用します。 |
-p, --password <pass> | 削除。--client-secretを使用します。 |
レガシ CLI では、外部アプリがまだプロビジョニングされていない環境で Orchestrator に対するユーザー/パスワード認証がサポートされていました。uip はそうではありません。 Breaking changes — auth modes removed を参照してください。
更新トークン認証 — 削除
| レガシ フラグ | ステータス uip |
|---|---|
-t, --token <refresh-token> | 削除。レガシー -t は --tokenの短縮形でした。 uipでは、 -t は --tenantの短縮形です。 |
-a, --accountName <name> | 削除。代わりに、外部アプリケーションで --organization を使用します。 |
レガシ パイプラインで更新トークン認証が使用されていた場合は、外部アプリケーションに移行します。Automation Cloud では、新しいワークロードに対して更新トークン フローがプロビジョニングされなくなりました。
Token-in-hand (新規 — 同等のレガシはありません)
すでに UiPath アクセス トークンを保持していて資格情報を交換する必要がないコンテナーまたはランナーのために、 uip は 環境変数 auth: UIPATH_CLI_ENABLE_ENV_AUTH=true を設定し、環境変数を介してトークン + 組織 + テナントを渡します。「認証 - フロー 3」を参照してください。ファイルは書き込まれません。トークンは更新されません。
Env。VAR_NAMEプレフィックス
uip login は、 --client-id / --client-secretのリテラル シークレット、または実行時に環境変数から値を読み取る env.VAR_NAME プレフィックス形式を受け入れます。
# Resolves at runtime from $UIPATH_CLIENT_SECRET; the secret never appears on the command line.
uip login \
--client-id env.UIPATH_CLIENT_ID \
--client-secret env.UIPATH_CLIENT_SECRET \
--tenant "$UIPATH_TENANT"
# Resolves at runtime from $UIPATH_CLIENT_SECRET; the secret never appears on the command line.
uip login \
--client-id env.UIPATH_CLIENT_ID \
--client-secret env.UIPATH_CLIENT_SECRET \
--tenant "$UIPATH_TENANT"
uipcliとは異なり、uip は暗黙的に UIPATH_CLIENT_ID / UIPATH_CLIENT_SECRETを読みません。env.プレフィックスを使用して参照する必要があります (またはリテラル値を渡す必要があります)。Authentication — env.VAR_NAME prefix および Breaking changes — implicit env-var reading removed を参照してください。
出力、ログ、トレース
すべての uipcli 動詞に適用されます。
| レガシ フラグ | レガシの目的 | uip フラグ | 生息場所 | 備考 |
|---|---|---|---|---|
--traceLevel <None|Critical|Error|Warning|Information|Verbose> | ログの詳細度 | --log-level <debug|info|warn|error> | すべてのコマンドのグローバルフラグ | 値の範囲は4つのレベルに狭まりました。既定の infoです。Verbose → debug、 Information → info、 Warning → warn、 その他すべて → error。詳しくは、「グローバル オプション」をご覧ください。 |
| (レガシ テキスト、stdout、フラグなし) | 構造化された出力 | --output <json|table|yaml|plain> | グローバル フラグ | 既定では、すべてのコマンドで json です。レガシー印刷された人間が判読できるテキスト。 uip JSON を出力します。人間の視点には --output table を使用します。詳しくは、「出力形式」をご覧ください。 |
| (同等のものはありません) | フィルター処理後の出力 | --output-filter "<JMESPath>" | グローバル フラグ | uipの新機能パイプラインで、 jqを経由せずに特定のフィールドを抽出できるようにします。 |
| (同等のものはありません) | ログをファイルに複製する | --log-file <path> | グローバル フラグ | uipの新機能JSON 行を追加します。 |
-l, --language <locale> | ログの言語 | (同等のものはありません) | 削除。 | ログ出力は uip英語です。 |
--captureCommandToJsonFile <path> | 呼び出しを JSON にシリアル化します | (同等のものはありません) | 削除。 | uipcli runを駆動するために使用します。これも削除されます。「コマンド マップ — 実行」を参照してください。 |
パッケージ フラグ
レガシーパスカルケースフラグは、 uip rpaではケバブケースになります。下のすべての行について、同等の uip rpa pack フラグは、キャメルケースを単語に分割し、 - で結合したレガシー名です(例: --autoVersion → --auto-version)。uip rpa pack --helpを実行して、インストールされているツールのバージョンの完全なリストを表示します。
パッケージパック
| レガシ フラグ | uip rpa pack | 備考 |
|---|---|---|
<workspace_path> (定位置指定) | <project> (定位置指定) | project.jsonまたは包含ディレクトリへのパス。 |
-o, --output <dir> | -o, --output <dir> | 同じ形。生成された .nupkgの出力ディレクトリです。 |
-v, --version <semver> | -v, --version <semver> | パッケージのバージョンを設定します。 |
--autoVersion | --auto-version | 日付/タイムスタンプからバージョンを自動生成 |
--outputType <Process|Library|Tests|Objects> | --output-type <Process|Library|Tests|Objects> | 出力の種類を強制します。 |
--splitOutput | --split-output | ランタイムライブラリとデザインライブラリを分割します。 |
--releaseNotes <text> | --release-notes <text> | .nupkgメタデータに埋め込まれています。 |
--repositoryUrl、--repositoryCommit、--repositoryBranch、--repositoryType | --repository-url、--repository-commit、--repository-branch、--repository-type | VCS メタデータ。 |
--projectUrl <url> | --project-url <url> | Automation Hub のアイデアの URL |
--certificatePath--certificatePassword、--timestampServerUrl | --certificate-path--certificate-password、--timestamp-server-url | コード署名。 |
--author <name> | --author <name> | パッケージ作成者 |
--governanceFilePath <policy> | --governance-file-path <policy> | アナライザーをパッケージの一部として実行します。 |
ライブラリ認証 (--libraryOrchestratorUrl, --libraryOrchestratorTenant, -u/-p/-t/-a/-A/-I/-S, --libraryOrchestratorApplicationScope, --libraryOrchestratorFolder, --libraryIdentityUrl, --libraryOrchestratorAccountForApp, --libraryOrchestratorAccountName, --libraryOrchestratorApplicationId, --libraryOrchestratorApplicationSecret, --libraryOrchestratorUsername, --libraryOrchestratorPassword, --libraryOrchestratorAuthToken) | セッション開始 uip login | すべての library* 認証フラグは、 uip loginによって設定された単一のセッションに折りたたまれます。Pack は、プライベート フィードからライブラリの依存関係を解決する必要がある場合を除き、オフラインです。その場合、CLI はアクティブ セッションを使用します。 |
パッケージ分析
| レガシ フラグ | uip rpa analyze |
|---|---|
<workspace_path> (定位置指定) | <project> (定位置指定) |
--governanceFilePath <policy> | --governance-file-path <policy> |
--analyzerTraceLevel <Off|Error|Warning|Info|Verbose> | (まだ文書化されていません) |
--stopOnRuleViolation | (まだ文書化されていません。重大度のしきい値である可能性があります) |
--treatWarningsAsErrors | (まだ文書化されていません) |
--resultPath <path> | (まだ文書化されていません) |
--ignoredRules <id1,id2> | (まだ文書化されていません) |
パッケージのデプロイ
従来の deploy が 2 つの uip 呼び出しになりました。 「コマンド マップ — パッケージのデプロイ」を参照してください。フラグごと:
| レガシ フラグ | uip 相当 | 備考 |
|---|---|---|
<packages_path> (定位置指定) | <file> ( uip or packages upload上の位置指定) | 単一のファイル。.nupkgs のフォルダーの場合は、シェル内でループします。 |
<orchestrator_url> (定位置指定) | (セッション) | やめて下さい; uip loginが提供。 |
<orchestrator_tenant> (定位置指定) | -t, --tenant を uip login またはコマンド | 既定値は session です。 |
-c, --createProcess <true|false> | (暗黙的) | uip or packages upload プロセスを作成することはありません。プロセスが必要な場合は、アップロード後に uip or processes create を呼び出す |
--processName <name> | --name <name> 有効 uip or processes create | 変更; 注: --process <name> 新しいCLIには存在しません。 |
--processNames <csv> | (シェルのループ — 直接の等価物はありません) | CSV 反復処理をスクリプト化する行ごとに processes create を呼び出します。 |
--processDescription <text> | -d, --description <text> 有効 uip or processes create | |
--use-package-description | (既定の動作) | processes create 作成時に既定でパッケージの説明を継承します。 |
--ignoreLibraryDeployConflict | (同等のものはありません) | uip resource libraries upload 経由のライブラリのアップロードはバージョンが重複すると正常に失敗します。バージョンがすでに存在する場合はスキップするようにパイプライン ロジックを調整します。 |
-e, --environments <csv> | (同等のものはありません。モダン フォルダーのみ) | 従来のクラシック フォルダーの「環境」という概念は、モダン フォルダー モデルではサポートされていません。 |
-h, --entryPointsPath <csv> | --entry-point <path> 有効 uip or processes create | 呼び出しごとに単一のエントリ ポイント。ループ - マルチエントリ ポイント パッケージの場合。 |
パッケージの復元
| レガシ フラグ | uip rpa restore |
|---|---|
<workspace_path> (定位置指定) | <project> (定位置指定) |
--restoreFolder <dir> | [outputPath] (定位置指定) |
--nugetConfigFilePath <path> | (まだ文書化されていません) |
| ライブラリ認証フラグ | セッション開始 uip login |
ジョブ フラグ (uipcli job run → uip または jobs start)
| レガシ フラグ | uip or jobs start | 備考 |
|---|---|---|
<process_name> (定位置指定) | <process-key> (定位置指定) | 名前ではなく GUID。uip or processes list --name <name> --output-filter 'Data[0].Key' --output plainで解決します。 |
<orchestrator_url> (定位置指定) | (セッション) | — |
<orchestrator_tenant> (定位置指定) | -t, --tenant | 既定値は session です。 |
-i, --input_path <file> | --input-file <path> (file) または --input-arguments '<json>' (インライン) | 相互に排他的な2つの選択肢。 |
-P, --priority <Low|Normal|High> | --job-priority <Low|Normal|High> | — |
-j, --jobscount <n> | --jobs-count <n> | — |
-r, --robots <csv> | (直接に相当するものはありません) | classic-folder-only - レガシではモダン フォルダーには --machine-keys または --user-keys (GUID) を使用します。 |
-U, --user <user> | --user-keys <guid[,guid]> | 最初にユーザー名をユーザー GUID (uip or users list) に解決する必要があります。 |
-M, --machine <hostname> | --machine-keys <guid[,guid]> | 最初にホスト名をマシン GUID (uip or machines list) に解決する必要があります。 |
-R, --result_path <file> | (stdout をリダイレクトするか、 --output-filterを使用します) | uip ジョブ エンベロープを stdout に出力します。uip or jobs start <key> --wait-for-completion > result.json は完全なエンベロープを書き込みます。 |
-W, --timeout <seconds> | --timeout <seconds> | --wait-for-completion が必要です。 |
-f, --fail_when_job_fails <true|false> | (常時オン) | --wait-for-completionでは、ジョブがFaulted終了した場合に終了コードが1されます。オプトアウトなし。 |
-w, --wait <true|false> | --wait-for-completion (フラグ) | 新しいフォームは Boolean フラグ (値なし) です。 |
-b, --job_type <Unattended|NonProduction> | --runtime-type <Unattended|Headless|Serverless|NonProduction|Development|TestAutomation> | より広い列挙型。 |
-o, --organizationUnit <folder> | --folder-path <path> OR --folder-key <guid> | または省略 — プロセス キーからフォルダー uip 推論します。 |
テスト フラグ
uipcli テストの実行 → uip tm テストセットの実行 + uip tm 待機 + uip tm レポートの取得
| レガシ フラグ | uip target | 備考 |
|---|---|---|
-s, --testset <name> | --test-set-key <key> 有効 uip tm testsets run | 名前ではなくキー。形式 PROJECT:NN。uip tm testsets list --project-key <key>で解決します。 |
-t, --testsetkey <key> | --test-set-key <key> | 同じ値です。注:レガシー -t は新しいCLIの -t, --tenantと衝突します。長い形式を使用します。 |
-P, --project-path <project.json> | (再作業) | 従来の「その場でテストする」フローは分割され uip rpa pack → uip or packages upload →Test Manager のテスト セット→ uip tm testsets runが作成されます。テスト セットの作成は 1 回限りの設定です。 |
-a, --projectKey <key> | --project-key <key> uip tm wait時 / uip tm report get日 | 異なる projectKey: レガシ フラグにより Test Manager の projectKey が設定されます。この新しいフラグでは、待機/レポートのスコープが Test Manager プロジェクトに設定されます。基になる値は同じです。 |
-e, --environment <name> | (同等のものはありません) | クラシック フォルダーの概念。 |
-o, --organizationUnit <folder> | --folder-path <path> 有効 uip tm testsets list | テスト セットの検索に使用します。 executeではありません。 |
--out <junit|uipath> | --output-format <junit|uipath> 有効 uip tm result download | 実行後にダウンロードします。 |
-r, --result_path <file> | --destination <path> 有効 uip tm result download | 実行後にダウンロードします。 |
-w, --timeout <seconds> | --timeout <seconds> 有効 uip tm wait | 同じ意味、異なる動詞。 |
-i, --input_path <file> | --input-path <file> 有効 uip tm testsets run | まったく同じフラグ。JSON ファイルのスキーマは変更されません。 |
--attachRobotLogs | (実行後に uip tm attachment download を使用) | |
--retryCount <n> | uip tm executions retry --execution-id <id> | 失敗したケースを再実行します。起動時の自動リトライはありません。 |
--repositoryUrl、--repositoryCommit、--repositoryBranch、--repositoryType、--projectUrl、--releaseNotes、--disableBuiltInNugetFeeds、--nugetConfigFilePath、--author | ( uip tmにはない) | これらは、最初に荷造りをしなければならなかったとき test run パック側の入力でした。彼らは uip rpa packに属しています。 |
uipcli テスト並列
| レガシ フラグ | uip 相当 |
|---|---|
--testsConfigurationFilePath <file> | (同等のものなし) — シェルループを uip tm testsets run |
--projectsRootDirectoryPath <dir> | (同等のものはありません) |
--executionArtifactsDirectoryPath <dir> | --destination <path> uip tm result download および uip tm attachment downloadでは、実行ごとに実行 |
--cliDirectoryPath <uipcli.dll> | (同等のものはありません) |
--out <junit|uipath> | --output-format 有効 uip tm result download |
--disableBuiltInNugetFeeds | ( uip tmではなく、テスト プロジェクトをパッケージ化するときに uip rpa pack で使用) |
--projectKey <key> | --project-key <key> |
--author <name> | ( uip tmにはない) |
アセット フラグ
従来の動詞 (asset deploy と asset delete) の両方が CSV ファイルを消費していました。新しいCLIには一括デプロイはなく、CSV行をループし、行ごとに uip resource assets create / delete を呼び出します。「コマンド マップ — アセット」を参照してください。
| レガシ フラグ | uip 相当 | 備考 |
|---|---|---|
<assets_file> (定位置指定) | (シェルで CSV を解析) | — |
<orchestrator_url> (定位置指定) | (セッション) | — |
<orchestrator_tenant> (定位置指定) | -t, --tenant | — |
CSV 列 name | <name> (定位置指定) on uip resource assets create | — |
CSV 列 value | <value> (定位置指定) | — |
CSV 列 type | --type <Text|Bool|Integer|Credential|Secret> | 大文字 小文字。 |
CSV 列 description | -d, --description <text> | — |
ソリューション フラグ
動詞の構造は大部分が保存されています。フラグ名はケバブケースに正規化され、認証ブロックはセッションに折りたたまれました。
| レガシ フラグ (動詞間) | uip 相当 | 備考 |
|---|---|---|
-o, --output <dir> 有効 solution pack | (定位置 <outputPath>) | — |
-v, --version <semver> 有効 solution pack | --version <semver> | — |
-n, --name <name> 有効 solution pack | --name <name> | — |
認証ブロック (Orchestrator にアクセスするすべての solution 動詞) | セッション開始 uip login | — |
--packageName <n> 有効 solution deploy | --package-name <n> 有効 uip solution deploy run | — |
--packageVersion <v> 有効 solution deploy | --package-version <v> | — |
--folderName <n> 有効 solution deploy | --folder-name <n> | — |
solution deploy-activate / solution deploy-uninstall の位置指定<deploymentName> | <deployment-name> uip solution deploy activate時 / uip solution deploy uninstall日 | — |
テレメトリと非表示のフラグ
| レガシ フラグ | ステータス |
|---|---|
-y, --disableTelemetry (非表示) | env var UIPATH_TELEMETRY_DISABLED=1に置き換わりました。「 新機能 — テレメトリ」をご覧ください。 |
--origin (非表示) | 削除。 |
--captureCommandToJsonFile (非表示) | uipcli runとともに削除されます。 |
参照
- コマンドマップ — before/after スニペットを使用した動詞ごとのマッピング。
- 重大な変更 — auth、env vars、終了コード、stdout 形式。
- 認証 — サポートされている 3 つの認証フローです。
- 構成 — 環境変数とフラグの優先順位。
- グローバルオプション —
--output、--output-filter、--log-level、--log-file。
- 「住んでいる場所」コラムの読み方
- 認証
- 外部アプリケーション (CI フロー)
- ユーザー/パス認証 — 削除
- 更新トークン認証 — 削除
- Token-in-hand (新規 — 同等のレガシはありません)
- Env。VAR_NAMEプレフィックス
- 出力、ログ、トレース
- パッケージ フラグ
- パッケージパック
- パッケージ分析
- パッケージのデプロイ
- パッケージの復元
- ジョブ フラグ (uipcli job run → uip または jobs start)
- テスト フラグ
- uipcli テストの実行 → uip tm テストセットの実行 + uip tm 待機 + uip tm レポートの取得
- uipcli テスト並列
- アセット フラグ
- ソリューション フラグ
- テレメトリと非表示のフラグ
- 参照