uip tm

Manage Test Manager projects, test cases, test sets, executions, schedules, defects, requirements, custom fields, labels, results, and attachments using the `uip tm` tool.

uip tm is the Test Manager tool: it manages test projects, test cases, test sets, executions, schedules, defects, requirements, results, reports, and attachments on a UiPath Test Manager tenant. Install it with uip tools install tm, or invoke uip tm … and let auto-install run. See Tools (plugins) for the install model and uip tools for the command that manages tool installation.

tm はコマンドプレフィックスであり、 uip test-managerではありません。uip tools list の [commandPrefix] 列を使用して確定します。

リソース

各リソースには、独自のリファレンス ページがあります。各ページに設定された動詞は、 uip tm によって登録されたコマンドと一致します— uip tm --help を実行して、インストールの完全な表面を確認します。

リソース	目的
プロジェクト	Create, list, update, delete Test Manager projects; get or set the tenant default project; set or clear the default Orchestrator folder; list owners; read and update project settings; export and import a project.
project-permissions	Read the permissions you hold on a Test Manager project.
移行	Inspect and download the migration jobs behind project export and project import, and list or download migration schemas.
件のテスト ケース	Create, bulk-create, clone, list, get, update, delete, and export test cases; manage manual test steps and parameters; link or unlink Orchestrator automations; assign test cases to test sets statically or dynamically by label; list result history, test sets, requirements, packages, and Studio projects for a test case.
パッケージ化	外部の Playwright テスト プロジェクトを .nupkg オートメーション パッケージにパッケージ化し、必要に応じてそのテスト ケースを自動作成してリンクします。
テスト セット	Create, clone, list, get, update, delete test sets; list contained test cases and dynamic assignments; set execution order, execution target, folder, and robot; read and update settings; assign a user; run a test set and return an execution ID.
実行	Run every test in a package already uploaded to Orchestrator, wait for the results, and write a report; exits non-zero when a test fails.
スケジュール	Create, list, update, enable, disable, and delete recurring test set schedules; list upcoming runs.
実行	List and filter executions; re-run an existing execution; retry the failed test cases of a finished execution; finish, cancel, delete, and export executions; set the reporting date; get aggregated stats.
テスト ケースのログ	Start, finish, list, get, cancel, and assign test case logs; override a result; read assertions and robot logs.
テスト ステップ ログ	手動テストまたは混合テスト ケースのステップレベルの実行ログを一覧表示します。
待機	テスト実行が終了ステートになるまでポーリングします。タイムアウト時に 0 以外の終了コードを返します。
結果	テスト実行の結果をJUnit XMLレポートとしてダウンロードします。
レポート	Get a summary report (counts, pass rate, duration, failed cases) for a completed execution; export an execution report file.
エクスポート - ジョブ	Check the asynchronous file export jobs that testcases export and report export start.
添付ファイル	Upload, list, get, update, delete, and download attachments (screenshots, logs, files) on Test Manager objects.
Defects	Create, list, get, update, and delete defects raised from failed test results; read related objects, the linked external issue, and defect attachments.
要件	Create, list, get, update, delete, and export requirements; manage test case links; generate test cases from a requirement, evaluate requirements, and find obsolete test cases with AI.
プロンプト	List, get, and create entries in the project prompt library that steers AI test generation and evaluation.
カスタム フィールド	カスタム フィールドの定義、その表示ラベル、許可される値を管理します。
オブジェクト ラベル	Add, remove, get, and list labels on Test Manager objects.
ユーザー	現在認証されている Test Manager ユーザーのプロファイル情報を取得します。
perf-scenario	Create, run, and delete performance scenarios (dry run or full load test); check performance testing licenses; see also load-groups, execution data, and report.

概要

uip tm <resource> <verb> [options]

既定の出力は --output jsonです。すべての uip tm 動詞は、4 つの グローバル オプション (--output、 --output-filter、 --log-level、 --log-file) に従います。

一般的なフロー

Test Manager のリソースはチェーンを形成します。完全な CI 実行では、通常、エンドツーエンドで実行されます。

1. プロジェクト — 1 回限りのセットアップ。プロジェクトを作成 (または既存のプロジェクトを再利用) し、必要に応じて既定の Orchestrator フォルダーをピン留めして、後のコマンドで --folder-keyを省略できるようにします。
2. テスト ケース — テスト ケースを作成し、各テスト ケースを testcases link-automationOrchestrator パッケージのエントリ ポイントにリンクします。これは、それらを実行可能にするステップです。
3. テストセット — テスト ケースを testsets createを使用して実行可能なスイートにグループ化します。
4. testsets run — 実行を開始します。すべてのダウンストリーム コマンドが入力として受け取る ExecutionId を返します。
5. wait — block the script until the execution reaches a terminal state (Finished or Cancelled). Use --timeout to cap the wait.
6. レポート/結果/添付ファイル — 実行後:構造化された要約(report get)、CIテストダッシュボード用のJUnit XMLファイル(result download)、およびキャプチャされたアーティファクト(attachment download)。
7. 実行のリトライ — 任意: 実行に不安定な失敗があった場合は、失敗したテスト ケースのログのみを所定の位置で再実行します。

For manual or mixed runs, the extended flow adds: testcaselog start / finish — mark individual test case logs as started and finished; and teststeplog list — retrieve step-level pass/fail detail. requirements links test cases to requirements for traceability reporting, defects tracks bugs raised from failed results, and objectlabel / customfield provide metadata management across all entity types.

For an existing Playwright test project, pack collapses steps 2 and 3 into one command: pointing it at the project root with --project-key packages the suite and auto-creates and auto-links matching test cases in a single call. A Playwright test case that pack created and linked must never be linked again with testcases link-automation — see pack.

For a package already uploaded to Orchestrator, run collapses steps 2 through 6 into one command: uip tm run --type package runs every test case in the package, waits, writes a report, and exits non-zero when a test fails — see run. To run a test set on a recurring cadence instead of from a pipeline, create a schedule — see schedules.

同じフローがターミナルでアドホックに動作し、各動詞が次のステップで必要とする ID を含む自己完結型の JSON エンベロープを出力します。

Run without a project

If you run tests without specifying a project, Test Manager stores the results in the default project of your tenant. For more information, refer to Default project for execution results.

認証とスコープ

Every uip tm verb resolves tenant and project context through the active session. Refer to Authentication for sign-in. Project-scoped verbs take --project-id or --project-key. When you pass both, --project-id is used. Verbs that take an object key such as --test-set-key DEMO:42 can also derive the project from the key's prefix.

終了コード

Standard CLI exit codes apply to every verb. Two verbs add domain-specific behavior:

• uip tm testsets runの後にuip tm waitが続く — 実行時の終了コードを参照してください。wait はタイムアウト時に 2 を終了するため、スクリプトは JSON を解析せずにタイムアウト、失敗での終了、クリーン パスで分岐できます。テストエラーの検出自体は、実行コマンドの終了コードではなく、 report get または result downloadを介して行われます。
• uip tm run — exits 1 when a test fails or reports no result, no test runs, or the run is cancelled, and 4 when --timeout elapses. See run.

参照

• 概念: UiPath CLI の構成
• セッション — テナントとプロジェクトのコンテキストがどのように解決されるか。
• スクリプティングパターン — CI の出口コードの分岐と JSON フィルタリング。
• 出力形式 — JSON エンベロープと --output-filter。