Version: 1.10.0

Command Line Interface

Playwright comes with the command line tools that run via npx or as a part of the npm scripts.

Usage#

$ mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI

Generate code#

$ mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="codegen wikipedia.org"

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 -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.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 -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="open --load-storage=auth.json my.web.app"
$ mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="codegen --load-storage=auth.json my.web.app"
# 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(url, handler)), it is possible to call Page.pause() that will open a separate window with codegen controls.

// FIXME
import com.microsoft.playwright.*;
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();
page.pause();
}
}
}

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 -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="open example.com"
# Open page in WebKit
$ mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="wk example.com"

Emulate devices#

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

# Emulate iPhone 11.
$ mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args='open --device="iPhone 11" wikipedia.org'

Emulate color scheme and viewport size#

# Emulate screen size and color scheme.
$ mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="open --viewport-size=800,600 --color-scheme=dark twitter.com"

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 -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args='open --timezone="Europe/Rome" --geolocation="41.890221,12.492348" --lang="it-IT" maps.google.com'

Inspect selectors#

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

playwright.$(selector)#

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

playwright.$$(selector)#

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

playwright.inspect(selector)#

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

playwright.selector(element)#

Generates selector for the given element.

Take screenshot#

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

Generate PDF#

PDF generation only works in Headless Chromium.

# See command help
$ mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="pdf https://en.wikipedia.org/wiki/PDF wiki.pdf"

Known limitations#

Opening WebKit Web Inspector will disconnect Playwright from the browser. In such cases, code generation will stop.