@uipath/test-manager-tool 1.206.0-preview.301 → 1.207.0-preview.305

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,391 +1,57 @@
1
- # UiPath Test Manager Tool (`uip tm`)
2
-
3
- > **Full reference:** [UiPath CLI — Test Manager](https://docs.uipath.com/uipath-cli/standalone/latest/user-guide/uip-test-manager)
4
-
5
- Manage test cases, test sets, executions, and results in UiPath Test Manager from the command line.
6
-
7
- This package adds the `tm` command group to the [`uip` CLI](../cli). Every command is invoked as:
8
-
9
- ```
10
- uip tm <group> <command> [options]
11
- ```
12
-
13
- Run a group with `--help` to list its commands, and a command with `--help` to see its options and a live example:
14
-
15
- ```bash
16
- uip tm testcases --help # list commands in the testcases group
17
- uip tm testcases create --help # options for one command
18
- ```
19
-
20
- ---
21
-
22
- ## Getting started
23
-
24
- ```bash
25
- # 1. Authenticate the uip CLI (interactive)
26
- uip login
27
-
28
- # 2. Confirm you are logged in
29
- uip login status --output json
30
-
31
- # 3. Discover your projects
32
- uip tm project list --output json
33
- ```
34
-
35
- For CI / non-interactive runs, log in with client credentials (`uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET`) or pass a token through env-auth variables (`UIPATH_CLI_ENABLE_ENV_AUTH=true`, `UIPATH_CLI_AUTH_TOKEN`, plus org/tenant). See the [Authentication Guide](https://github.com/UiPath/cli/blob/main/docs/guides/authentication.md).
36
-
37
- ---
38
-
39
- ## Global flags
40
-
41
- These flags apply to every command.
42
-
43
- | Flag | Description |
44
- |------|-------------|
45
- | `--output <format>` | Output format: `table`, `json`, `yaml`, or `plain`. Use `json` for scripting. |
46
- | `--output-filter <expr>` | [JMESPath](https://jmespath.org/) expression applied to the `Data` field before printing. |
47
- | `--log-level <level>` | Log verbosity: `debug`, `info`, `warn`, `error`. |
48
- | `--log-file <path>` | Write logs to a file instead of stderr. |
49
-
50
- Success responses: `{ "Result": "Success", "Code": "...", "Data": ... }`. Errors: `{ "Result": "Failure", "Message": "...", "Instructions": ... }` + non-zero exit code.
51
-
52
- ---
53
-
54
- ## Command surface
55
-
56
- ### `project` — Test Manager projects
57
-
58
- | Command | Description |
59
- |---------|-------------|
60
- | `uip tm project list` | List Test Manager projects. `IsDefault` marks the tenant's default project, which comes first. |
61
- | `uip tm project get-default` | Get the tenant's default project, creating it on first use ("Default Project", `TMDP`, open to the tenant's Everyone group). |
62
- | `uip tm project create` | Create a new Test Manager project. |
63
- | `uip tm project update` | Update a project name or description. `--set-default` makes it the tenant's default. |
64
- | `uip tm project delete` | Delete a project by its key. |
65
- | `uip tm project set-default-folder` | Set the default Orchestrator folder for a project. |
66
- | `uip tm project clear-default-folder` | Clear the default Orchestrator folder from a project. |
67
- | `uip tm project owners list` | List the owners of one or more projects. |
68
- | `uip tm project settings get` | Show a project's settings (time zone, execution name format, and the read-only step cap / governance fields). |
69
- | `uip tm project settings update` | Set a project's time zone (`--time-zone`, an IANA name) or execution name format (`--execution-name-format`). |
70
-
71
- ### `requirements` — Requirements
72
-
73
- | Command | Description |
74
- |---------|-------------|
75
- | `uip tm requirements list` | List requirements in a project. |
76
- | `uip tm requirements create` | Create a new requirement. |
77
- | `uip tm requirements get` | Get a requirement by id or key. |
78
- | `uip tm requirements update` | Update a requirement name or description. |
79
- | `uip tm requirements delete` | Delete one or more requirements. |
80
- | `uip tm requirements export` | Export requirements to an .xlsx file. |
81
- | `uip tm requirements list-by-test-execution` | List requirements covered by a test execution. |
82
- | `uip tm requirements list-testcase-ids` | List the test case UUIDs assigned to a requirement. |
83
- | `uip tm requirements testcases` | Attach or detach test cases on a requirement. |
84
- | `uip tm requirements generate-testcases` | Ask the AI to propose test cases for a requirement. `--wait` prints them, numbered; `--create` also creates them and links them to the requirement. `--activity-id` reuses a job that already ran, and `--select` creates only some of its test cases. The job is not marked as used (that route rejects CLI tokens), so the web app can still offer the test cases the CLI creates. |
85
- | `uip tm requirements evaluate` | Ask the AI to review a requirement and suggest improvements. `--wait` prints the suggestions. `--activity-id <id> --more-suggestions` asks a finished evaluation for more, keeping its inputs. Changes nothing; apply a suggestion with `requirements update`. |
86
- | `uip tm requirements find-obsolete-testcases` | Ask the AI which test cases linked to a requirement look obsolete. `--wait` prints them, numbered, with a score and confidence. Changes nothing on its own; `--unlink` removes them from the requirement and `--delete --yes` deletes them, `--select` picks some. |
87
-
88
- The three AI commands need a user login (`uip login`). Test Manager runs each AI job for the user who started it, so a client-credentials (app) login is refused: the server answers it with an error.
89
-
90
- ### `testcases` — Test cases
91
-
92
- | Command | Description |
93
- |---------|-------------|
94
- | `uip tm testcases list` | List all test cases in a project. `--labels` narrows to test cases carrying at least one of the given labels (up to 100); add `--filter` to also narrow by name or key. `--automated --folder-path <path>` (or `--folder-key`) lists only the automated test cases whose package lives in that Orchestrator folder; test cases linked to a Playwright package are left out, because the server route is built for performance testing. The folder lookup needs the `OR.Folders.Read` scope. The label and folder forms need the `TM.TestCases` scope, not just `.Read`. |
95
- | `uip tm testcases get` | Get one test case by key (`--test-case-key`), or by the automation linked to it (`--automation-id`, a `PackageEntryPointId` or Studio automation id). `--automation-id` returns one linked test case; if several share the automation, use `list` and filter on `PackageEntryPointId`. |
96
- | `uip tm testcases create` | Create a new test case. |
97
- | `uip tm testcases update` | Update a test case name, description, or pre/post-condition. |
98
- | `uip tm testcases delete` | Delete a test case by its key. |
99
- | `uip tm testcases run` | Run a new execution for one or more test cases. |
100
- | `uip tm testcases add` | Add test cases to a test set by key or label. `--labels <l...> --dynamic` assigns test cases dynamically: every test case carrying one of the labels, now or later, is part of the set. |
101
- | `uip tm testcases remove` | Remove test cases from a test set by key, or `--dynamic [--labels <l...>]` to stop assigning them dynamically. |
102
- | `uip tm testcases link-automation` | Link an Orchestrator package automation to a test case. For Playwright packages, pass the displayed `specPath > testTitle` name as `--test-name`. When the name is too long to match (shown truncated with `…` in `list-automations`), also pass `--entry-point-id` to bind by id; `--test-name` stays required but is ignored. |
103
- | `uip tm testcases link-package` | Create and link a test case for every test in an Orchestrator package, in one call. |
104
- | `uip tm testcases unlink-automation` | Unlink the automation from a test case. |
105
- | `uip tm testcases list-automations` | List test entry points available in an Orchestrator folder. Each row includes `PackageEntryPointId`, the id to pass to `link-automation --entry-point-id`. |
106
- | `uip tm testcases list-result-history` | List result history for a specific test case. |
107
- | `uip tm testcases list-testsets` | List the test sets that assign a test case explicitly (`--test-case-key`), or that explicitly assign any test case carrying one of the given labels (`--labels`, up to 100). Test sets that pull a test case in through a dynamic label rule are not listed. `--limit`/`--offset` window the result. The label form needs the `TM.TestCases` and `TM.TestSets` scopes, not just `.Read`. |
108
- | `uip tm testcases list-requirements` | List the requirements assigned to a test case; rows have the same shape as `requirements list`. `--limit`/`--offset` window the result. |
109
- | `uip tm testcases list-studio-projects` | List the distinct Studio project names the project's automated test cases come from, sorted (`--filter` prefix match, `--limit`/`--offset`). |
110
- | `uip tm testcases list-packages` | List the distinct Orchestrator package names the project's automated test cases are linked to, sorted (`--filter` prefix match, `--limit`/`--offset`). |
111
- | `uip tm testcases group-by` | Count test cases per value of a custom label field (`--field`, `--sort-order asc\|desc`). Test Cloud only; an unknown field is reported as not found. |
112
- | `uip tm testcases clone` | Queue a copy of a test case under a new name (`--test-case-key`, `--new-name`) and return `Accepted`. Test Manager makes the copy in the background and reports no key, so find it with `list --filter <name>`. `--include labels documents requirements parameters governance` copies more than the defaults (same option shape as `testsets clone`). |
113
- | `uip tm testcases bulk-create` | Create many test cases from a JSON file (`--file`), 100 per request, each request one transaction. `--labels` for all, `--requirement-key` to assign all, `--skip-existing` to skip, per name, as many items as the project already has with that name. Unknown custom field names, label values outside a field's list and step `clipboardData` over 8000 characters are rejected before anything is sent. `KeysResolved: false` means every item was created but the keys could not be read back. |
114
- | `uip tm testcases export` | Export test cases (all, or `--test-case-ids`) to an .xlsx file. Test Manager builds it as a background job, so this returns the job id and the commands to check and fetch it; with `--wait --output-file` it polls the job and writes the file. |
115
- | `uip tm testcases steps add` | Add one or more steps to a test case. |
116
- | `uip tm testcases steps get` | Get a single test step by its id. |
117
- | `uip tm testcases steps list` | List the steps of a test case. |
118
- | `uip tm testcases steps move` | Move a step to a new position in the test case. |
119
- | `uip tm testcases steps update` | Update a step's description, expected result, or notes. |
120
- | `uip tm testcases steps delete` | Delete a step from a test case. |
121
- | `uip tm testcases parameters list` | List the parameters of a test case. |
122
- | `uip tm testcases parameters get` | Get one parameter of a test case, by name or by id. |
123
- | `uip tm testcases parameters add` | Add a parameter to a test case. |
124
- | `uip tm testcases parameters update` | Update a parameter. Fields you do not pass keep their current value. |
125
- | `uip tm testcases parameters delete` | Delete one or more parameters by id in one call (`--parameter-ids <uuid...>`). Needs `--yes`. |
126
-
127
- ### `testsets` — Test sets
128
-
129
- | Command | Description |
130
- |---------|-------------|
131
- | `uip tm testsets list` | List test sets in a project; `--labels` finds sets carrying any of the labels; `--limit`/`--offset` cut a row window out of the matches (folder filter applied first) and the envelope's `Pagination.HasMore` says whether another window exists. |
132
- | `uip tm testsets create` | Create a new test set. |
133
- | `uip tm testsets update` | Update a test set name or description. |
134
- | `uip tm testsets settings get` | Show a test set's settings: execution-order enforcement, stop on failure, coverage, remote control, video recording, Autopilot. |
135
- | `uip tm testsets settings set` | Switch `--enforce-execution-order` / `--no-enforce-execution-order`; the other settings have no write route in the API yet. |
136
- | `uip tm testsets delete` | Delete a test set by its key. |
137
- | `uip tm testsets run` | Run a test set and return the execution ID. Pass `--wait` to block until done. For a Playwright test set, `--playwright-project <name>` runs only that `playwright.config` project (e.g. `chromium`) and saves the selection on the test set. Only one project may be selected per automated execution. |
138
- | `uip tm testsets list-testcases` | List the test cases a run executes — static links plus dynamic-label matches — with `AssignmentType` `Static`, `Dynamic`, or `Both`. |
139
- | `uip tm testsets get-dynamic-assignment` | Show the labels that assign test cases to a test set dynamically, and how many test cases they match now. Set them with `testsets create --dynamic-labels` or `testcases add --labels --dynamic`; stop with `testcases remove --dynamic`. |
140
- | `uip tm testsets playwright-context` | Show a test set's Playwright context: whether it resolves to a single Playwright package and which projects are available/selected (probe before using `run --playwright-project`). |
141
- | `uip tm testsets get` | Show a test set with its Orchestrator folder, selected packages and execution target. |
142
- | `uip tm testsets clone` | Copy a test set under `--new-name` (assigned cases and their parameter overrides, custom fields, label filter; `--include labels documents` for more). Waits until the copy exists and holds the source's static test cases (`Result: Cloned`; labels and documents arrive right after), unless `--no-wait`. |
143
- | `uip tm testsets group-by` | Count the project's test sets per value of a custom label field (Test Cloud). |
144
- | `uip tm testsets assign-user` | Assign a person (`--assignee-email` or `--assignee-id`) to test cases in the set, picked by key, label or `--all`; `--unassign` clears. |
145
- | `uip tm testsets set-execution-order` | Set the order the set's test cases run in; list every assigned case. Make the set honour it with `settings set --enforce-execution-order`. |
146
- | `uip tm testsets set-folder` | Point the set at an Orchestrator folder by `--folder-path` or `--folder-key`. |
147
- | `uip tm testsets set-robot` | Set the robot account the set runs with: `--robot-name` (resolved in the set's folder) or `--robot-user-key` (resolved to its name). |
148
- | `uip tm testsets set-execution-target` | Set runtime type, robot and machine for the set; unmentioned fields keep their value, a machine change or a runtime type without a machine (serverless, attendedStudioWeb) drops the old machine, `--clear-machine` / `--clear-robot` remove them (Test Cloud). |
149
- | `uip tm testsets autoselect-packages` | Show the package versions Test Manager would pick for the set's automated cases (read-only). |
150
-
151
- ### `executions` — Test executions
152
-
153
- | Command | Description |
154
- |---------|-------------|
155
- | `uip tm executions finish` | Close a manual execution early, while some of its test case logs are unfinished. A run whose logs all finished has already closed itself. |
156
- | `uip tm executions delete` | Delete an execution and the test case logs and log snapshots it owns, running or not. Needs `--yes`. |
157
- | `uip tm executions set-reporting-date` | Book an execution against a given day so reports count it there. Only works once the run is closed, and rejects dates before 2019-01-01. |
158
- | `uip tm executions export` | Export the executions a filter matches to an .xlsx file; each row's Name cell links back to Test Manager. For one execution's own report, use `report export`. |
159
- | `uip tm executions cancel` | Ask Test Manager to stop a running automated execution and its Orchestrator jobs. Read `Status`, not `Result`: `Cancelling` means Test Manager recorded the stop; `Running` means it was forwarded to Orchestrator and reaches `Cancelled` once Orchestrator reports back; a terminal status means the run was already over. Manual runs are closed with `finish`. |
160
- | `uip tm executions list` | List top n executions for a project or test set. |
161
- | `uip tm executions list-filtered` | List executions for a project using the full filtered API. |
162
- | `uip tm executions run` | Run a test execution. |
163
- | `uip tm executions retry` | Retry only the failed test cases of a finished execution. |
164
- | `uip tm executions get-stats` | Get aggregated pass/fail/none stats for an execution. |
165
- | `uip tm executions testcaselogs list` | List test case logs produced by an execution. |
166
-
167
- ### `defects` — Defects
168
-
169
- A defect is raised from one failed test case result and synced to the project's defect tracker (Jira, Azure DevOps, …). Defects are addressed by UUID only.
170
-
171
- | Command | Description |
172
- |---|---|
173
- | `uip tm defects list` | List defects in a project (`--changed-since`, `--sort-by`, `--limit`/`--offset`). |
174
- | `uip tm defects get` | Get a defect by id. |
175
- | `uip tm defects create` | Raise a defect from a test case's result in an execution (`--test-case-id` or `--test-case-key`). |
176
- | `uip tm defects update` | Update status, priority, or the external tracker link. |
177
- | `uip tm defects delete` | Delete a defect (the tracker issue is kept). |
178
- | `uip tm defects get-external-issue` | Show the tracker issue a defect is synced to. |
179
- | `uip tm defects get-related` | Get what a defect links to: `--object-type TestCase`, `TestExecution`, `TestCaseLog`, or `Requirement` (a list). |
180
- | `uip tm defects attachments list` | List a defect's attachments. |
181
- | `uip tm defects attachments download` | Download one defect attachment (`--result-path` or `--output-file`; `--overwrite` to replace an existing file). |
182
-
183
- ### `testcaselog` — Test case logs
184
-
185
- | Command | Description |
186
- |---------|-------------|
187
- | `uip tm testcaselog start` | Start a test case execution within a test execution. |
188
- | `uip tm testcaselog finish` | Finish a test case execution and record all step results. |
189
- | `uip tm testcaselog list` | List test case logs across a project, filtered and paged. |
190
- | `uip tm testcaselog get` | Read one test case log, optionally with its assertions. |
191
- | `uip tm testcaselog latest` | Read the most recent finished log for each given test case. |
192
- | `uip tm testcaselog list-assertions` | List assertions for a test case log. |
193
- | `uip tm testcaselog cancel` | Ask Test Manager to cancel a running automated test case execution. |
194
- | `uip tm testcaselog render-assertions` | Render a test case log's assertions as markdown, ready to paste into a report or defect. |
195
- | `uip tm testcaselog get-robot-logs` | Get a test case log's robot logs: an expiring download link, or the file itself with `--output-file`. |
196
-
197
- ### `teststeplog` — Test step logs
198
-
199
- | Command | Description |
200
- |---------|-------------|
201
- | `uip tm teststeplog list` | List test step logs for a test case log. |
202
-
203
- ### `result` — Execution results
204
-
205
- | Command | Description |
206
- |---------|-------------|
207
- | `uip tm result download` | Download test execution results as JUnit XML. |
208
-
209
- ### `report` — Execution reports
210
-
211
- | Command | Description |
212
- |---------|-------------|
213
- | `uip tm report get` | Get a summary report for a completed test execution. |
214
- | `uip tm report export` | Export a report file: one execution's report with `--execution-id` (`--format excel\|pdf\|junit`, default excel), or a PDF of chosen test case results with `--test-case-log-ids` (two or more come back as one .zip, a PDF per result; needs a Test Cloud licence). Returns the job id and the commands to check and fetch it; with `--wait --output-file` it polls the job and writes the file. JUnit is a tenant feature; where it is off, `result download` builds JUnit XML on the CLI. |
215
-
216
- ### `export-jobs` — File export jobs
217
-
218
- Test Manager builds its Excel, PDF and JUnit exports in the background and stores the file as a
219
- hidden attachment on the project. An export command returns the job; when the job reads
220
- `Completed`, its `AttachmentId` is the file, which `attachment download --attachment-id <id>
221
- --object-type project` fetches. The product UI is told over a push channel the CLI does not have,
222
- so reading the job is the whole mechanism.
223
-
224
- | Command | Description |
225
- |---------|-------------|
226
- | `uip tm export-jobs get` | Get the status of a file export job. The job must belong to the project you name, or it reads as not found. `--object-type` only picks which permission is checked, not which job is read. |
227
-
228
- ### `perf-scenario` — Performance testing
229
-
230
- A scenario holds load groups (a test case, its package and folder, and a load profile). Running it creates an execution, and each load group of that execution gets its own id: `load-groups list --execution-id` reports it, and the per-execution reads take it as `--load-group-id`. `load-groups update` / `remove` take the scenario's load-group id instead. Needs the `TM.PerformanceScenarios` and `TM.PerformanceScenarioExecutions` scopes.
231
-
232
- | Command | Description |
233
- |---------|-------------|
234
- | `uip tm perf-scenario create` | Create a performance scenario in a project. |
235
- | `uip tm perf-scenario get` | Get a scenario (`--scenario-key`) and the load groups bound to it. |
236
- | `uip tm perf-scenario list` | List a project's scenarios (`--search`, `--limit`/`--offset`). |
237
- | `uip tm perf-scenario delete` | Delete a scenario and its load groups (`--yes`). Past executions are kept; a running one is not stopped. |
238
- | `uip tm perf-scenario execute` | Run a scenario: a dry run by default, or `--execution-type performanceTesting`; `--wait` polls until it ends. |
239
- | `uip tm perf-scenario stop` | Cancel a running execution. |
240
- | `uip tm perf-scenario list-dry-run-reports` | Check for a passing dry run, which a full run needs. |
241
- | `uip tm perf-scenario licenses get` | Virtual-user units left on the tenant's performance testing licence. |
242
- | `uip tm perf-scenario executions list` | List a scenario's executions (`--execution-type`, `--limit`/`--offset`). |
243
- | `uip tm perf-scenario load-groups add` | Bind a test case to a scenario as a new load group. |
244
- | `uip tm perf-scenario load-groups update` | Change a load group's profile; only the flags passed change. |
245
- | `uip tm perf-scenario load-groups remove` | Remove a load group from a scenario. |
246
- | `uip tm perf-scenario load-groups list` | List the load groups of one execution, with their result. |
247
- | `uip tm perf-scenario load-groups get` | Get one load group of an execution: result, test case and the profile it ran with. |
248
- | `uip tm perf-scenario jobs list` | List the Orchestrator jobs of a load group execution (`--limit`/`--offset`). |
249
- | `uip tm perf-scenario robot-logs list` | List the robot logs of a load group execution (`--level`, `--limit` up to 500, `--offset`). |
250
- | `uip tm perf-scenario results get` | Get an execution's full data bundle (time series, CPU/RAM, logs). |
251
- | `uip tm perf-scenario http-errors list` | List HTTP errors for a load group execution in a time window. |
252
- | `uip tm perf-scenario automation-errors list` | List automation-step failures for a load group execution in a time window. |
253
- | `uip tm perf-scenario transaction-metrics list` | Per-transaction response times and throughput for a load group (API tests). |
254
- | `uip tm perf-scenario report generate` | Render an authored report (PDF or HTML) and return its in-app link. |
255
- | `uip tm perf-scenario report compare` | Render an authored comparison across executions of one scenario. |
256
-
257
- ### `migration` — Project migration (.tmh packages)
258
-
259
- Moves a whole project between tenants or environments. A `.tmh` is a transfer format holding
260
- the project's content and a manifest, not a report for a person to read.
261
-
262
- | Command | Description |
263
- |---------|-------------|
264
- | `uip tm project export` | Export a project to a `.tmh` package. Returns the job id and the commands to check and fetch it; with `--wait` it polls the background job and writes the file. |
265
- | `uip tm project import` | Import a `.tmh` package into an existing project, or one created from the package with `--create-project`. Uploads in chunks and returns the job id; with `--wait` it polls until the import finishes. |
266
- | `uip tm migration get` | Get a migration job of the named project by id. |
267
- | `uip tm migration download` | Download the `.tmh` from an export job that already finished, without exporting again. |
268
- | `uip tm migration list` | List migration jobs across the tenant, newest first. |
269
- | `uip tm migration schemas list` | List the `.tmh` schema versions the service accepts, newest first. |
270
- | `uip tm migration schemas download` | Download one schema version as a zip; `--schema-version latest` takes the newest. |
271
-
272
- The service never pushes a migration-job event, so `export --wait` polls `migration/job/{id}` — the
273
- product UI has no other mechanism either. `--include` / `--exclude` take space-separated content
274
- names: `governance`, `project-config`, `prompts` and `automation` for export, the same less
275
- `prompts` for import. `-h` lists them with their defaults.
276
- `project-config` needs a Test Cloud tenant and returns HTTP 403 elsewhere, which is a licence gate
277
- rather than a permissions problem.
278
-
279
- Every command except `migration schemas` takes `--project-id` or `--project-key`. The schema
280
- routes are tenant-wide and need the `TM.Users` (or `TM.Users.Read`) scope instead of `TM.Projects`. Prefer `--project-id`: it is used
281
- as-is, while a key costs one extra lookup to resolve it first. `--project-id` wins if both are
282
- given.
283
-
284
- The package is streamed to `<output-file>.<id>.partial`, unique to each download, and renamed into place once complete and
285
- confirmed to be a zip, so an interrupted download never leaves a truncated `.tmh`. An existing
286
- file is refused unless `--overwrite` is given, and a directory always is. The final check and the
287
- rename run under a lock on the target, so two downloads to one path cannot replace each other.
288
- In a browser host the package is held in memory and written once, and anything over 256 MiB is
289
- refused with a pointer to the terminal CLI.
290
-
291
- The service filters job reads by tenant only and never checks the project in the route, so
292
- `migration get` and `migration download` first read the named project, which the service does gate
293
- on project read permission, then report a job from any other project as not found.
294
- `migration list` has no such check: it lists across the whole tenant, including projects you have
295
- no role on.
296
-
297
- An import reads the whole package into memory, so packages over 2 GiB are refused, and sends it
298
- in 4 MB chunks. A chunk is retried
299
- only when it provably never reached the service, because the service counts a repeated chunk
300
- and then fails the import as "Chunks missing". A failed import has no rollback: whatever it wrote
301
- stays in the target project, so check or delete it before importing again.
302
-
303
- ### `attachment` — Attachments
304
-
305
- | Command | Description |
306
- |---------|-------------|
307
- | `uip tm attachment list` | List attachments for Test Manager objects, one row per object with its attachments nested. |
308
- | `uip tm attachment get` | Get one attachment's metadata by id. |
309
- | `uip tm attachment upload` | Upload a file as an attachment to a Test Manager object. |
310
- | `uip tm attachment download` | Download attachments: every file of an execution's test cases, or one file by id. |
311
- | `uip tm attachment update` | Rename an attachment. |
312
- | `uip tm attachment delete` | Delete an attachment by id. |
313
-
314
- ### `customfield` — Custom fields
315
-
316
- | Command | Description |
317
- |---------|-------------|
318
- | `uip tm customfield list` | List custom field definitions in a project. |
319
- | `uip tm customfield create` | Create a new custom field definition. |
320
- | `uip tm customfield get` | Get a custom field definition. |
321
- | `uip tm customfield update` | Update a custom field definition. |
322
- | `uip tm customfield delete` | Delete one or more custom field definitions. |
323
- | `uip tm customfield label add` | Add label values to a custom field across multiple objects. |
324
- | `uip tm customfield label create` | Upsert label values for an object. |
325
- | `uip tm customfield label get` | Get a custom field label row by id. |
326
- | `uip tm customfield label list` | List custom field label rows for an object type. |
327
- | `uip tm customfield label remove` | Remove label values from a custom field across multiple objects. |
328
- | `uip tm customfield value create` | Create a custom field value row on an object. |
329
- | `uip tm customfield value get` | Get a custom field value row. |
330
- | `uip tm customfield value list` | List text custom field values for an object type. |
331
- | `uip tm customfield value update` | Update a custom field value row. |
332
- | `uip tm customfield value delete` | Delete a custom field value row. |
333
-
334
- ### `objectlabel` — Object labels (tags)
335
-
336
- | Command | Description |
337
- |---------|-------------|
338
- | `uip tm objectlabel list` | List distinct label names for one object type. |
339
- | `uip tm objectlabel add` | Add labels to one or more objects. `--label-type` accepts `userLabel` only. |
340
- | `uip tm objectlabel get` | Get the visible label rows (user, system, generated) for one object by `--object-id`, with label ids and label types. Internal labels are not returned. |
341
- | `uip tm objectlabel remove` | Remove user and generated labels from multiple objects. The server keeps system labels (matched names are listed in `SkippedSystemLabels`) and internal label names are never sent (`SkippedInternalLabels` lists `--labels`: requested internal names; `--remove-all-labels`: user or generated labels sharing a name with an internal one), and `Result` is `Skipped` when nothing was removable. Names match case-insensitively; removed names are listed in `RemovedLabels`. `--remove-all-labels` removes the user and generated labels (except any sharing a name with an internal label), unlike the UI's clear-all, which also deletes internal labels. Reads the objects' labels first, so it needs read access to them and removes nothing when they cannot be read. Makes at least two read requests per object (more when an object has over 100 label names), five objects at a time, before writing. At most 100 object ids per call. |
342
-
343
- ### `prompts` — Prompt library
344
-
345
- | Command | Description |
346
- |---------|-------------|
347
- | `uip tm prompts list` | List prompts in a project's prompt library, built-in samples included; filter by mode of use, name/description prefix, or creator. |
348
- | `uip tm prompts get` | Get one prompt by `--name` (exact match) or `--prompt-id`. |
349
- | `uip tm prompts create` | Add a prompt, with guidelines inline (`--guidelines`) or from a file (`--guidelines-file`). |
350
-
351
- ### `user` — User data
352
-
353
- | Command | Description |
354
- |---------|-------------|
355
- | `uip tm user get` | Get data for the currently authenticated user. |
356
-
357
- ### `run` — Run a package's tests from CI
358
-
359
- | Command | Description |
360
- |---------|-------------|
361
- | `uip tm run --type package` | Run every test in a package already uploaded to Orchestrator. `--package-version` takes an app version (`1.0`, runs its latest patch) or an exact version (refused if a newer patch of the same app version exists, since Test Manager always runs the latest). It waits for Test Manager to see the package, build a hidden test set, apply `--input-path` overrides, run it, re-run failed and cancelled tests (`--max-retries`), and write a JUnit or UiPath JSON report (`--format`, `--result-path`). Assertions are read only for tests that did not pass, unless `--include-passed-assertions` is set. One `--timeout` covers the whole command, retries included; waiting for Test Manager to index the package is also capped at 5 minutes. Exits 0 when every test passes, 1 when a test fails or the run is cancelled, 2 on a login or permission problem, 3 on a bad option or input, 4 on timeout. A timeout or other error after the tests started still writes the report, with unfinished tests marked skipped. A run fails rather than pass when Test Manager counts more tests than it has results for (`MissingResults`), and tests whose assertions could not be read are listed in `AssertionsNotRead`. The login token is refreshed during long runs. Each run leaves its hidden test set in the project; nothing deletes it yet, as with uipcli. Needs `--project-key` or `--project-id`. Made for CI, as the replacement for `uipcli test run`. |
362
-
363
- ### `wait` — Wait for execution
364
-
365
- | Command | Description |
366
- |---------|-------------|
367
- | `uip tm wait` | Wait for a test execution to reach a terminal state (pass `--execution-id` and `--project-key`). |
368
-
369
- ---
370
-
371
- ## Examples
1
+ # Test Manager Tool
2
+
3
+ `uip` tool for managing UiPath Test Manager projects, requirements, test cases, test sets, executions, and results.
4
+
5
+ Full reference: [UiPath CLI — Test Manager](https://docs.uipath.com/uipath-cli/standalone/latest/user-guide/uip-test-manager). Run `uip tm <group> --help` to list a group's commands and `uip tm <group> <command> --help` for options and examples.
6
+
7
+ ## Usage
8
+
9
+ ### Command Groups
10
+
11
+ | Group | Description |
12
+ |-------|-------------|
13
+ | `project` | List, get-default, create, update, delete, set/clear-default-folder, owners, settings, export, import |
14
+ | `project-permissions` | Get your permissions on a project |
15
+ | `requirements` | List, get, create, update, delete, export, attach test cases, generate-testcases, evaluate, find-obsolete-testcases |
16
+ | `testcases` | List, get, create, update, delete, clone, bulk-create, export, run, link/unlink automation, link-package, steps, parameters |
17
+ | `testsets` | List, get, create, update, delete, clone, run, list-testcases, set-folder/robot/execution-target/execution-order, settings, playwright-context |
18
+ | `schedules` | List, create, update, delete, enable, disable, next-runs |
19
+ | `executions` | List, list-filtered, run, retry, finish, cancel, delete, get-stats, export, set-reporting-date, testcaselogs |
20
+ | `testcaselog` | Start, finish, cancel, list, get, latest, assign, list/render-assertions, get-robot-logs, override |
21
+ | `teststeplog` | List |
22
+ | `defects` | List, get, create, update, delete, get-external-issue, get-related, attachments |
23
+ | `result` | Download results as JUnit XML |
24
+ | `report` | Get, export |
25
+ | `export-jobs` | Get the status of an async Excel/PDF/JUnit export |
26
+ | `attachment` | List, get, upload, download, update, delete |
27
+ | `customfield` | List, get, create, update, delete definitions; label and value rows |
28
+ | `objectlabel` | List, get, add, remove |
29
+ | `prompts` | List, get, create Autopilot prompts |
30
+ | `perf-scenario` | List, get, create, execute, stop, delete, load-groups, executions, results, metrics, errors, report |
31
+ | `migration` | List, get, download export jobs; list/download .tmh schemas |
32
+ | `user` | Get the current user |
33
+ | `run` | Pack, upload and run a local RPA test project (`--project-path`), or run an uploaded package; wait, write a report, and delete the transient test set (CI) |
34
+ | `wait` | Wait for an execution to finish |
35
+ | `pack` | Pack a Playwright test suite into a .nupkg |
36
+
37
+ `uip tm testsets run --wait` and `uip tm wait` exit 1 when a test failed or the execution was cancelled.
38
+
39
+ ### Examples
372
40
 
373
41
  ```bash
374
- # List projects as JSON
375
- uip tm project list --output json
376
-
377
- # Create a test case
378
- uip tm testcases create --project-key DEMO --name "Login smoke" --description "Logs in and out"
379
-
380
- # Run a test set and wait for it to finish
42
+ uip tm project list
43
+ uip tm testcases create --project-key DEMO --name "Login smoke"
381
44
  uip tm testsets run --test-set-key DEMO:10 --wait
45
+ uip tm run --type package --project-key DEMO --project-path ./MyTests/project.json --folder-path Shared --result-path ./results
46
+ uip tm run --type package --project-key DEMO --package-name MyTests --package-version 1.0 --result-path ./results
47
+ uip tm result download --execution-id <EXECUTION_ID> --project-key DEMO --result-path ./junit.xml
48
+ ```
382
49
 
383
- # CI: run every test in an uploaded package, retry failures, write JUnit
384
- uip tm run --type package --project-key DEMO --package-name MyTests --package-version 1.0.3 --folder-path Shared --max-retries 2 --result-path ./results
385
-
386
- # Download execution results as JUnit XML
387
- uip tm result download --execution-id a1b2c3d4-0000-0000-0000-000000000001 --project-key DEMO --result-path ./junit.xml
50
+ ### Common Options
388
51
 
389
- # Retry only the failed test cases of an execution
390
- uip tm executions retry --execution-id a1b2c3d4-0000-0000-0000-000000000001 --project-key DEMO
391
- ```
52
+ - `--output <format>` - Output format: table, json, yaml, plain, markdown (default: json)
53
+ - `--output-filter <expression>` - JMESPath expression applied to the `Data` field
54
+ - `--project-key <key>` / `--project-id <id>` - Target project for project-scoped commands
55
+ - `-t, --tenant <name>` - Tenant name
56
+ - `--limit <number>` - Number of items to return
57
+ - `--offset <number>` - Number of items to skip
@@ -8,14 +8,14 @@ import {
8
8
  toGetAttachmentByIdRequest2,
9
9
  toUpdateAttachmentRequest2,
10
10
  toDeleteAttachmentRequest2
11
- } from "./tool-vgc9gpy6.js";
11
+ } from "./tool-y8kmsg4w.js";
12
12
  import {
13
13
  UiPathTestManagementHubAttachmentAbstractionsEnumsAttachmentSource2,
14
14
  UiPathTestManagementHubCommonEnumsObjectType2,
15
15
  UiPathTestManagementHubAttachmentAbstractionsEnumsAttachmentType2,
16
16
  UiPathTestManagementHubAttachmentAbstractionsEnumsAttachmentUploadSource2
17
- } from "./tool-1nkyed5m.js";
18
- import"./tool-6mpkbszw.js";
17
+ } from "./tool-hm0kg56c.js";
18
+ import"./tool-f4ytsjzn.js";
19
19
  export {
20
20
  ATTACHMENT_OBJECT_TYPES2 as ATTACHMENT_OBJECT_TYPES,
21
21
  UiPathTestManagementHubAttachmentAbstractionsEnumsAttachmentSource2 as AttachmentSource,
@@ -66,8 +66,8 @@ import {
66
66
  LlmActivityApi2,
67
67
  TestSetHiddenRoutesApi2,
68
68
  TransientTestSetsApi2
69
- } from "./tool-1nkyed5m.js";
70
- import"./tool-6mpkbszw.js";
69
+ } from "./tool-hm0kg56c.js";
70
+ import"./tool-f4ytsjzn.js";
71
71
  export {
72
72
  AttachmentsApi2 as AttachmentsApi,
73
73
  Configuration2 as Configuration,
@@ -0,0 +1,6 @@
1
+ import {
2
+ require_lib
3
+ } from "./tool-b24ehgnz.js";
4
+ export default require_lib();
5
+
6
+ //# debugId=C961C788FCD5164664756E2164756E21
@@ -8,9 +8,9 @@ import {
8
8
  createApiClient2,
9
9
  resolveFolder2,
10
10
  quoteODataStringLiteral2
11
- } from "./tool-967s3mts.js";
12
- import"./tool-0650qfw3.js";
13
- import"./tool-6mpkbszw.js";
11
+ } from "./tool-246df0cd.js";
12
+ import"./tool-4xdq18pz.js";
13
+ import"./tool-f4ytsjzn.js";
14
14
  export {
15
15
  FolderDtoFeedTypeEnum2 as FolderDtoFeedTypeEnum,
16
16
  FoldersApi2 as FoldersApi,
package/dist/index.js CHANGED
@@ -1,16 +1,19 @@
1
1
  #!/usr/bin/env bun
2
2
  import {
3
3
  Command
4
- } from "./tool-0650qfw3.js";
5
- import"./tool-6mpkbszw.js";
6
- import"./tool-1nkyed5m.js";
7
- import"./tool-vgc9gpy6.js";
8
- import"./tool-fz859vt8.js";
4
+ } from "./tool-4xdq18pz.js";
5
+ import"./tool-f4ytsjzn.js";
6
+ import"./tool-hm0kg56c.js";
7
+ import"./tool-y8kmsg4w.js";
8
+ import"./tool-bvkzq6jr.js";
9
9
  import {
10
10
  metadata2,
11
11
  registerCommands2
12
- } from "./tool-bep6n7t3.js";
13
- import"./tool-967s3mts.js";
12
+ } from "./tool-fspr1btk.js";
13
+ import"./tool-b24ehgnz.js";
14
+ import"./tool-w2tgc8pr.js";
15
+ import"./tool-246df0cd.js";
16
+ import"./tool-begvxz7a.js";
14
17
 
15
18
  // src/index.ts
16
19
  var program = new Command;
@@ -18,4 +21,4 @@ program.name(metadata2.commandPrefix).description(metadata2.description).version
18
21
  await registerCommands2(program);
19
22
  program.parse(process.argv);
20
23
 
21
- //# debugId=30987F787396FAE764756E2164756E21
24
+ //# debugId=A290F75E6669C6A764756E2164756E21