- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip coder
- uip context-grounding
- uip docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip maestro authoring
- uip maestro registry
- uip model-hub
- activities find
- activities get-default-xaml
- analyze
- analyzer-rules list
- build
- cleanup
- data-fabric-entities install
- data-fabric-entities list
- files diff
- get-library-object-repository
- get-object-repository
- init
- instances list
- pack
- packages inspect
- packages install
- packages versions
- publish
- remote
- restore
- run, debug & execution
- settings
- studio start
- templates search
- test-data add-entity
- test-data add-queue
- test-data add-variation
- tm
- uia
- validate
- workflow-examples get
- workflow-examples list
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
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.
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
| Flag | Description |
|---|---|
--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-cases | Disables 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-run | Runs 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. |
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 tool | Lockfile | Install command the robot runs |
|---|---|---|
| npm | package-lock.json or npm-shrinkwrap.json | npm ci |
| pnpm | pnpm-lock.yaml | pnpm install --frozen-lockfile |
| Yarn | yarn.lock | yarn install --frozen-lockfile |
| Bun | bun.lock or bun.lockb | bun 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.
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.
Related
- testcases — read the warning there before using
link-automationon any test case created by this command. - testsets —
testsets runexecutes the automations this command produces. - uip or packages —
packages uploadpublishes the generated.nupkgto the Orchestrator Package Feed. - uip rpa-legacy pack — packs UiPath Studio test automation projects.
See also
- Test Manager overview
- uip solution pack and uip rpa pack — the
packverbs for other resource types.