https://github.com/privatenumber/playwright-start

Start a long-running Playwright browser server via CLI
https://github.com/privatenumber/playwright-start

browser cli playwright server start

Last synced: 3 months ago
JSON representation

Start a long-running Playwright browser server via CLI

• Host: GitHub
• URL: https://github.com/privatenumber/playwright-start
• Owner: privatenumber
• Created: 2021-02-13T05:27:27.000Z (almost 4 years ago)
• Default Branch: develop
• Last Pushed: 2021-10-27T17:22:25.000Z (over 3 years ago)
• Last Synced: 2024-10-19T01:11:06.850Z (4 months ago)
• Topics: browser, cli, playwright, server, start
• Language: TypeScript
• Homepage:
• Size: 64.5 KB
• Stars: 27
• Watchers: 3
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# playwright-start [![Latest version](https://badgen.net/npm/v/playwright-start)](https://npm.im/playwright-start) [![Monthly downloads](https://badgen.net/npm/dm/playwright-start)](https://npm.im/playwright-start)

Start a long-running [Playwright](https://playwright.dev) browser server via CLI.

Support this project by ⭐️ starring and sharing it. [Follow me](https://github.com/privatenumber) to see what other cool projects I'm working on! ❤️

## 🙋‍♂️ Why?

When developing browser automation scripts, there's a lot of overhead in browser start up every time you test a change.

Start a long-running browser server in a separate window and connect to it from your script to iterate faster! The CLI also comes with a [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) to help you quickly test code.

## 🚀 Install

```sh

npm i -D playwright-start

```

## 🚦 Quick Setup

1. Start a browser server from a separate terminal session:

	```sh

	npx playwright-start

	```

2. Connect from your code:

	```ts

	import {

	    ChromiumBrowser,

	    devices,

	} from 'playwright'

	import connect from 'playwright-start'

	(async () => {

	    const browser = await connect()

	    const context = await browser.newContext({

	        // Emulate Pixel 2 XL

	        ...devices['Pixel 2 XL']

	    })

	    const page = await context.newPage()

	    // ...

	})()

	```

## 👨‍🏫 Examples

### Starting a non-headless Chromium server

```sh

npx playwright-start --headless=false

```

### Starting a Firefox or Webkit server

Firefox:

```sh

npx playwright-start firefox

```

Webkit:

```sh

npx playwright-start webkit

```