# checkly sync-playwright - Checkly Docs

> Synchronize Playwright configuration with Checkly settings.

Source: https://www.checklyhq.com/docs/cli/checkly-sync-playwright/

---

- Usage
- Supported Playwright Configuration
- Related Commands

CLI Commands

# checkly sync-playwright

Synchronize Playwright configuration with Checkly settings.

Available since CLI v4.6.0.

The `checkly sync-playwright` command synchronizes your Playwright configuration (`playwright.config`) with your Checkly project configuration (`checkly.config`).
Keeping your configuration in sync ensures consistency between local testing and cloud monitoring environments.

The applied [`playwrightConfig` configuration](https://www.checklyhq.com/docs/constructs/project#param-checks-playwright-config) is applied to all Browser and MultiStep Checks defined in your Checkly project.

Prerequisites

Before using `checkly sync-playwright`, ensure you have:

- An initialized Checkly CLI project

- A `checkly.config.ts` or `checkly.config.js` configuration file

- A `playwright.config.ts` or `playwright.config.js`

## ​ Usage

Copy supported Playwright configuration settings to your Checkly config automatically.
Terminal

```
npx checkly sync-playwright
```

## ​ Supported Playwright Configuration

The `sync-playwright` command parses your existing `playwright.config` file and extracts `global`, `use` and `expect` settings.
playwright.config.ts

```
export default defineConfig({
// Global Playwright config (global)
timeout: 10_000,

// Settings applied to all tests (use)
use: {
trace: 'on-first-retry',
colorScheme: 'light',
viewport: { width: 1280, height: 720 },
actionTimeout: 30000,
navigationTimeout: 30000,
},

// Custom assertion settings (expect)
expect: {
timeout: 5000,
},
});
```

The following Playwright config values are supported and will be synced:

- Global Options
- Use Options
- Expect Options

Option Supported

`timeout` ✅

`use` ✅

`expect` ✅

`testDir` ❌

`fullyParallel` ❌

`forbidOnly` ❌

`retries` ❌

`workers` ❌

`reporter` ❌

`testMatch` ❌

`testIgnore` ❌

`outputDir` ❌

`globalSetup` ❌

`globalTeardown` ❌

`projects` ❌

`webServer` ❌

Option Supported

`baseURL` ✅

`colorScheme` ✅

`geolocation` ✅

`locale` ✅

`permissions` ✅

`timezoneId` ✅

`viewport` ✅

`deviceScaleFactor` ✅

`hasTouch` ✅

`isMobile` ✅

`javaScriptEnabled` ✅

`extraHTTPHeaders` ✅

`httpCredentials` ✅

`ignoreHTTPSErrors` ✅

`offline` ✅

`actionTimeout` ✅

`navigationTimeout` ✅

`testIdAttribute` ✅

`connectOptions` ✅

`contextOptions` ✅

`bypassCSP` ✅

`proxy` ✅

`launchOptions` ❌

`storageState` ❌

`browserName` ❌

`channel` ❌

`headless` ❌

`screenshot` ❌

`trace` ❌

`video` ❌

Option Supported

`timeout` ✅

`toHaveScreenshot` ✅

`toMatchSnapshot` ✅

## ​ Related Commands

- [`checkly test`](https://www.checklyhq.com/docs/cli/checkly-test) - Test with synchronized configuration

- [`checkly deploy`](https://www.checklyhq.com/docs/cli/checkly-deploy) - Deploy with updated settings

Was this page helpful?

[Suggest edits](https://github.com/checkly/docs/edit/main/cli/checkly-sync-playwright.mdx)[Raise issue](https://github.com/checkly/docs/issues/new?title=Issue%20on%20docs&body=Path:%20/cli/checkly-sync-playwright)

[checkly switch Previous](https://www.checklyhq.com/docs/cli/checkly-switch)[checkly test Next](https://www.checklyhq.com/docs/cli/checkly-test)

[x](https://x.com/checklyhq)[github](https://github.com/checkly)[linkedin](https://linkedin.com/company/checkly)

[Powered by This documentation is built and hosted on Mintlify, a developer documentation platform](https://www.mintlify.com/?utm_campaign=poweredBy&utm_medium=referral&utm_source=checkly-422f444a)