Search the docs

Search guides, API endpoints and MCP tools.

Run the project's Playwright specs and publish the run to the workspace

clanker run

Run the project's Playwright specs and publish the run to the workspace

clanker run [options] [playwrightArgs...]

Arguments

<playwrightArgs>…one or more strings

Extra Playwright arguments

Options

--environment <environment>string

Environment to test; its deployment of the product supplies the URL. Required to publish

--product <product>string

Product to test (default: the product in clanker.json)

--base-url <url>string

Test this URL instead of the deployment's

--fixture-url <url>string

Make test data through this Fixture API instead of the deployment's

--keep-dataflag

Keep the run's test data until its scope expires (not on production)

--workspace <slug>string

Workspace slug or id (default: the linked workspace)

--coverage <level>string

Cumulative coverage: critical, acceptance, regression, or exhaustive

--id <id>string

Case ID to include (repeatable)

Defaults to
--folder <folder>string

Case folder to include (repeatable)

Defaults to
--workers <count>string

Tests to run at once: a number, or a percentage of CPU cores such as 100% (default: the Playwright config)

--shard <shard>string

Run this machine's share of the specs, such as 2/4

--run-key <key>string

The key every shard of one run passes, so they publish one run, such as github-<run id>-<attempt>

--uiflag

Open the Playwright UI

--no-publishflag

Run the specs without publishing the run

Examples
clanker run --environment stagingclanker run --environment staging --coverage criticalclanker run --no-publish --base-url http://127.0.0.1:3000