feat(cli): add generate-locator command#40313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Dmitry Gozman (dgozman) merged 1 commit into from
Apr 20, 2026
Merged

feat(cli): add generate-locator command #40313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/playwright-cli-stub/playwright-cli-stub.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@
* limitations under the License.
*/

const { program } = require('playwright-core/lib/coreBundle').cli;
const { program } = require('playwright-core/lib/tools/cli-client/program');

program().catch(e => {
console.error(e.message);
Expand Down
3 changes: 3 additions & 0 deletions packages/playwright-core/src/tools/cli-client/skill/SKILL.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -162,6 +162,9 @@ playwright-cli video-stop
# wait for the user to pick an element in the browser, print its ref and locator
playwright-cli pick

# generate a Playwright locator for an element from its ref or selector
playwright-cli generate-locator e5 --raw

# show a persistent highlight overlay for an element, optionally with a custom style
playwright-cli highlight e5
playwright-cli highlight e5 --style="outline: 3px dashed red"
Expand Down
52 changes: 49 additions & 3 deletions packages/playwright-core/src/tools/cli-client/skill/references/test-generation.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,12 +77,58 @@ playwright-cli click e5

### 3. Add Assertions Manually

Generated code captures actions but not assertions. Add expectations in your test:
Generated code captures actions but not assertions. Add expectations in your test using one of the recommended matchers:

- `toBeVisible()` — element is rendered and visible
- `toHaveText(text)` — element text content matches
- `toHaveValue(value) / toBeEmpty()` — input/select value matches
- `toBeChecked() / toBeUnchecked()` — checkbox state matches
- `toMatchAriaSnapshot(snapshot)` — page (or locator) matches a partial accessibility snapshot

Use `playwright-cli generate-locator <target>` to produce the locator expression for the assertion, and the snapshot/eval commands to capture the expected value.

When asserting text content, make sure that generated locator does not contain text from the element itself. `getByTestId()` or `getByLabel()` usually work well with asserting text. When locator is text-based, prefer `toBeVisible()` instead.

Snapshot to be matched does not have to contain all the information - only capture what's necessary for the assertion. You can use regular expressions for unstable values.

```bash
# Get a stable locator for an element ref to use in the assertion
playwright-cli --raw generate-locator e5
# getByRole('button', { name: 'Submit' })

# Capture expected text content for toHaveText
playwright-cli --raw eval "el => el.textContent" e5

# Capture expected input value for toHaveValue/toBeEmpty
playwright-cli --raw eval "el => el.value" e5

# Capture expected aria snapshot for toMatchAriaSnapshot/toBeChecked
# (whole page, or use a ref to scope to a region)
playwright-cli --raw snapshot
playwright-cli --raw snapshot e5
```

```typescript
// Generated action
await page.getByRole('button', { name: 'Submit' }).click();

// Manual assertion
await expect(page.getByText('Success')).toBeVisible();
// Manual assertions using the outputs above:
await expect(page.getByRole('alert', { name: 'Success' })).toBeVisible();
await expect(page.getByTestId('main-header')).toHaveText('Welcome, user');
await expect(page.getByRole('textbox', { name: 'Email' })).toHaveValue('user@example.com');
await expect(page.getByRole('checkbox', { name: 'Enable notifications' })).toBeChecked();

// toMatchAriaSnapshot on the whole page, finds a matching region
await expect(page).toMatchAriaSnapshot(`
- heading "Welcome, user"
- link /\\d+ new messages?/
- button "Sign out"
`);

// toMatchAriaSnapshot scoped to a region
await expect(page.getByRole('navigation')).toMatchAriaSnapshot(`
- link "Home"
- link /\\d+ new messages?/
- link "Profile"
`);
```
12 changes: 12 additions & 0 deletions packages/playwright-core/src/tools/cli-daemon/commands.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -354,6 +354,17 @@ const pick = declareCommand({
toolParams: () => ({}),
});

const generateLocator = declareCommand({
name: 'generate-locator',
description: 'Generate a Playwright locator for the given element',
category: 'devtools',
args: z.object({
target: z.string().describe(elementTargetDescription),
}),
toolName: 'browser_generate_locator',
toolParams: ({ target }) => ({ target }),
});

const highlight = declareCommand({
name: 'highlight',
description: 'Show (or with --hide, remove) a highlight overlay for an element; `--hide` without a target hides all page highlights.',
Expand DownExpand Up@@ -1074,6 +1085,7 @@ const commandsArray: AnyCommandSchema[] = [
resume,
stepOver,
pick,
generateLocator,
highlight,

// session category
Expand Down
9 changes: 9 additions & 0 deletions tests/mcp/cli-devtools.spec.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,15 @@ test('pick activates dashboard session', async ({ cdpServer, cli, server, startD
expect(output).toContain(`locator: getByRole('button', { name: 'Submit' })`);
});

test('generate-locator', async ({ cli, server }) => {
server.setContent('/', `<button>Submit</button>`, 'text/html');
await cli('open', server.PREFIX);
await cli('snapshot');

const { output } = await cli('generate-locator', 'e2', '--raw');
expect(output).toContain(`getByRole('button', { name: 'Submit' })`);
});

test('highlight', async ({ cdpServer, cli, server }) => {
server.setContent('/', `<button>Submit</button>`, 'text/html');
const browserContext = await cdpServer.start();
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(cli): add generate-locator command#40313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Dmitry Gozman (dgozman)
merged 1 commit into

from

Apr 20, 2026
 Merged


feat(cli): add generate-locator command
#40313
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
packages/playwright-cli-stub/playwright-cli-stub.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@
 * limitations under the License.
 */

const { program } = require('playwright-core/lib/coreBundle').cli;
const { program } = require('playwright-core/lib/tools/cli-client/program');

program().catch(e => {
 console.error(e.message);
Expand Down

3 changes: 3 additions & 0 deletions
packages/playwright-core/src/tools/cli-client/skill/SKILL.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,6 +162,9 @@ playwright-cli video-stop
# wait for the user to pick an element in the browser, print its ref and locator
playwright-cli pick

# generate a Playwright locator for an element from its ref or selector
playwright-cli generate-locator e5 --raw

# show a persistent highlight overlay for an element, optionally with a custom style
playwright-cli highlight e5
playwright-cli highlight e5 --style="outline: 3px dashed red"
Expand Down

52 changes: 49 additions & 3 deletions
packages/playwright-core/src/tools/cli-client/skill/references/test-generation.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,12 +77,58 @@ playwright-cli click e5

### 3. Add Assertions Manually

Generated code captures actions but not assertions. Add expectations in your test:
Generated code captures actions but not assertions. Add expectations in your test using one of the recommended matchers:

- `toBeVisible()` — element is rendered and visible
- `toHaveText(text)` — element text content matches
- `toHaveValue(value) / toBeEmpty()` — input/select value matches
- `toBeChecked() / toBeUnchecked()` — checkbox state matches
- `toMatchAriaSnapshot(snapshot)` — page (or locator) matches a partial accessibility snapshot

Use `playwright-cli generate-locator <target>` to produce the locator expression for the assertion, and the snapshot/eval commands to capture the expected value.

When asserting text content, make sure that generated locator does not contain text from the element itself. `getByTestId()` or `getByLabel()` usually work well with asserting text. When locator is text-based, prefer `toBeVisible()` instead.

Snapshot to be matched does not have to contain all the information - only capture what's necessary for the assertion. You can use regular expressions for unstable values.

```bash
# Get a stable locator for an element ref to use in the assertion
playwright-cli --raw generate-locator e5
# getByRole('button', { name: 'Submit' })

# Capture expected text content for toHaveText
playwright-cli --raw eval "el => el.textContent" e5

# Capture expected input value for toHaveValue/toBeEmpty
playwright-cli --raw eval "el => el.value" e5

# Capture expected aria snapshot for toMatchAriaSnapshot/toBeChecked
# (whole page, or use a ref to scope to a region)
playwright-cli --raw snapshot
playwright-cli --raw snapshot e5
```

```typescript
// Generated action
await page.getByRole('button', { name: 'Submit' }).click();

// Manual assertion
await expect(page.getByText('Success')).toBeVisible();
// Manual assertions using the outputs above:
await expect(page.getByRole('alert', { name: 'Success' })).toBeVisible();
await expect(page.getByTestId('main-header')).toHaveText('Welcome, user');
await expect(page.getByRole('textbox', { name: 'Email' })).toHaveValue('user@example.com');
await expect(page.getByRole('checkbox', { name: 'Enable notifications' })).toBeChecked();

// toMatchAriaSnapshot on the whole page, finds a matching region
await expect(page).toMatchAriaSnapshot(`
 - heading "Welcome, user"
 - link /\\d+ new messages?/
 - button "Sign out"
`);

// toMatchAriaSnapshot scoped to a region
await expect(page.getByRole('navigation')).toMatchAriaSnapshot(`
 - link "Home"
 - link /\\d+ new messages?/
 - link "Profile"
`);
```

12 changes: 12 additions & 0 deletions
packages/playwright-core/src/tools/cli-daemon/commands.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -354,6 +354,17 @@ const pick = declareCommand({
 toolParams: () => ({}),
});

const generateLocator = declareCommand({
 name: 'generate-locator',
 description: 'Generate a Playwright locator for the given element',
 category: 'devtools',
 args: z.object({
 target: z.string().describe(elementTargetDescription),
 }),
 toolName: 'browser_generate_locator',
 toolParams: ({ target }) => ({ target }),
});

const highlight = declareCommand({
 name: 'highlight',
 description: 'Show (or with --hide, remove) a highlight overlay for an element; `--hide` without a target hides all page highlights.',
Expand DownExpand Up@@ -1074,6 +1085,7 @@ const commandsArray: AnyCommandSchema[] = [
 resume,
 stepOver,
 pick,
 generateLocator,
 highlight,

 // session category
Expand Down

9 changes: 9 additions & 0 deletions
tests/mcp/cli-devtools.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,15 @@ test('pick activates dashboard session', async ({ cdpServer, cli, server, startD
 expect(output).toContain(`locator: getByRole('button', { name: 'Submit' })`);
});

test('generate-locator', async ({ cli, server }) => {
 server.setContent('/', `<button>Submit</button>`, 'text/html');
 await cli('open', server.PREFIX);
 await cli('snapshot');

 const { output } = await cli('generate-locator', 'e2', '--raw');
 expect(output).toContain(`getByRole('button', { name: 'Submit' })`);
});

test('highlight', async ({ cdpServer, cli, server }) => {
 server.setContent('/', `<button>Submit</button>`, 'text/html');
 const browserContext = await cdpServer.start();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(cli): add generate-locator command#40313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Dmitry Gozman (dgozman)
merged 1 commit into

from

Apr 20, 2026
 Merged


feat(cli): add generate-locator command
#40313
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
packages/playwright-cli-stub/playwright-cli-stub.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@
 * limitations under the License.
 */

const { program } = require('playwright-core/lib/coreBundle').cli;
const { program } = require('playwright-core/lib/tools/cli-client/program');

program().catch(e => {
 console.error(e.message);
Expand Down

3 changes: 3 additions & 0 deletions
packages/playwright-core/src/tools/cli-client/skill/SKILL.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,6 +162,9 @@ playwright-cli video-stop
# wait for the user to pick an element in the browser, print its ref and locator
playwright-cli pick

# generate a Playwright locator for an element from its ref or selector
playwright-cli generate-locator e5 --raw

# show a persistent highlight overlay for an element, optionally with a custom style
playwright-cli highlight e5
playwright-cli highlight e5 --style="outline: 3px dashed red"
Expand Down

52 changes: 49 additions & 3 deletions
packages/playwright-core/src/tools/cli-client/skill/references/test-generation.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,12 +77,58 @@ playwright-cli click e5

### 3. Add Assertions Manually

Generated code captures actions but not assertions. Add expectations in your test:
Generated code captures actions but not assertions. Add expectations in your test using one of the recommended matchers:

- `toBeVisible()` — element is rendered and visible
- `toHaveText(text)` — element text content matches
- `toHaveValue(value) / toBeEmpty()` — input/select value matches
- `toBeChecked() / toBeUnchecked()` — checkbox state matches
- `toMatchAriaSnapshot(snapshot)` — page (or locator) matches a partial accessibility snapshot

Use `playwright-cli generate-locator <target>` to produce the locator expression for the assertion, and the snapshot/eval commands to capture the expected value.

When asserting text content, make sure that generated locator does not contain text from the element itself. `getByTestId()` or `getByLabel()` usually work well with asserting text. When locator is text-based, prefer `toBeVisible()` instead.

Snapshot to be matched does not have to contain all the information - only capture what's necessary for the assertion. You can use regular expressions for unstable values.

```bash
# Get a stable locator for an element ref to use in the assertion
playwright-cli --raw generate-locator e5
# getByRole('button', { name: 'Submit' })

# Capture expected text content for toHaveText
playwright-cli --raw eval "el => el.textContent" e5

# Capture expected input value for toHaveValue/toBeEmpty
playwright-cli --raw eval "el => el.value" e5

# Capture expected aria snapshot for toMatchAriaSnapshot/toBeChecked
# (whole page, or use a ref to scope to a region)
playwright-cli --raw snapshot
playwright-cli --raw snapshot e5
```

```typescript
// Generated action
await page.getByRole('button', { name: 'Submit' }).click();

// Manual assertion
await expect(page.getByText('Success')).toBeVisible();
// Manual assertions using the outputs above:
await expect(page.getByRole('alert', { name: 'Success' })).toBeVisible();
await expect(page.getByTestId('main-header')).toHaveText('Welcome, user');
await expect(page.getByRole('textbox', { name: 'Email' })).toHaveValue('user@example.com');
await expect(page.getByRole('checkbox', { name: 'Enable notifications' })).toBeChecked();

// toMatchAriaSnapshot on the whole page, finds a matching region
await expect(page).toMatchAriaSnapshot(`
 - heading "Welcome, user"
 - link /\\d+ new messages?/
 - button "Sign out"
`);

// toMatchAriaSnapshot scoped to a region
await expect(page.getByRole('navigation')).toMatchAriaSnapshot(`
 - link "Home"
 - link /\\d+ new messages?/
 - link "Profile"
`);
```

12 changes: 12 additions & 0 deletions
packages/playwright-core/src/tools/cli-daemon/commands.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -354,6 +354,17 @@ const pick = declareCommand({
 toolParams: () => ({}),
});

const generateLocator = declareCommand({
 name: 'generate-locator',
 description: 'Generate a Playwright locator for the given element',
 category: 'devtools',
 args: z.object({
 target: z.string().describe(elementTargetDescription),
 }),
 toolName: 'browser_generate_locator',
 toolParams: ({ target }) => ({ target }),
});

const highlight = declareCommand({
 name: 'highlight',
 description: 'Show (or with --hide, remove) a highlight overlay for an element; `--hide` without a target hides all page highlights.',
Expand DownExpand Up@@ -1074,6 +1085,7 @@ const commandsArray: AnyCommandSchema[] = [
 resume,
 stepOver,
 pick,
 generateLocator,
 highlight,

 // session category
Expand Down

9 changes: 9 additions & 0 deletions
tests/mcp/cli-devtools.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,15 @@ test('pick activates dashboard session', async ({ cdpServer, cli, server, startD
 expect(output).toContain(`locator: getByRole('button', { name: 'Submit' })`);
});

test('generate-locator', async ({ cli, server }) => {
 server.setContent('/', `<button>Submit</button>`, 'text/html');
 await cli('open', server.PREFIX);
 await cli('snapshot');

 const { output } = await cli('generate-locator', 'e2', '--raw');
 expect(output).toContain(`getByRole('button', { name: 'Submit' })`);
});

test('highlight', async ({ cdpServer, cli, server }) => {
 server.setContent('/', `<button>Submit</button>`, 'text/html');
 const browserContext = await cdpServer.start();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(cli): add generate-locator command#40313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Dmitry Gozman (dgozman)
merged 1 commit into

from

Apr 20, 2026
 Merged


feat(cli): add generate-locator command
#40313
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
packages/playwright-cli-stub/playwright-cli-stub.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@
 * limitations under the License.
 */

const { program } = require('playwright-core/lib/coreBundle').cli;
const { program } = require('playwright-core/lib/tools/cli-client/program');

program().catch(e => {
 console.error(e.message);
Expand Down

3 changes: 3 additions & 0 deletions
packages/playwright-core/src/tools/cli-client/skill/SKILL.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,6 +162,9 @@ playwright-cli video-stop
# wait for the user to pick an element in the browser, print its ref and locator
playwright-cli pick

# generate a Playwright locator for an element from its ref or selector
playwright-cli generate-locator e5 --raw

# show a persistent highlight overlay for an element, optionally with a custom style
playwright-cli highlight e5
playwright-cli highlight e5 --style="outline: 3px dashed red"
Expand Down

52 changes: 49 additions & 3 deletions
packages/playwright-core/src/tools/cli-client/skill/references/test-generation.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,12 +77,58 @@ playwright-cli click e5

### 3. Add Assertions Manually

Generated code captures actions but not assertions. Add expectations in your test:
Generated code captures actions but not assertions. Add expectations in your test using one of the recommended matchers:

- `toBeVisible()` — element is rendered and visible
- `toHaveText(text)` — element text content matches
- `toHaveValue(value) / toBeEmpty()` — input/select value matches
- `toBeChecked() / toBeUnchecked()` — checkbox state matches
- `toMatchAriaSnapshot(snapshot)` — page (or locator) matches a partial accessibility snapshot

Use `playwright-cli generate-locator <target>` to produce the locator expression for the assertion, and the snapshot/eval commands to capture the expected value.

When asserting text content, make sure that generated locator does not contain text from the element itself. `getByTestId()` or `getByLabel()` usually work well with asserting text. When locator is text-based, prefer `toBeVisible()` instead.

Snapshot to be matched does not have to contain all the information - only capture what's necessary for the assertion. You can use regular expressions for unstable values.

```bash
# Get a stable locator for an element ref to use in the assertion
playwright-cli --raw generate-locator e5
# getByRole('button', { name: 'Submit' })

# Capture expected text content for toHaveText
playwright-cli --raw eval "el => el.textContent" e5

# Capture expected input value for toHaveValue/toBeEmpty
playwright-cli --raw eval "el => el.value" e5

# Capture expected aria snapshot for toMatchAriaSnapshot/toBeChecked
# (whole page, or use a ref to scope to a region)
playwright-cli --raw snapshot
playwright-cli --raw snapshot e5
```

```typescript
// Generated action
await page.getByRole('button', { name: 'Submit' }).click();

// Manual assertion
await expect(page.getByText('Success')).toBeVisible();
// Manual assertions using the outputs above:
await expect(page.getByRole('alert', { name: 'Success' })).toBeVisible();
await expect(page.getByTestId('main-header')).toHaveText('Welcome, user');
await expect(page.getByRole('textbox', { name: 'Email' })).toHaveValue('user@example.com');
await expect(page.getByRole('checkbox', { name: 'Enable notifications' })).toBeChecked();

// toMatchAriaSnapshot on the whole page, finds a matching region
await expect(page).toMatchAriaSnapshot(`
 - heading "Welcome, user"
 - link /\\d+ new messages?/
 - button "Sign out"
`);

// toMatchAriaSnapshot scoped to a region
await expect(page.getByRole('navigation')).toMatchAriaSnapshot(`
 - link "Home"
 - link /\\d+ new messages?/
 - link "Profile"
`);
```

12 changes: 12 additions & 0 deletions
packages/playwright-core/src/tools/cli-daemon/commands.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -354,6 +354,17 @@ const pick = declareCommand({
 toolParams: () => ({}),
});

const generateLocator = declareCommand({
 name: 'generate-locator',
 description: 'Generate a Playwright locator for the given element',
 category: 'devtools',
 args: z.object({
 target: z.string().describe(elementTargetDescription),
 }),
 toolName: 'browser_generate_locator',
 toolParams: ({ target }) => ({ target }),
});

const highlight = declareCommand({
 name: 'highlight',
 description: 'Show (or with --hide, remove) a highlight overlay for an element; `--hide` without a target hides all page highlights.',
Expand DownExpand Up@@ -1074,6 +1085,7 @@ const commandsArray: AnyCommandSchema[] = [
 resume,
 stepOver,
 pick,
 generateLocator,
 highlight,

 // session category
Expand Down

9 changes: 9 additions & 0 deletions
tests/mcp/cli-devtools.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,15 @@ test('pick activates dashboard session', async ({ cdpServer, cli, server, startD
 expect(output).toContain(`locator: getByRole('button', { name: 'Submit' })`);
});

test('generate-locator', async ({ cli, server }) => {
 server.setContent('/', `<button>Submit</button>`, 'text/html');
 await cli('open', server.PREFIX);
 await cli('snapshot');

 const { output } = await cli('generate-locator', 'e2', '--raw');
 expect(output).toContain(`getByRole('button', { name: 'Submit' })`);
});

test('highlight', async ({ cdpServer, cli, server }) => {
 server.setContent('/', `<button>Submit</button>`, 'text/html');
 const browserContext = await cdpServer.start();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(cli): add generate-locator command#40313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Dmitry Gozman (dgozman)
merged 1 commit into

from

Apr 20, 2026
 Merged


feat(cli): add generate-locator command
#40313
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
packages/playwright-cli-stub/playwright-cli-stub.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@
 * limitations under the License.
 */

const { program } = require('playwright-core/lib/coreBundle').cli;
const { program } = require('playwright-core/lib/tools/cli-client/program');

program().catch(e => {
 console.error(e.message);
Expand Down

3 changes: 3 additions & 0 deletions
packages/playwright-core/src/tools/cli-client/skill/SKILL.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,6 +162,9 @@ playwright-cli video-stop
# wait for the user to pick an element in the browser, print its ref and locator
playwright-cli pick

# generate a Playwright locator for an element from its ref or selector
playwright-cli generate-locator e5 --raw

# show a persistent highlight overlay for an element, optionally with a custom style
playwright-cli highlight e5
playwright-cli highlight e5 --style="outline: 3px dashed red"
Expand Down

52 changes: 49 additions & 3 deletions
packages/playwright-core/src/tools/cli-client/skill/references/test-generation.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,12 +77,58 @@ playwright-cli click e5

### 3. Add Assertions Manually

Generated code captures actions but not assertions. Add expectations in your test:
Generated code captures actions but not assertions. Add expectations in your test using one of the recommended matchers:

- `toBeVisible()` — element is rendered and visible
- `toHaveText(text)` — element text content matches
- `toHaveValue(value) / toBeEmpty()` — input/select value matches
- `toBeChecked() / toBeUnchecked()` — checkbox state matches
- `toMatchAriaSnapshot(snapshot)` — page (or locator) matches a partial accessibility snapshot

Use `playwright-cli generate-locator <target>` to produce the locator expression for the assertion, and the snapshot/eval commands to capture the expected value.

When asserting text content, make sure that generated locator does not contain text from the element itself. `getByTestId()` or `getByLabel()` usually work well with asserting text. When locator is text-based, prefer `toBeVisible()` instead.

Snapshot to be matched does not have to contain all the information - only capture what's necessary for the assertion. You can use regular expressions for unstable values.

```bash
# Get a stable locator for an element ref to use in the assertion
playwright-cli --raw generate-locator e5
# getByRole('button', { name: 'Submit' })

# Capture expected text content for toHaveText
playwright-cli --raw eval "el => el.textContent" e5

# Capture expected input value for toHaveValue/toBeEmpty
playwright-cli --raw eval "el => el.value" e5

# Capture expected aria snapshot for toMatchAriaSnapshot/toBeChecked
# (whole page, or use a ref to scope to a region)
playwright-cli --raw snapshot
playwright-cli --raw snapshot e5
```

```typescript
// Generated action
await page.getByRole('button', { name: 'Submit' }).click();

// Manual assertion
await expect(page.getByText('Success')).toBeVisible();
// Manual assertions using the outputs above:
await expect(page.getByRole('alert', { name: 'Success' })).toBeVisible();
await expect(page.getByTestId('main-header')).toHaveText('Welcome, user');
await expect(page.getByRole('textbox', { name: 'Email' })).toHaveValue('user@example.com');
await expect(page.getByRole('checkbox', { name: 'Enable notifications' })).toBeChecked();

// toMatchAriaSnapshot on the whole page, finds a matching region
await expect(page).toMatchAriaSnapshot(`
 - heading "Welcome, user"
 - link /\\d+ new messages?/
 - button "Sign out"
`);

// toMatchAriaSnapshot scoped to a region
await expect(page.getByRole('navigation')).toMatchAriaSnapshot(`
 - link "Home"
 - link /\\d+ new messages?/
 - link "Profile"
`);
```

12 changes: 12 additions & 0 deletions
packages/playwright-core/src/tools/cli-daemon/commands.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -354,6 +354,17 @@ const pick = declareCommand({
 toolParams: () => ({}),
});

const generateLocator = declareCommand({
 name: 'generate-locator',
 description: 'Generate a Playwright locator for the given element',
 category: 'devtools',
 args: z.object({
 target: z.string().describe(elementTargetDescription),
 }),
 toolName: 'browser_generate_locator',
 toolParams: ({ target }) => ({ target }),
});

const highlight = declareCommand({
 name: 'highlight',
 description: 'Show (or with --hide, remove) a highlight overlay for an element; `--hide` without a target hides all page highlights.',
Expand DownExpand Up@@ -1074,6 +1085,7 @@ const commandsArray: AnyCommandSchema[] = [
 resume,
 stepOver,
 pick,
 generateLocator,
 highlight,

 // session category
Expand Down

9 changes: 9 additions & 0 deletions
tests/mcp/cli-devtools.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,15 @@ test('pick activates dashboard session', async ({ cdpServer, cli, server, startD
 expect(output).toContain(`locator: getByRole('button', { name: 'Submit' })`);
});

test('generate-locator', async ({ cli, server }) => {
 server.setContent('/', `<button>Submit</button>`, 'text/html');
 await cli('open', server.PREFIX);
 await cli('snapshot');

 const { output } = await cli('generate-locator', 'e2', '--raw');
 expect(output).toContain(`getByRole('button', { name: 'Submit' })`);
});

test('highlight', async ({ cdpServer, cli, server }) => {
 server.setContent('/', `<button>Submit</button>`, 'text/html');
 const browserContext = await cdpServer.start();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(cli): add generate-locator command#40313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Dmitry Gozman (dgozman)
merged 1 commit into

from

Apr 20, 2026
 Merged


feat(cli): add generate-locator command
#40313
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
packages/playwright-cli-stub/playwright-cli-stub.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@
 * limitations under the License.
 */

const { program } = require('playwright-core/lib/coreBundle').cli;
const { program } = require('playwright-core/lib/tools/cli-client/program');

program().catch(e => {
 console.error(e.message);
Expand Down

3 changes: 3 additions & 0 deletions
packages/playwright-core/src/tools/cli-client/skill/SKILL.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,6 +162,9 @@ playwright-cli video-stop
# wait for the user to pick an element in the browser, print its ref and locator
playwright-cli pick

# generate a Playwright locator for an element from its ref or selector
playwright-cli generate-locator e5 --raw

# show a persistent highlight overlay for an element, optionally with a custom style
playwright-cli highlight e5
playwright-cli highlight e5 --style="outline: 3px dashed red"
Expand Down

52 changes: 49 additions & 3 deletions
packages/playwright-core/src/tools/cli-client/skill/references/test-generation.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,12 +77,58 @@ playwright-cli click e5

### 3. Add Assertions Manually

Generated code captures actions but not assertions. Add expectations in your test:
Generated code captures actions but not assertions. Add expectations in your test using one of the recommended matchers:

- `toBeVisible()` — element is rendered and visible
- `toHaveText(text)` — element text content matches
- `toHaveValue(value) / toBeEmpty()` — input/select value matches
- `toBeChecked() / toBeUnchecked()` — checkbox state matches
- `toMatchAriaSnapshot(snapshot)` — page (or locator) matches a partial accessibility snapshot

Use `playwright-cli generate-locator <target>` to produce the locator expression for the assertion, and the snapshot/eval commands to capture the expected value.

When asserting text content, make sure that generated locator does not contain text from the element itself. `getByTestId()` or `getByLabel()` usually work well with asserting text. When locator is text-based, prefer `toBeVisible()` instead.

Snapshot to be matched does not have to contain all the information - only capture what's necessary for the assertion. You can use regular expressions for unstable values.

```bash
# Get a stable locator for an element ref to use in the assertion
playwright-cli --raw generate-locator e5
# getByRole('button', { name: 'Submit' })

# Capture expected text content for toHaveText
playwright-cli --raw eval "el => el.textContent" e5

# Capture expected input value for toHaveValue/toBeEmpty
playwright-cli --raw eval "el => el.value" e5

# Capture expected aria snapshot for toMatchAriaSnapshot/toBeChecked
# (whole page, or use a ref to scope to a region)
playwright-cli --raw snapshot
playwright-cli --raw snapshot e5
```

```typescript
// Generated action
await page.getByRole('button', { name: 'Submit' }).click();

// Manual assertion
await expect(page.getByText('Success')).toBeVisible();
// Manual assertions using the outputs above:
await expect(page.getByRole('alert', { name: 'Success' })).toBeVisible();
await expect(page.getByTestId('main-header')).toHaveText('Welcome, user');
await expect(page.getByRole('textbox', { name: 'Email' })).toHaveValue('user@example.com');
await expect(page.getByRole('checkbox', { name: 'Enable notifications' })).toBeChecked();

// toMatchAriaSnapshot on the whole page, finds a matching region
await expect(page).toMatchAriaSnapshot(`
 - heading "Welcome, user"
 - link /\\d+ new messages?/
 - button "Sign out"
`);

// toMatchAriaSnapshot scoped to a region
await expect(page.getByRole('navigation')).toMatchAriaSnapshot(`
 - link "Home"
 - link /\\d+ new messages?/
 - link "Profile"
`);
```

12 changes: 12 additions & 0 deletions
packages/playwright-core/src/tools/cli-daemon/commands.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -354,6 +354,17 @@ const pick = declareCommand({
 toolParams: () => ({}),
});

const generateLocator = declareCommand({
 name: 'generate-locator',
 description: 'Generate a Playwright locator for the given element',
 category: 'devtools',
 args: z.object({
 target: z.string().describe(elementTargetDescription),
 }),
 toolName: 'browser_generate_locator',
 toolParams: ({ target }) => ({ target }),
});

const highlight = declareCommand({
 name: 'highlight',
 description: 'Show (or with --hide, remove) a highlight overlay for an element; `--hide` without a target hides all page highlights.',
Expand DownExpand Up@@ -1074,6 +1085,7 @@ const commandsArray: AnyCommandSchema[] = [
 resume,
 stepOver,
 pick,
 generateLocator,
 highlight,

 // session category
Expand Down

9 changes: 9 additions & 0 deletions
tests/mcp/cli-devtools.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,15 @@ test('pick activates dashboard session', async ({ cdpServer, cli, server, startD
 expect(output).toContain(`locator: getByRole('button', { name: 'Submit' })`);
});

test('generate-locator', async ({ cli, server }) => {
 server.setContent('/', `<button>Submit</button>`, 'text/html');
 await cli('open', server.PREFIX);
 await cli('snapshot');

 const { output } = await cli('generate-locator', 'e2', '--raw');
 expect(output).toContain(`getByRole('button', { name: 'Submit' })`);
});

test('highlight', async ({ cdpServer, cli, server }) => {
 server.setContent('/', `<button>Submit</button>`, 'text/html');
 const browserContext = await cdpServer.start();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(cli): add generate-locator command#40313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Dmitry Gozman (dgozman)
merged 1 commit into

from

Apr 20, 2026
 Merged


feat(cli): add generate-locator command
#40313
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
packages/playwright-cli-stub/playwright-cli-stub.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@
 * limitations under the License.
 */

const { program } = require('playwright-core/lib/coreBundle').cli;
const { program } = require('playwright-core/lib/tools/cli-client/program');

program().catch(e => {
 console.error(e.message);
Expand Down

3 changes: 3 additions & 0 deletions
packages/playwright-core/src/tools/cli-client/skill/SKILL.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,6 +162,9 @@ playwright-cli video-stop
# wait for the user to pick an element in the browser, print its ref and locator
playwright-cli pick

# generate a Playwright locator for an element from its ref or selector
playwright-cli generate-locator e5 --raw

# show a persistent highlight overlay for an element, optionally with a custom style
playwright-cli highlight e5
playwright-cli highlight e5 --style="outline: 3px dashed red"
Expand Down

52 changes: 49 additions & 3 deletions
packages/playwright-core/src/tools/cli-client/skill/references/test-generation.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,12 +77,58 @@ playwright-cli click e5

### 3. Add Assertions Manually

Generated code captures actions but not assertions. Add expectations in your test:
Generated code captures actions but not assertions. Add expectations in your test using one of the recommended matchers:

- `toBeVisible()` — element is rendered and visible
- `toHaveText(text)` — element text content matches
- `toHaveValue(value) / toBeEmpty()` — input/select value matches
- `toBeChecked() / toBeUnchecked()` — checkbox state matches
- `toMatchAriaSnapshot(snapshot)` — page (or locator) matches a partial accessibility snapshot

Use `playwright-cli generate-locator <target>` to produce the locator expression for the assertion, and the snapshot/eval commands to capture the expected value.

When asserting text content, make sure that generated locator does not contain text from the element itself. `getByTestId()` or `getByLabel()` usually work well with asserting text. When locator is text-based, prefer `toBeVisible()` instead.

Snapshot to be matched does not have to contain all the information - only capture what's necessary for the assertion. You can use regular expressions for unstable values.

```bash
# Get a stable locator for an element ref to use in the assertion
playwright-cli --raw generate-locator e5
# getByRole('button', { name: 'Submit' })

# Capture expected text content for toHaveText
playwright-cli --raw eval "el => el.textContent" e5

# Capture expected input value for toHaveValue/toBeEmpty
playwright-cli --raw eval "el => el.value" e5

# Capture expected aria snapshot for toMatchAriaSnapshot/toBeChecked
# (whole page, or use a ref to scope to a region)
playwright-cli --raw snapshot
playwright-cli --raw snapshot e5
```

```typescript
// Generated action
await page.getByRole('button', { name: 'Submit' }).click();

// Manual assertion
await expect(page.getByText('Success')).toBeVisible();
// Manual assertions using the outputs above:
await expect(page.getByRole('alert', { name: 'Success' })).toBeVisible();
await expect(page.getByTestId('main-header')).toHaveText('Welcome, user');
await expect(page.getByRole('textbox', { name: 'Email' })).toHaveValue('user@example.com');
await expect(page.getByRole('checkbox', { name: 'Enable notifications' })).toBeChecked();

// toMatchAriaSnapshot on the whole page, finds a matching region
await expect(page).toMatchAriaSnapshot(`
 - heading "Welcome, user"
 - link /\\d+ new messages?/
 - button "Sign out"
`);

// toMatchAriaSnapshot scoped to a region
await expect(page.getByRole('navigation')).toMatchAriaSnapshot(`
 - link "Home"
 - link /\\d+ new messages?/
 - link "Profile"
`);
```

12 changes: 12 additions & 0 deletions
packages/playwright-core/src/tools/cli-daemon/commands.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -354,6 +354,17 @@ const pick = declareCommand({
 toolParams: () => ({}),
});

const generateLocator = declareCommand({
 name: 'generate-locator',
 description: 'Generate a Playwright locator for the given element',
 category: 'devtools',
 args: z.object({
 target: z.string().describe(elementTargetDescription),
 }),
 toolName: 'browser_generate_locator',
 toolParams: ({ target }) => ({ target }),
});

const highlight = declareCommand({
 name: 'highlight',
 description: 'Show (or with --hide, remove) a highlight overlay for an element; `--hide` without a target hides all page highlights.',
Expand DownExpand Up@@ -1074,6 +1085,7 @@ const commandsArray: AnyCommandSchema[] = [
 resume,
 stepOver,
 pick,
 generateLocator,
 highlight,

 // session category
Expand Down

9 changes: 9 additions & 0 deletions
tests/mcp/cli-devtools.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,15 @@ test('pick activates dashboard session', async ({ cdpServer, cli, server, startD
 expect(output).toContain(`locator: getByRole('button', { name: 'Submit' })`);
});

test('generate-locator', async ({ cli, server }) => {
 server.setContent('/', `<button>Submit</button>`, 'text/html');
 await cli('open', server.PREFIX);
 await cli('snapshot');

 const { output } = await cli('generate-locator', 'e2', '--raw');
 expect(output).toContain(`getByRole('button', { name: 'Submit' })`);
});

test('highlight', async ({ cdpServer, cli, server }) => {
 server.setContent('/', `<button>Submit</button>`, 'text/html');
 const browserContext = await cdpServer.start();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(cli): add generate-locator command#40313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Dmitry Gozman (dgozman)
merged 1 commit into

from

Apr 20, 2026
 Merged


feat(cli): add generate-locator command
#40313
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
packages/playwright-cli-stub/playwright-cli-stub.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@
 * limitations under the License.
 */

const { program } = require('playwright-core/lib/coreBundle').cli;
const { program } = require('playwright-core/lib/tools/cli-client/program');

program().catch(e => {
 console.error(e.message);
Expand Down

3 changes: 3 additions & 0 deletions
packages/playwright-core/src/tools/cli-client/skill/SKILL.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,6 +162,9 @@ playwright-cli video-stop
# wait for the user to pick an element in the browser, print its ref and locator
playwright-cli pick

# generate a Playwright locator for an element from its ref or selector
playwright-cli generate-locator e5 --raw

# show a persistent highlight overlay for an element, optionally with a custom style
playwright-cli highlight e5
playwright-cli highlight e5 --style="outline: 3px dashed red"
Expand Down

52 changes: 49 additions & 3 deletions
packages/playwright-core/src/tools/cli-client/skill/references/test-generation.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,12 +77,58 @@ playwright-cli click e5

### 3. Add Assertions Manually

Generated code captures actions but not assertions. Add expectations in your test:
Generated code captures actions but not assertions. Add expectations in your test using one of the recommended matchers:

- `toBeVisible()` — element is rendered and visible
- `toHaveText(text)` — element text content matches
- `toHaveValue(value) / toBeEmpty()` — input/select value matches
- `toBeChecked() / toBeUnchecked()` — checkbox state matches
- `toMatchAriaSnapshot(snapshot)` — page (or locator) matches a partial accessibility snapshot

Use `playwright-cli generate-locator <target>` to produce the locator expression for the assertion, and the snapshot/eval commands to capture the expected value.

When asserting text content, make sure that generated locator does not contain text from the element itself. `getByTestId()` or `getByLabel()` usually work well with asserting text. When locator is text-based, prefer `toBeVisible()` instead.

Snapshot to be matched does not have to contain all the information - only capture what's necessary for the assertion. You can use regular expressions for unstable values.

```bash
# Get a stable locator for an element ref to use in the assertion
playwright-cli --raw generate-locator e5
# getByRole('button', { name: 'Submit' })

# Capture expected text content for toHaveText
playwright-cli --raw eval "el => el.textContent" e5

# Capture expected input value for toHaveValue/toBeEmpty
playwright-cli --raw eval "el => el.value" e5

# Capture expected aria snapshot for toMatchAriaSnapshot/toBeChecked
# (whole page, or use a ref to scope to a region)
playwright-cli --raw snapshot
playwright-cli --raw snapshot e5
```

```typescript
// Generated action
await page.getByRole('button', { name: 'Submit' }).click();

// Manual assertion
await expect(page.getByText('Success')).toBeVisible();
// Manual assertions using the outputs above:
await expect(page.getByRole('alert', { name: 'Success' })).toBeVisible();
await expect(page.getByTestId('main-header')).toHaveText('Welcome, user');
await expect(page.getByRole('textbox', { name: 'Email' })).toHaveValue('user@example.com');
await expect(page.getByRole('checkbox', { name: 'Enable notifications' })).toBeChecked();

// toMatchAriaSnapshot on the whole page, finds a matching region
await expect(page).toMatchAriaSnapshot(`
 - heading "Welcome, user"
 - link /\\d+ new messages?/
 - button "Sign out"
`);

// toMatchAriaSnapshot scoped to a region
await expect(page.getByRole('navigation')).toMatchAriaSnapshot(`
 - link "Home"
 - link /\\d+ new messages?/
 - link "Profile"
`);
```

12 changes: 12 additions & 0 deletions
packages/playwright-core/src/tools/cli-daemon/commands.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -354,6 +354,17 @@ const pick = declareCommand({
 toolParams: () => ({}),
});

const generateLocator = declareCommand({
 name: 'generate-locator',
 description: 'Generate a Playwright locator for the given element',
 category: 'devtools',
 args: z.object({
 target: z.string().describe(elementTargetDescription),
 }),
 toolName: 'browser_generate_locator',
 toolParams: ({ target }) => ({ target }),
});

const highlight = declareCommand({
 name: 'highlight',
 description: 'Show (or with --hide, remove) a highlight overlay for an element; `--hide` without a target hides all page highlights.',
Expand DownExpand Up@@ -1074,6 +1085,7 @@ const commandsArray: AnyCommandSchema[] = [
 resume,
 stepOver,
 pick,
 generateLocator,
 highlight,

 // session category
Expand Down

9 changes: 9 additions & 0 deletions
tests/mcp/cli-devtools.spec.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,15 @@ test('pick activates dashboard session', async ({ cdpServer, cli, server, startD
 expect(output).toContain(`locator: getByRole('button', { name: 'Submit' })`);
});

test('generate-locator', async ({ cli, server }) => {
 server.setContent('/', `<button>Submit</button>`, 'text/html');
 await cli('open', server.PREFIX);
 await cli('snapshot');

 const { output } = await cli('generate-locator', 'e2', '--raw');
 expect(output).toContain(`getByRole('button', { name: 'Submit' })`);
});

test('highlight', async ({ cdpServer, cli, server }) => {
 server.setContent('/', `<button>Submit</button>`, 'text/html');
 const browserContext = await cdpServer.start();
Expand Down
Loading