Skip to content

docs(agent-cli): require playwright 1.59+ for the project-local CLI #2184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Toto Leung (chintoleung) wants to merge 1 commit into from
Closed

docs(agent-cli): require playwright 1.59+ for the project-local CLI #2184

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions agent-cli/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,23 @@ playwright-cli --help

## Using the version in your project

If Playwright is already a dependency of the project, the CLI is available through it — no global
install needed:
If the `playwright` package is already a dependency of the project (directly, or through
`@playwright/test`), the CLI is available through it — no global install needed for Playwright
1.59 and newer. Older local versions answer `--version` but have no `cli` subcommand. Run the
checks from the directory that declares the Playwright dependency (the workspace root in a
monorepo):

```bash
npx --no-install playwright --version # check that a local Playwright exists
npx playwright cli --help
npx --no-install playwright cli list # capability probe — this one decides
```

Everywhere these docs write `playwright-cli <command>`, `npx playwright cli <command>` works the
same way.
When `cli list` succeeds, keep using `npx --no-install playwright cli <command>`; on 1.60 and
newer its `--help` lists the commands the installed version supports. When it fails with
`error: unknown command 'cli'`, the local Playwright predates 1.59 — and when npx reports that
no local Playwright exists, there is none to use. Install the global CLI in either case.
Everywhere these docs write `playwright-cli <command>`, `npx --no-install playwright cli
<command>` works the same way.

## Initializing a workspace

Expand Down