UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip tm pack

Syntax and options for `uip tm pack`, which packages an external Playwright test project into a UiPath automation package for Test Manager.

uip tm pack builds a UiPath automation package (.nupkg) from an external test project so Test Manager can execute it. Given a Playwright project's root, it discovers the project's test() blocks (including describe() groups and annotations), then bundles the project's source files and test metadata into a package ready to publish to the Orchestrator Package Feed. Every automation that testsets run later executes for a Playwright test case is produced by this command.

Synopsis​

uip tm pack --project-path <path> --type playwright [--project-key <key>] [--name <name>] [--package-version <version>] [--output-dir <dir>] [--author <author>] [--description <desc>] [--no-create-test-cases] [--dry-run]
uip tm pack --project-path <path> --type playwright [--project-key <key>] [--name <name>] [--package-version <version>] [--output-dir <dir>] [--author <author>] [--description <desc>] [--no-create-test-cases] [--dry-run]

--project-key is required unless --no-create-test-cases is passed.

All verbs honor the global options and the standard exit codes.

Note:

pack runs offline and makes no service calls.

uip tm pack​

Package a Playwright test suite into a .nupkg for Test Manager.

Arguments​

None.

Options​

FlagDescription
--project-path <path>Required. Path to the Playwright project root (for example, . for the current directory). The root must contain package.json, a supported lockfile, and a playwright.config file (.ts, .js, .mts, .cts, .mjs, or .cjs). The config defines the Playwright projects that testsets run --playwright-project selects from.
--type <type>Required. Test framework being packaged. Only playwright is accepted. For a UiPath Studio test automation project, use uip rpa-legacy pack.
--project-key <key>An existing Test Manager project key (for example, DEMO). Required unless --no-create-test-cases is passed. When test-case auto-creation is on (the default), matching test cases are auto-created in this project when the package is uploaded, and the Playwright automation is auto-linked to each one — no manual link-automation or Select Automation step needed. Uppercase letters and digits only (^[A-Z0-9]+$), at most 255 characters. Packing is offline, so pack checks only the key format; whether the project exists is confirmed when the package is ingested.
-n, --name <name>Name of the resulting package. Defaults to the project folder name. Letters, numbers, dots, underscores, and hyphens only.
--package-version <version>Version string for the package (for example, 1.0.0). Defaults to 1.0.0. Must be major.minor.patch, with an optional fourth number, -prerelease, and +metadata (for example, 1.0.0 or 2.1.0-beta.1).
-o, --output-dir <dir>Output directory for the generated .nupkg. Defaults to .uipath. If the directory is inside the project, its contents are left out of the package. --output <dir> is a deprecated alias that still works but can't be combined with --output-dir; prefer --output-dir, because --output json and the other format values set the global output format instead.
--author <author>Defaults to "UiPath Developer".
--description <desc>Defaults to <name> — Playwright test package.
--no-create-test-casesDisables test-case auto-creation. The only mode in which --project-key may be omitted; the package's automations then become available for manual selection instead. Per-test label metadata is still embedded in the package, so labels can be applied later when test cases are created.
--dry-runRuns the same validation as a real pack, but writes nothing. A dry run that succeeds means the real pack succeeds. In the output, Output is empty.
Note:

The project root must contain one of the lockfiles in the following table; the robot installs the project's dependencies from it at run time. package.json must declare @playwright/test or playwright in dependencies or devDependencies.

Build toolLockfileInstall command the robot runs
npmpackage-lock.json or npm-shrinkwrap.jsonnpm ci
pnpmpnpm-lock.yamlpnpm install --frozen-lockfile
Yarnyarn.lockyarn install --frozen-lockfile
Bunbun.lock or bun.lockbbun install --frozen-lockfile

Examples​

uip tm pack \
  --project-path . \
  --type playwright \
  --project-key DEMO \
  --name CheckoutTests \
  --package-version 1.0.0 \
  --output-dir .packages
uip tm pack \
  --project-path . \
  --type playwright \
  --project-key DEMO \
  --name CheckoutTests \
  --package-version 1.0.0 \
  --output-dir .packages
# preview what would be packaged, without writing anything
uip tm pack --project-path . --type playwright --project-key DEMO --dry-run
# preview what would be packaged, without writing anything
uip tm pack --project-path . --type playwright --project-key DEMO --dry-run
# pack without auto-creating test cases
uip tm pack --project-path . --type playwright --no-create-test-cases
# pack without auto-creating test cases
uip tm pack --project-path . --type playwright --no-create-test-cases

Data shape​

{
  "Result": "Success",
  "Code": "ExternalTestPack",
  "Data": {
    "Package": "CheckoutTests@1.0.0",
    "Output": "/work/checkout-tests/.packages/CheckoutTests.1.0.0.nupkg",
    "TestCount": 12
  }
}
{
  "Result": "Success",
  "Code": "ExternalTestPack",
  "Data": {
    "Package": "CheckoutTests@1.0.0",
    "Output": "/work/checkout-tests/.packages/CheckoutTests.1.0.0.nupkg",
    "TestCount": 12
  }
}

Output is the absolute path of the written package. With --dry-run, the Code is the same.

Note:

After packaging, publish the .nupkg to your tenant's Orchestrator Package Feed — manually in Orchestrator, by dropping it into a watched folder, or with uip or packages upload — before it can be selected in Test Manager.

  • testcases — read the warning there before using link-automation on any test case created by this command.
  • testsets — testsets run executes the automations this command produces.
  • uip or packages — packages upload publishes the generated .nupkg to the Orchestrator Package Feed.
  • uip rpa-legacy pack — packs UiPath Studio test automation projects.

See also​

  • Synopsis​
  • uip tm pack​
  • Arguments​
  • Options​
  • Examples​
  • Data shape​
  • Related​
  • See also​

Was this page helpful?

Connect

Need help? Support(opens in new window)

Want to learn? UiPath Academy(opens in new window)

Have questions? UiPath Forum(opens in new window)

Stay updated