Skip to main content

Command line tools

Playwright comes with the command line tools.


mvn exec:java -e -D

Install browsers

Playwright can install supported browsers.

# Running without arguments will install default browsers
mvn exec:java -e -D -D exec.args="install"

You can also install specific browsers by providing an argument:

# Install WebKit
mvn exec:java -e -D -D exec.args="install webkit"

See all supported browsers:

mvn exec:java -e -D -D exec.args="install --help"

Install system dependencies

System dependencies can get installed automatically. This is useful for CI environments.

# See command help
mvn exec:java -e -D -D exec.args="install-deps"

You can also install the dependencies for a single browser only by passing it as an argument:

mvn exec:java -e -D -D exec.args="install-deps chromium"

It's also possible to combine install-deps with install and install by that the browsers and OS dependencies with a single command. This would do both for Chromium, but you can also leave it out.

mvn exec:java -e -D -D exec.args="install --with-deps chromium"

Generate code

mvn exec:java -e -D -D exec.args="codegen"

Run codegen and perform actions in the browser. Playwright CLI will generate JavaScript code for the user interactions. codegen will attempt to generate resilient text-based selectors.

Preserve authenticated state

Run codegen with --save-storage to save cookies and localStorage at the end. This is useful to separately record authentication step and reuse it later.

mvn exec:java -e -D -D exec.args="codegen  --save-storage=auth.json"
# Perform authentication and exit.
# auth.json will contain the storage state.

Run with --load-storage to consume previously loaded storage. This way, all cookies and localStorage will be restored, bringing most web apps to the authenticated state.

mvn exec:java -e -D -D exec.args="open --load-storage=auth.json"
mvn exec:java -e -D -D exec.args="codegen --load-storage=auth.json"
# Perform authentication and exit.
# auth.json will contain the storage state.

Codegen with custom setup

If you would like to use codegen in some non-standard setup (for example, use BrowserContext.route()), it is possible to call Page.pause() that will open a separate window with codegen controls.


public class Example {
public static void main(String[] args) {
try (Playwright playwright = Playwright.create()) {
BrowserType chromium = playwright.chromium();
// Make sure to run headed.
Browser browser = chromium.launch(new BrowserType.LaunchOptions().setHeadless(false));
// Setup context however you like.
BrowserContext context = browser.newContext(/* pass any options */);
context.route("**/*", route -> route.resume());
// Pause the page, and start recording manually.
Page page = context.newPage();

Open pages

With open, you can use Playwright bundled browsers to browse web pages. Playwright provides cross-platform WebKit builds that can be used to reproduce Safari rendering across Windows, Linux and macOS.

# Open page in Chromium
mvn exec:java -e -D -D exec.args="open"
# Open page in WebKit
mvn exec:java -e -D -D exec.args="wk"

Emulate devices

open can emulate mobile and tablet devices from the playwright.devices list.

# Emulate iPhone 11.
mvn exec:java -e -D -D exec.args='open --device="iPhone 11"'

Emulate color scheme and viewport size

# Emulate screen size and color scheme.
mvn exec:java -e -D -D exec.args="open --viewport-size=800,600 --color-scheme=dark"

Emulate geolocation, language and timezone

# Emulate timezone, language & location
# Once page opens, click the "my location" button to see geolocation in action
mvn exec:java -e -D -D exec.args='open --timezone="Europe/Rome" --geolocation="41.890221,12.492348" --lang="it-IT"'

Inspect selectors

During open or codegen, you can use following API inside the developer tools console of any browser.


Query Playwright selector, using the actual Playwright query engine, for example:


Same as playwright.$, but returns all matching elements.


Reveal element in the Elements panel (if DevTools of the respective browser supports it).


Query Playwright element using the actual Playwright query engine, for example:


Generates selector for the given element.

Take screenshot

# See command help
mvn exec:java -e -D -D exec.args="screenshot --help"
# Wait 3 seconds before capturing a screenshot after page loads ('load' event fires)
mvn exec:java -e -D -D exec.args='screenshot --device="iPhone 11" --color-scheme=dark --wait-for-timeout=3000 twitter-iphone.png'
# Capture a full page screenshot
mvn exec:java -e -D -D exec.args='screenshot --full-page wiki-full.png'

Generate PDF

PDF generation only works in Headless Chromium.

# See command help
mvn exec:java -e -D -D exec.args="pdf wiki.pdf"