UiPath Documentation
uipath-cli
latest
false
重要 :
このコンテンツは機械翻訳によって処理されています。 新しいコンテンツの翻訳は、およそ 1 ~ 2 週間で公開されます。

UiPath CLI ユーザー ガイド

移行: コマンド マップ

すべてのレガシ uipcli 動詞と、それに相当する uip 動詞。レガシ エントリは、2025.10 以前に文書化された公開uipcli サーフェスを反映しています。uip列は、公開されているリファレンスページと一致します。

このページの読み方行は、従来の動詞ファミリ (packagejobtestassetsolutionrun) でグループ化されます。各行には分類が含まれます。

  • 1:1 — 直接名前を変更する。新しいフラグセットは、機械的なポートが機能するほど近くにあります。
  • 2ステップ / Nステップ —1つのレガシー動詞が複数の uip 呼び出しにマップされます。
  • 削除 — 置換: ... —レガシー動詞には直接の後継者がいません。「replacement」列には、同じ結果に対する慣用的な新しいCLIフローが表示されます。

各動詞内のフラグ レベルの詳細については、「 フラグの名前の変更」を参照してください。すべての動詞に適用される基になる認証/出力の変更については、「 重大な変更」を参照してください。

パッケージ

レガシ コマンドuip 相当備考
uipcli package pack <project>uip rpa pack <project>1:1.新しい旗の表面はケバブケースを使用しています。 --outputType--output-type--autoVersion--auto-versionなど。 uip rpa コマンドは、Studio パッケージャーを呼び出します。NET でサポートされる — ランナーには、まだ利用可能な .NET ランタイムが必要です。詳しくは、「 uip rpa pack」をご覧ください。
uipcli package analyze <project>uip rpa analyze <project> --governance-file-path <policy>1:1. --governanceFilePath --governance-file-pathになります(ケバブケース)。ワークフロー アナライザーのルールは変更されません。rpa packと同様に、.NET バックエンドが適用されます。「uip rpa analyze」をご覧ください。
uipcli package deploy <path> <url> <tenant>uip or packages upload <path> Then uip or processes create --name <n> --package-key <k> --package-version <v> --folder-path <path>2ステップ。レガシ デプロイでは、1 回の呼び出しで .nupkgがアップロード され、 プロセスが作成されます。新しいCLIは、これらの懸念を分割します。「 uip or packages upload 」および「 uip or processes create」をご覧ください。
uipcli package restore <project>uip rpa restore <project> [outputPath]1:1.NuGet パッケージの依存関係を復元します。レガシと同じフラグを使用して、エアギャップおよびカスタムの NuGet 構成をサポートします。.NET バックエンドが適用されます。「uip rpa restore」をご覧ください。

パッケージパック

# Legacy
uipcli package pack "C:\proj\project.json" -o "C:\dist" \
    --outputType Process --autoVersion \
    --traceLevel Information

# uip
uip rpa pack ./proj --output-type Process --auto-version
# Legacy
uipcli package pack "C:\proj\project.json" -o "C:\dist" \
    --outputType Process --autoVersion \
    --traceLevel Information

# uip
uip rpa pack ./proj --output-type Process --auto-version

フラグの完全なリストについては、 uip rpa pack をご覧ください。このツールは、従来の CLI で使用されていたものと同じ Studio パッケージャーをラップするため、出力形式とプロジェクトのサポートは同じです。

パッケージ分析

# Legacy
uipcli package analyze "C:\proj\project.json" \
    --governanceFilePath "C:\policy.json" \
    --resultPath "C:\result.json" \
    --stopOnRuleViolation

# uip
uip rpa analyze ./proj \
    --governance-file-path ./policy.json \
    --result-path ./result.json \
    --stop-on-rule-violation
# Legacy
uipcli package analyze "C:\proj\project.json" \
    --governanceFilePath "C:\policy.json" \
    --resultPath "C:\result.json" \
    --stopOnRuleViolation

# uip
uip rpa analyze ./proj \
    --governance-file-path ./policy.json \
    --result-path ./result.json \
    --stop-on-rule-violation

パッケージのデプロイ

これは、すべてのパイプライン ポートをキャッチする行です。Legacy deploy は、アップロードと作成が 1 回限りで完了します。 uip では、パッケージを一度アップロードすれば複数のフォルダーにバインドできるよう、2 つの明確なステップに分割されています。

# Legacy — upload and create a process in one call
uipcli package deploy "C:\pkg\InvoiceProcessing.1.0.3.nupkg" \
    "https://cloud.uipath.com/" "TenantName" \
    -A "myOrg" -I "<app-id>" -S "<app-secret>" \
    --applicationScope "OR.Folders OR.Execution" \
    -o "Shared" \
    --processName "InvoiceProcessing" \
    --entryPointsPath "Main.xaml"

# uip — upload, then create the process
uip login \
  --client-id env.UIPATH_CLIENT_ID \
  --client-secret env.UIPATH_CLIENT_SECRET \
  --tenant TenantName

uip or packages upload ./InvoiceProcessing.1.0.3.nupkg
#    response includes "body": "InvoiceProcessing:1.0.3"

uip or processes create \
    --name InvoiceProcessing \
    --package-key InvoiceProcessing \
    --package-version 1.0.3 \
    --folder-path Shared \
    --entry-point Main.xaml
# Legacy — upload and create a process in one call
uipcli package deploy "C:\pkg\InvoiceProcessing.1.0.3.nupkg" \
    "https://cloud.uipath.com/" "TenantName" \
    -A "myOrg" -I "<app-id>" -S "<app-secret>" \
    --applicationScope "OR.Folders OR.Execution" \
    -o "Shared" \
    --processName "InvoiceProcessing" \
    --entryPointsPath "Main.xaml"

# uip — upload, then create the process
uip login \
  --client-id env.UIPATH_CLIENT_ID \
  --client-secret env.UIPATH_CLIENT_SECRET \
  --tenant TenantName

uip or packages upload ./InvoiceProcessing.1.0.3.nupkg
#    response includes "body": "InvoiceProcessing:1.0.3"

uip or processes create \
    --name InvoiceProcessing \
    --package-key InvoiceProcessing \
    --package-version 1.0.3 \
    --folder-path Shared \
    --entry-point Main.xaml

注:

  • レガシの位置指定 <orchestrator_url><orchestrator_tenant> は、 uip login のセッション コンテキストに置き換えられます (および、各呼び出しでのオプションの -t, --tenant オーバーライド)。uipでは位置引数として現れることはありません。
  • レガシ --processName は、作成されるプロセスのカスタム表示名です。uipでは、同等のものはprocesses create--nameであり、--process(存在しない)ではありません。
  • レガシ --processNames <csv> (25.10 の複数プロセス一括作成) には、 直接に相当するものはありません。行に対するループのスクリプトを作成するか、推奨される複数プロセス フローの 「ソリューション 」をご覧ください。
  • レガシ --entryPointsPath (CSV) は uip or processes create--entry-point (単一パス) になります。マルチエントリ ポイント パッケージの場合は、エントリ ポイントごとに 1 回processes createを実行します。

パッケージの復元

# Legacy
uipcli package restore "C:\proj" \
    --restoreFolder "C:\deps" \
    --nugetConfigFilePath "C:\NuGet.Config"

# uip
uip rpa restore ./proj ./deps
# Legacy
uipcli package restore "C:\proj" \
    --restoreFolder "C:\deps" \
    --nugetConfigFilePath "C:\NuGet.Config"

# uip
uip rpa restore ./proj ./deps

ジョブ

レガシ コマンドuip 相当備考
uipcli job run <processName> <url> <tenant>uip or jobs start <process-key>意図的に1:1; ID は名前ではなく GUID です。レガシCLIは、位置引数としてプロセスのリリース名を取りました。新しいCLIは、 uip or processes listによって返されるプロセスキー(GUID)を受け取ります。レガシ -w true + -W <timeout> の動作には --wait-for-completion を使用します。「uip」または「jobs start」をご覧ください。
# Legacy
uipcli job run "InvoiceProcessing" \
    "https://cloud.uipath.com/" "TenantName" \
    -A "myOrg" -I "<app-id>" -S "<app-secret>" \
    --applicationScope "OR.Folders OR.Execution OR.Jobs" \
    -o "Shared" \
    -i "C:\input.json" \
    -w true -W 3600

# uip — resolve the name to a key, then start with wait-for-completion
PROCESS_KEY=$(uip or processes list --folder-path Shared \
    --name InvoiceProcessing \
    --output-filter "Data[0].Key" \
    --output plain)

uip or jobs start "$PROCESS_KEY" \
    --input-file ./input.json \
    --wait-for-completion \
    --timeout 3600
# Legacy
uipcli job run "InvoiceProcessing" \
    "https://cloud.uipath.com/" "TenantName" \
    -A "myOrg" -I "<app-id>" -S "<app-secret>" \
    --applicationScope "OR.Folders OR.Execution OR.Jobs" \
    -o "Shared" \
    -i "C:\input.json" \
    -w true -W 3600

# uip — resolve the name to a key, then start with wait-for-completion
PROCESS_KEY=$(uip or processes list --folder-path Shared \
    --name InvoiceProcessing \
    --output-filter "Data[0].Key" \
    --output plain)

uip or jobs start "$PROCESS_KEY" \
    --input-file ./input.json \
    --wait-for-completion \
    --timeout 3600

フラグレベルの詳細:

  • レガシ -i, --input_path <file>uip には、インライン JSON 用の --input-arguments '<json>' とファイル ペイロード用の --input-file <path> の 2 つの選択肢があります。これらは相互に排他的です。
  • レガシ の-j, --jobscount <n>--jobs-count <n>
  • レガシ の-P, --priority <Low|Normal|High>--job-priority <Low|Normal|High>
  • レガシ -r, --robots <csv> → に直接相当するものはありません (レガシにおけるクラシック フォルダーのみの概念)。ターゲット マシンには --machine-keys <csv> (GUID) があり、ユーザーは --user-keys <csv> (GUID) です。
  • レガシー-f, --fail_when_job_fails(デフォルトtrue)→待機中のジョブがFaulted終了した場合、新しいCLIは常に1終了します。オプトアウトはありません。
  • レガシ -R, --result_path <file> → 新しい CLI では、ジョブ エンベロープが stdout に出力されます。 > result.jsonでリダイレクトするか、 --output-filter を使用して特定のフィールドを抽出します。
  • レガシ の-b, --job_type <Unattended|NonProduction>--runtime-type <Unattended|Headless|Serverless|NonProduction|Development|TestAutomation>
レガシ コマンドuip 相当備考
uipcli test run <url> <tenant> -s <testset>uip tm testsets run --test-set-key <key> Then uip tm wait --execution-id <id> Then uip tm report get --execution-id <id>3つのステップ(起動→待機→検証)。新しいCLIは、「実行を開始する」と「ブロックする」と「判定を読み取る」を分離するため、CIスクリプトはそれぞれで明確に分岐できます。「uip tm testsets run」をご覧ください。新しい動詞は、executionsリソースではなくuip tm testsets runとしてtestsetsリソースに存在します(uip tm executions runはありません)。
uipcli test run <url> <tenant> -P <project.json> (プロジェクトをパッケージ化 + テストする)uip rpa pack Test Manager → uip tm testsets run でテスト セットを作成→ uip or packages uploadN ステップ。従来の 1 回限りの「このプロジェクトをパッケージ化してデプロイし、テストを実行する」というフローは、 rpaツール、 orツール、 tm ツールに分割されています。テスト セットの作成は、通常、Test Manager の Web UI で 1 回だけ設定する必要があります。
uipcli test parallel <url> <tenant> --testsConfigurationFilePath <file>直接同等のものはありません — uip tm testsets run 呼び出しをループします削除 — 置換: スクリプトは、独立したテストセットを uip tm testsets run で並行して起動し (それぞれが ExecutionIdを返します)、その後、実行ごとに 1 つの uip tm wait 。従来の parallel 動詞の test-project ドライバー ( uipcli test run 内部で呼び出される) には、対応するものがありません。新しいモデルでは、テスト セットが Test Manager で作成済みであることを前提としています。

テスト実行 (単一のテスト セット)

# Legacy
uipcli test run \
    "https://cloud.uipath.com/" "TenantName" \
    -A "myOrg" -I "<app-id>" -S "<app-secret>" \
    --applicationScope "OR.Folders OR.TestSets OR.TestSetExecutions" \
    -o "Shared" \
    -s "Smoke Suite" \
    --out junit \
    --result_path "C:\results.xml" \
    --timeout 1800

# uip — three verbs, clean exit-code branching
EXECUTION_ID=$(uip tm testsets run \
    --test-set-key DEMO:10 \
    --output-filter "Data.ExecutionId" \
    --output plain)

if ! uip tm wait --execution-id "$EXECUTION_ID" --project-key DEMO --timeout 1800; then
    case $? in
        2) echo "timeout" >&2; exit 2 ;;
        *) echo "wait failed" >&2; exit 1 ;;
    esac
fi

FAILED=$(uip tm report get --execution-id "$EXECUTION_ID" --project-key DEMO \
    --output-filter "Data.Failed" --output plain)

if [ "$FAILED" -gt 0 ]; then
    uip tm result download --execution-id "$EXECUTION_ID" --project-key DEMO \
        --destination ./results.xml
    exit 1
fi
# Legacy
uipcli test run \
    "https://cloud.uipath.com/" "TenantName" \
    -A "myOrg" -I "<app-id>" -S "<app-secret>" \
    --applicationScope "OR.Folders OR.TestSets OR.TestSetExecutions" \
    -o "Shared" \
    -s "Smoke Suite" \
    --out junit \
    --result_path "C:\results.xml" \
    --timeout 1800

# uip — three verbs, clean exit-code branching
EXECUTION_ID=$(uip tm testsets run \
    --test-set-key DEMO:10 \
    --output-filter "Data.ExecutionId" \
    --output plain)

if ! uip tm wait --execution-id "$EXECUTION_ID" --project-key DEMO --timeout 1800; then
    case $? in
        2) echo "timeout" >&2; exit 2 ;;
        *) echo "wait failed" >&2; exit 1 ;;
    esac
fi

FAILED=$(uip tm report get --execution-id "$EXECUTION_ID" --project-key DEMO \
    --output-filter "Data.Failed" --output plain)

if [ "$FAILED" -gt 0 ]; then
    uip tm result download --execution-id "$EXECUTION_ID" --project-key DEMO \
        --destination ./results.xml
    exit 1
fi

フラグレベルのメモ:

  • レガシ -s, --testset <name> には表示名があります。新しい --test-set-key <key> は Test Manager キー (形式 PROJECT:NN) を取得します。uip tm testsets list --project-key <key>で調べてください。
  • レガシー -t, --testsetkey <key> (新しいレガシーエイリアス)も存在し、これらの値は新しい --test-set-keyに直接移植されます。
  • レガシー --out junit|uipath が新しい uip tm result download --output-format junit になります(JUnitがデフォルトです。UiPath ネイティブの XML もサポートされています)。
  • レガシ --attachRobotLogs → 実行後に uip tm attachment download --execution-id <id> を使用して成果物をアタッチします。
  • レガシ --retryCount <n>uip tm executions retry --execution-id <id> 完了した実行の失敗したケースのみを再実行します。起動時に自動リトライ フラグはありません。上記の report get exit-branchでスクリプトを作成します。

並列テスト

従来のtest parallelを反映するuip動詞はありません。最も近いイディオムは、複数の uip tm testsets run 呼び出しを同時に起動し、各 ExecutionIdをキャプチャし、それぞれを待機するシェル ループです。

# Launch in parallel (bash)
EXEC1=$(uip tm testsets run --test-set-key DEMO:10 --output-filter Data.ExecutionId --output plain) &
EXEC2=$(uip tm testsets run --test-set-key DEMO:11 --output-filter Data.ExecutionId --output plain) &
wait

# Then wait on each
uip tm wait --execution-id "$EXEC1" --project-key DEMO --timeout 1800 &
uip tm wait --execution-id "$EXEC2" --project-key DEMO --timeout 1800 &
wait
# Launch in parallel (bash)
EXEC1=$(uip tm testsets run --test-set-key DEMO:10 --output-filter Data.ExecutionId --output plain) &
EXEC2=$(uip tm testsets run --test-set-key DEMO:11 --output-filter Data.ExecutionId --output plain) &
wait

# Then wait on each
uip tm wait --execution-id "$EXEC1" --project-key DEMO --timeout 1800 &
uip tm wait --execution-id "$EXEC2" --project-key DEMO --timeout 1800 &
wait

レガシ --testsConfigurationFilePath スキーマ (プロジェクトごとのパスとそのテスト セットを一覧表示) には、 uip スキーマに対応するものがありません。CIマトリックスまたはテストセットキーの単純なシェルリストからループを駆動します。

アセット

レガシ コマンドuip 相当備考
uipcli asset deploy <csv> <url> <tenant>行ごとに uip resource assets create <name> <value> のループオーバー削除 — 置換: シェルループでCSVを反復処理し、行ごとに create を呼び出します。新しいCLIでは、ワンショットのCSVデプロイは提供されません。「 UIP リソースアセット」をご覧ください。
uipcli asset delete <csv> <url> <tenant>行ごとに uip resource assets delete <key> のループオーバー削除 — 置換: キーによる反復と削除。delete は名前ではなくアセットの GUID を取ります — 名前を最初に uip resource assets list --folder-path <path>でキーに解決します。
# Legacy — bulk CSV
uipcli asset deploy "C:\assets.csv" "https://cloud.uipath.com/" "TenantName" \
    -A "myOrg" -I "<app-id>" -S "<app-secret>" \
    --applicationScope "OR.Assets" -o "Shared"

# uip — script the loop
# CSV columns: name,type,value,description
while IFS=, read -r NAME TYPE VALUE DESCRIPTION; do
    [ "$NAME" = "name" ] && continue    # skip header
    uip resource assets create "$NAME" "$VALUE" \
        --folder-path Shared \
        --type "$TYPE" \
        --description "$DESCRIPTION"
done < assets.csv
# Legacy — bulk CSV
uipcli asset deploy "C:\assets.csv" "https://cloud.uipath.com/" "TenantName" \
    -A "myOrg" -I "<app-id>" -S "<app-secret>" \
    --applicationScope "OR.Assets" -o "Shared"

# uip — script the loop
# CSV columns: name,type,value,description
while IFS=, read -r NAME TYPE VALUE DESCRIPTION; do
    [ "$NAME" = "name" ] && continue    # skip header
    uip resource assets create "$NAME" "$VALUE" \
        --folder-path Shared \
        --type "$TYPE" \
        --description "$DESCRIPTION"
done < assets.csv
注:

レガシの資格情報の種類のアセットでは、 username::password 値形式を使用します。uip resource assets createでは、資格情報の値の形式は username:password (単一コロン) で、シークレットには --credential-store-key <guid>が必要です。uip resource assets — createを参照してください。

ソリューション

レガシ コマンドuip 相当備考
uipcli solution pack <path>uip solution pack <solutionPath> <outputPath>意図に応じて 1 対 1 です。出力は両方の世代で .zip です (内部 .nupkg ファイルを含む)。引数の形状が -o から定位置出力ディレクトリに変更されました。
uipcli solution analyze <path>uip rpa analyze <project> プロジェクトごとN ステップ。ソリューション内の各プロジェクトでアナライザーを実行する uip solution analyze 動詞は1つではありません。
uipcli solution restore <path>uip rpa restore <project> プロジェクトごとN ステップ。solution analyzeと同じパターンです。
uipcli solution upload-package <zip>uip solution publish <zip>1:1.新しい名前は publishです。動作 (テナントのソリューション フィードにアップロード) は変更されません。
uipcli solution download-package <name> <version>直接に相当するものはありません削除 — 置換: 基になる .nupkg パッケージを uip or packages download <key>でダウンロードするか、パブリッシュ済みのソリューション レコードを Orchestrator REST API 経由で取得します。
uipcli solution delete-package <name> <version>uip solution packages delete <packageName> <packageVersion>1:1.
uipcli solution download-config <name>uip solution deploy config get <package-name> [--package-version <v>] [-d <path>]1:1.
uipcli solution deploy <...>uip solution deploy run --name <n> --package-name <n> --package-version <v> --folder-name <n> [--folder-path <path>]意図的に1:1;フラグ名が変更されました。--name はパッケージ名ではなく デプロイ 名です。first-pipeline.md — ステップ3を参照してください。
uipcli solution deploy-activate <...>uip solution deploy activate <deployment-name>1:1.
uipcli solution deploy-uninstall <...>uip solution deploy uninstall <deployment-name>1:1.
# Legacy — pack + upload + deploy, one verb each
uipcli solution pack "C:\my-solution" \
    -o "C:\dist" \
    -v 1.2.0
uipcli solution upload-package "C:\dist\my-solution.1.2.0.zip" \
    "https://cloud.uipath.com/" "TenantName" \
    -A "myOrg" -I "<app-id>" -S "<app-secret>" \
    --applicationScope "OR.Folders"
uipcli solution deploy "..." "..."

# uip — publish replaces upload-package; positional --version in pack
uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant TenantName
uip solution pack ./my-solution ./dist --version 1.2.0
uip solution publish ./dist/my-solution.1.2.0.zip
uip solution deploy run \
    --name "my-solution-deployment" \
    --package-name my-solution \
    --package-version 1.2.0 \
    --folder-name MySolution \
    --folder-path Shared
# Legacy — pack + upload + deploy, one verb each
uipcli solution pack "C:\my-solution" \
    -o "C:\dist" \
    -v 1.2.0
uipcli solution upload-package "C:\dist\my-solution.1.2.0.zip" \
    "https://cloud.uipath.com/" "TenantName" \
    -A "myOrg" -I "<app-id>" -S "<app-secret>" \
    --applicationScope "OR.Folders"
uipcli solution deploy "..." "..."

# uip — publish replaces upload-package; positional --version in pack
uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant TenantName
uip solution pack ./my-solution ./dist --version 1.2.0
uip solution publish ./dist/my-solution.1.2.0.zip
uip solution deploy run \
    --name "my-solution-deployment" \
    --package-name my-solution \
    --package-version 1.2.0 \
    --folder-name MySolution \
    --folder-path Shared

各ステップの説明を含むチュートリアルについては、「 最初のパイプライン 」を参照してください。

実行

レガシ コマンドuip 相当備考
uipcli run <arguments.json>直接に相当するものはありません削除 — 置換: パイプライン ステップを、フラグを使用して uip を直接呼び出すシェル スクリプトとして書き換えます。従来の run 動詞は、完全な uipcli <verb> <args> 呼び出し (非表示の --captureCommandToJsonFile フラグによって生成される) をシリアル化する JSON ファイルを使用していました。 uip に相当するものは出荷されません。
注:

1.x CLI では、一括引数リプレイ用のユニバーサル --from-file フラグは公開されていません。パイプラインがこのパターン (従来の captureCommandToJsonFile + uipcli run ワークフローで一般的) に依存している場合は、JSON ペイロードを uip の直接呼び出しに変換します。

同等のレガシがないコマンド

これらの uip 動詞には、従来のCLIに対応する動詞はありません。 uipcli だけでは不可能だったワークフローを開きます。どれも移行の必要はなく、新機能です。

  • uip loginuip login tenant list/setuip logoutuip login status — 完全なセッション管理。
  • uip or folders *uip or machines *uip or users *uip or roles *uip or licenses *uip or sessions *uip or audit-logs *uip or calendars *、 の uip or credential-stores *uip or feeds *uip or settings * — Orchestrator の完全な管理画面
  • uip or jobs list / get / stop / restart / resume / logs / traces / healing-data / historyuip or processes list / get / edit / update-version / rollbackuip or packages list / get / versions / entry-points / download — レガシーが公開しなかった内省動詞。
  • uip resource buckets / bucket-files / libraries / queues / queue-items / triggers / webhooks — Orchestrator リソース CRUD。
  • uip agent *uip codedagent *uip codedapp *uip flow *uip maestro *uip api-workflow *uip df *uip insights *uip traces *uip docsai *uip vss * — まったく新しい表面。
  • uip tools *uip skills *uip mcpuip completion — ホストレベルの管理。

参照

  • フラグの名前変更uipcliuipの間で名前が変更されたすべてのフラグをマッピングルールで変更します。
  • 破壊的変更 — 名前変更の背後にある意味的変更(認証、stdout形式、終了コード)。
  • パイプラインの例 — Azure DevOps と Jenkins のパイプラインの前/後
  • 参照インデックス — すべての uip ツールと動詞を 1 か所にまとめました。

このページは役に立ちましたか?

接続

ヘルプ リソース サポート

学習する UiPath アカデミー

質問する UiPath フォーラム

最新情報を取得