UiPath Documentation
uipath-cli
latest
false

UiPath CLI user guide

uip tm testsets

uip tm testsets manages test sets: the executable unit in Test Manager. A test set is an ordered group of test cases launched as a single command and tracked as a single execution. Every testsets run call returns an ExecutionId that the other uip tm verbs (wait, executions, report, result, attachment) take as input.

Synopsis​

uip tm testsets create --project-key <key> --name <name> [--description <text>]
uip tm testsets list --project-key <key> [--filter <text>]
uip tm testsets update --project-key <key> --test-set-key <key> [--name <name>] [--description <text>]
uip tm testsets delete --project-key <key> --test-set-key <key> [-y]
uip tm testsets list-testcases --project-key <key> --test-set-key <key> [--limit <n>] [--offset <n>]
uip tm testsets run --project-key <key> --test-set-key <key> --execution-type <type> [--async]
uip tm testsets create --project-key <key> --name <name> [--description <text>]
uip tm testsets list --project-key <key> [--filter <text>]
uip tm testsets update --project-key <key> --test-set-key <key> [--name <name>] [--description <text>]
uip tm testsets delete --project-key <key> --test-set-key <key> [-y]
uip tm testsets list-testcases --project-key <key> --test-set-key <key> [--limit <n>] [--offset <n>]
uip tm testsets run --project-key <key> --test-set-key <key> --execution-type <type> [--async]

All verbs honor the global options and the standard exit codes. Every verb accepts -t, --tenant <name> and --log-level <level> (default Information).

uip tm testsets create​

Create an empty test set in a project.

Arguments​

None.

Options​

  • --project-key <key> (required) — owning project.
  • --name <name> (required) — test set name.
  • --description <text> — free-form description. Defaults to empty.

Example​

uip tm testsets create \
  --project-key DEMO \
  --name "Smoke Suite" \
  --description "Core smoke tests"
uip tm testsets create \
  --project-key DEMO \
  --name "Smoke Suite" \
  --description "Core smoke tests"

Data shape​

{
  "Code": "TestSetCreate",
  "Data": {
    "TestSetKey": "DEMO:10",
    "Name": "Smoke Suite",
    "Description": "Core smoke tests"
  }
}
{
  "Code": "TestSetCreate",
  "Data": {
    "TestSetKey": "DEMO:10",
    "Name": "Smoke Suite",
    "Description": "Core smoke tests"
  }
}

uip tm testsets list​

List test sets in a project.

Arguments​

None.

Options​

  • --project-key <key> (required) — project to list.
  • --filter <text> — server-side search over name.

Example​

uip tm testsets list --project-key DEMO --filter smoke
uip tm testsets list --project-key DEMO --filter smoke

Data shape​

{
  "Code": "TestSetsList",
  "Data": [
    {
      "TestSetKey": "DEMO:10",
      "Name": "Smoke Suite",
      "Id": "a1b2c3d4-0000-0000-0000-000000000010"
    }
  ]
}
{
  "Code": "TestSetsList",
  "Data": [
    {
      "TestSetKey": "DEMO:10",
      "Name": "Smoke Suite",
      "Id": "a1b2c3d4-0000-0000-0000-000000000010"
    }
  ]
}

Id is the internal UUID — needed by executions list --test-set-id.

uip tm testsets update​

Rename a test set or change its description. At least one of --name or --description must be supplied.

Arguments​

None.

Options​

  • --project-key <key> (required) — owning project.
  • --test-set-key <key> (required) — test set key (for example, DEMO:10).
  • --name <name> — new name.
  • --description <text> — new description.

Example​

uip tm testsets update \
  --project-key DEMO \
  --test-set-key DEMO:10 \
  --name "Smoke Suite (2026)"
uip tm testsets update \
  --project-key DEMO \
  --test-set-key DEMO:10 \
  --name "Smoke Suite (2026)"

Data shape​

{
  "Code": "TestSetUpdate",
  "Data": {
    "TestSetKey": "DEMO:10",
    "Name": "Smoke Suite (2026)",
    "Description": "Core smoke tests",
    "Result": "Updated"
  }
}
{
  "Code": "TestSetUpdate",
  "Data": {
    "TestSetKey": "DEMO:10",
    "Name": "Smoke Suite (2026)",
    "Description": "Core smoke tests",
    "Result": "Updated"
  }
}

uip tm testsets delete​

Delete a test set by its key.

Arguments​

None.

Options​

  • --project-key <key> (required) — owning project.
  • --test-set-key <key> (required) — test set key (for example, DEMO:10).
  • -y, --yes — skip the confirmation prompt. Required in non-interactive environments.

Example​

uip tm testsets delete --project-key DEMO --test-set-key DEMO:10 --yes
uip tm testsets delete --project-key DEMO --test-set-key DEMO:10 --yes

Data shape​

{
  "Code": "TestSetDelete",
  "Data": {
    "TestSetKey": "DEMO:10",
    "Id": "a1b2c3d4-0000-0000-0000-000000000010",
    "Result": "Deleted"
  }
}
{
  "Code": "TestSetDelete",
  "Data": {
    "TestSetKey": "DEMO:10",
    "Id": "a1b2c3d4-0000-0000-0000-000000000010",
    "Result": "Deleted"
  }
}

uip tm testsets list-testcases​

List the test cases assigned to a test set.

Arguments​

None.

Options​

  • --project-key <key> (required) — owning project.
  • --test-set-key <key> (required) — test set to inspect.
  • --limit <n> — maximum number of results per page. Defaults to 50.
  • --offset <n> — number of results to skip. Defaults to 0.

Example​

uip tm testsets list-testcases --project-key DEMO --test-set-key DEMO:10
uip tm testsets list-testcases --project-key DEMO --test-set-key DEMO:10

Data shape​

{
  "Code": "TestSetTestCasesList",
  "Data": [
    {
      "TestCaseKey": "DEMO:1",
      "Name": "Login smoke",
      "Description": "Logs in and out"
    }
  ]
}
{
  "Code": "TestSetTestCasesList",
  "Data": [
    {
      "TestCaseKey": "DEMO:1",
      "Name": "Login smoke",
      "Description": "Logs in and out"
    }
  ]
}

uip tm testsets run​

Run a test set and return its ExecutionId. Run does not block; pair it with uip tm wait in scripts.

Arguments​

None.

Options​

  • --project-key <key> (required) — owning project.
  • --test-set-key <key> (required) — test set to run.
  • --execution-type <type> (required) — which test cases to run. One of:
    • automated — only automated test cases.
    • manual — only manual test cases.
    • mixed — both automated and manual.
    • none — no type filter.
  • --async — return immediately after queuing without waiting for acknowledgement.

Examples​

# automated run (most common in CI)
uip tm testsets run \
  --project-key DEMO \
  --test-set-key DEMO:10 \
  --execution-type automated

# fire-and-forget
uip tm testsets run \
  --project-key DEMO \
  --test-set-key DEMO:10 \
  --execution-type automated \
  --async
# automated run (most common in CI)
uip tm testsets run \
  --project-key DEMO \
  --test-set-key DEMO:10 \
  --execution-type automated

# fire-and-forget
uip tm testsets run \
  --project-key DEMO \
  --test-set-key DEMO:10 \
  --execution-type automated \
  --async

Data shape​

{
  "Code": "TestSetRun",
  "Data": {
    "ExecutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "TestSetKey": "DEMO:10",
    "Status": "Running",
    "StartTime": "2025-04-15T10:30:00Z"
  }
}
{
  "Code": "TestSetRun",
  "Data": {
    "ExecutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "TestSetKey": "DEMO:10",
    "Status": "Running",
    "StartTime": "2025-04-15T10:30:00Z"
  }
}
Note:

--execution-type is mandatory — the CLI errors if omitted. The returned Status reflects the state at launch; to get the run outcome, block on uip tm wait and then read uip tm report get.

  • testcases — create and link the test cases that populate a test set.
  • executions — list and retry executions once a test set has been run.
  • wait — block until a returned ExecutionId reaches a terminal state.
  • report, result, attachment — post-run artifacts.

See also​

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated