From cfc9a73b1c986aa2dde1fd75387a140b0fed86f8 Mon Sep 17 00:00:00 2001 From: lennondotw Date: Thu, 2 Apr 2026 16:22:55 +0800 Subject: [PATCH] docs(cli): add $schema example for configuration file Add JSON Schema reference and SchemaStore mention to the Configuration file section in README. Depends on: https://github.com/microsoft/playwright/pull/40025 --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 482bfda..271330e 100644 --- a/README.md +++ b/README.md @@ -349,6 +349,19 @@ playwright-cli --config path/to/config.json open example.com Playwright CLI will load config from `.playwright/cli.config.json` by default so that you did not need to specify it every time. +Add `$schema` to your config file for IDE autocompletion and validation: + +```json +{ + "$schema": "https://raw.githubusercontent.com/microsoft/playwright/main/packages/playwright-core/src/tools/mcp/mcp-config.schema.json", + "browser": { + "browserName": "chromium" + } +} +``` + +Once registered with [SchemaStore](https://www.schemastore.org/), the `.playwright/cli.config.json` file will be automatically associated with the schema in supported editors. +
Configuration file schema