-
Notifications
You must be signed in to change notification settings - Fork 0
Add playwright-cli skill #5
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.
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
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,278 @@ | ||
| --- | ||
| name: playwright-cli | ||
| description: Automates browser interactions for web testing, form filling, screenshots, and data extraction. Use when the user needs to navigate websites, interact with web pages, fill forms, take screenshots, test web applications, or extract information from web pages. | ||
| allowed-tools: Bash(playwright-cli:*) | ||
| --- | ||
|
|
||
| # Browser Automation with playwright-cli | ||
|
|
||
| ## Quick start | ||
|
|
||
| ```bash | ||
| # open new browser | ||
| playwright-cli open | ||
| # navigate to a page | ||
| playwright-cli goto https://playwright.dev | ||
| # interact with the page using refs from the snapshot | ||
| playwright-cli click e15 | ||
| playwright-cli type "page.click" | ||
| playwright-cli press Enter | ||
| # take a screenshot (rarely used, as snapshot is more common) | ||
| playwright-cli screenshot | ||
| # close the browser | ||
| playwright-cli close | ||
| ``` | ||
|
|
||
| ## Commands | ||
|
|
||
| ### Core | ||
|
|
||
| ```bash | ||
| playwright-cli open | ||
| # open and navigate right away | ||
| playwright-cli open https://example.com/ | ||
| playwright-cli goto https://playwright.dev | ||
| playwright-cli type "search query" | ||
| playwright-cli click e3 | ||
| playwright-cli dblclick e7 | ||
| playwright-cli fill e5 "user@example.com" | ||
| playwright-cli drag e2 e8 | ||
| playwright-cli hover e4 | ||
| playwright-cli select e9 "option-value" | ||
| playwright-cli upload ./document.pdf | ||
| playwright-cli check e12 | ||
| playwright-cli uncheck e12 | ||
| playwright-cli snapshot | ||
| playwright-cli snapshot --filename=after-click.yaml | ||
| playwright-cli eval "document.title" | ||
| playwright-cli eval "el => el.textContent" e5 | ||
| playwright-cli dialog-accept | ||
| playwright-cli dialog-accept "confirmation text" | ||
| playwright-cli dialog-dismiss | ||
| playwright-cli resize 1920 1080 | ||
| playwright-cli close | ||
| ``` | ||
| ### Navigation | ||
| ```bash | ||
| playwright-cli go-back | ||
| playwright-cli go-forward | ||
| playwright-cli reload | ||
| ``` | ||
| ### Keyboard | ||
| ```bash | ||
| playwright-cli press Enter | ||
| playwright-cli press ArrowDown | ||
| playwright-cli keydown Shift | ||
| playwright-cli keyup Shift | ||
| ``` | ||
| ### Mouse | ||
| ```bash | ||
| playwright-cli mousemove 150 300 | ||
| playwright-cli mousedown | ||
| playwright-cli mousedown right | ||
| playwright-cli mouseup | ||
| playwright-cli mouseup right | ||
| playwright-cli mousewheel 0 100 | ||
| ``` | ||
| ### Save as | ||
| ```bash | ||
| playwright-cli screenshot | ||
| playwright-cli screenshot e5 | ||
| playwright-cli screenshot --filename=page.png | ||
| playwright-cli pdf --filename=page.pdf | ||
| ``` | ||
| ### Tabs | ||
| ```bash | ||
| playwright-cli tab-list | ||
| playwright-cli tab-new | ||
| playwright-cli tab-new https://example.com/page | ||
| playwright-cli tab-close | ||
| playwright-cli tab-close 2 | ||
| playwright-cli tab-select 0 | ||
| ``` | ||
| ### Storage | ||
| ```bash | ||
| playwright-cli state-save | ||
| playwright-cli state-save auth.json | ||
| playwright-cli state-load auth.json | ||
|
|
||
| # Cookies | ||
| playwright-cli cookie-list | ||
| playwright-cli cookie-list --domain=example.com | ||
| playwright-cli cookie-get session_id | ||
| playwright-cli cookie-set session_id abc123 | ||
| playwright-cli cookie-set session_id abc123 --domain=example.com --httpOnly --secure | ||
| playwright-cli cookie-delete session_id | ||
| playwright-cli cookie-clear | ||
|
|
||
| # LocalStorage | ||
| playwright-cli localstorage-list | ||
| playwright-cli localstorage-get theme | ||
| playwright-cli localstorage-set theme dark | ||
| playwright-cli localstorage-delete theme | ||
| playwright-cli localstorage-clear | ||
|
|
||
| # SessionStorage | ||
| playwright-cli sessionstorage-list | ||
| playwright-cli sessionstorage-get step | ||
| playwright-cli sessionstorage-set step 3 | ||
| playwright-cli sessionstorage-delete step | ||
| playwright-cli sessionstorage-clear | ||
| ``` | ||
| ### Network | ||
| ```bash | ||
| playwright-cli route "**/*.jpg" --status=404 | ||
| playwright-cli route "https://api.example.com/**" --body='{"mock": true}' | ||
| playwright-cli route-list | ||
| playwright-cli unroute "**/*.jpg" | ||
| playwright-cli unroute | ||
| ``` | ||
| ### DevTools | ||
| ```bash | ||
| playwright-cli console | ||
| playwright-cli console warning | ||
| playwright-cli network | ||
| playwright-cli run-code "async page => await page.context().grantPermissions(['geolocation'])" | ||
| playwright-cli tracing-start | ||
| playwright-cli tracing-stop | ||
| playwright-cli video-start | ||
| playwright-cli video-stop video.webm | ||
| ``` | ||
| ## Open parameters | ||
| ```bash | ||
| # Use specific browser when creating session | ||
| playwright-cli open --browser=chrome | ||
| playwright-cli open --browser=firefox | ||
| playwright-cli open --browser=webkit | ||
| playwright-cli open --browser=msedge | ||
| # Connect to browser via extension | ||
| playwright-cli open --extension | ||
|
|
||
| # Use persistent profile (by default profile is in-memory) | ||
| playwright-cli open --persistent | ||
| # Use persistent profile with custom directory | ||
| playwright-cli open --profile=/path/to/profile | ||
|
|
||
| # Start with config file | ||
| playwright-cli open --config=my-config.json | ||
|
|
||
| # Close the browser | ||
| playwright-cli close | ||
| # Delete user data for the default session | ||
| playwright-cli delete-data | ||
| ``` | ||
| ## Snapshots | ||
| After each command, playwright-cli provides a snapshot of the current browser state. | ||
| ```bash | ||
| > playwright-cli goto https://example.com | ||
| ### Page | ||
| - Page URL: https://example.com/ | ||
| - Page Title: Example Domain | ||
| ### Snapshot | ||
| [Snapshot](.playwright-cli/page-2026-02-14T19-22-42-679Z.yml) | ||
| ``` | ||
| You can also take a snapshot on demand using `playwright-cli snapshot` command. | ||
| If `--filename` is not provided, a new snapshot file is created with a timestamp. Default to automatic file naming, use `--filename=` when artifact is a part of the workflow result. | ||
| ## Browser Sessions | ||
| ```bash | ||
| # create new browser session named "mysession" with persistent profile | ||
| playwright-cli -s=mysession open example.com --persistent | ||
| # same with manually specified profile directory (use when requested explicitly) | ||
| playwright-cli -s=mysession open example.com --profile=/path/to/profile | ||
| playwright-cli -s=mysession click e6 | ||
| playwright-cli -s=mysession close # stop a named browser | ||
| playwright-cli -s=mysession delete-data # delete user data for persistent session | ||
|
|
||
| playwright-cli list | ||
| # Close all browsers | ||
| playwright-cli close-all | ||
| # Forcefully kill all browser processes | ||
| playwright-cli kill-all | ||
| ``` | ||
| ## Local installation | ||
| In some cases user might want to install playwright-cli locally. If running globally available `playwright-cli` binary fails, use `npx playwright-cli` to run the commands. For example: | ||
| ```bash | ||
| npx playwright-cli open https://example.com | ||
| npx playwright-cli click e1 | ||
| ``` | ||
| ## Example: Form submission | ||
| ```bash | ||
| playwright-cli open https://example.com/form | ||
| playwright-cli snapshot | ||
|
|
||
| playwright-cli fill e1 "user@example.com" | ||
| playwright-cli fill e2 "password123" | ||
| playwright-cli click e3 | ||
| playwright-cli snapshot | ||
| playwright-cli close | ||
| ``` | ||
| ## Example: Multi-tab workflow | ||
| ```bash | ||
| playwright-cli open https://example.com | ||
| playwright-cli tab-new https://example.com/other | ||
| playwright-cli tab-list | ||
| playwright-cli tab-select 0 | ||
| playwright-cli snapshot | ||
| playwright-cli close | ||
| ``` | ||
| ## Example: Debugging with DevTools | ||
| ```bash | ||
| playwright-cli open https://example.com | ||
| playwright-cli click e4 | ||
| playwright-cli fill e7 "test" | ||
| playwright-cli console | ||
| playwright-cli network | ||
| playwright-cli close | ||
| ``` | ||
| ```bash | ||
| playwright-cli open https://example.com | ||
| playwright-cli tracing-start | ||
| playwright-cli click e4 | ||
| playwright-cli fill e7 "test" | ||
| playwright-cli tracing-stop | ||
| playwright-cli close | ||
| ``` | ||
| ## Specific tasks | ||
| * **Request mocking** [references/request-mocking.md](references/request-mocking.md) | ||
| * **Running Playwright code** [references/running-code.md](references/running-code.md) | ||
| * **Browser session management** [references/session-management.md](references/session-management.md) | ||
| * **Storage state (cookies, localStorage)** [references/storage-state.md](references/storage-state.md) | ||
| * **Test generation** [references/test-generation.md](references/test-generation.md) | ||
| * **Tracing** [references/tracing.md](references/tracing.md) | ||
| * **Video recording** [references/video-recording.md](references/video-recording.md) | ||
87 changes: 87 additions & 0 deletions
87
.claude/skills/playwright-cli/references/request-mocking.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| # Request Mocking | ||
|
|
||
| Intercept, mock, modify, and block network requests. | ||
|
|
||
| ## CLI Route Commands | ||
|
|
||
| ```bash | ||
| # Mock with custom status | ||
| playwright-cli route "**/*.jpg" --status=404 | ||
|
|
||
| # Mock with JSON body | ||
| playwright-cli route "**/api/users" --body='[{"id":1,"name":"Alice"}]' --content-type=application/json | ||
|
|
||
| # Mock with custom headers | ||
| playwright-cli route "**/api/data" --body='{"ok":true}' --header="X-Custom: value" | ||
|
|
||
| # Remove headers from requests | ||
| playwright-cli route "**/*" --remove-header=cookie,authorization | ||
|
|
||
| # List active routes | ||
| playwright-cli route-list | ||
|
|
||
| # Remove a route or all routes | ||
| playwright-cli unroute "**/*.jpg" | ||
| playwright-cli unroute | ||
| ``` | ||
|
|
||
| ## URL Patterns | ||
|
|
||
| ``` | ||
| **/api/users - Exact path match | ||
| **/api/*/details - Wildcard in path | ||
| **/*.{png,jpg,jpeg} - Match file extensions | ||
| **/search?q=* - Match query parameters | ||
| ``` | ||
|
|
||
| ## Advanced Mocking with run-code | ||
|
|
||
| For conditional responses, request body inspection, response modification, or delays: | ||
|
|
||
| ### Conditional Response Based on Request | ||
|
|
||
| ```bash | ||
| playwright-cli run-code "async page => { | ||
| await page.route('**/api/login', route => { | ||
| const body = route.request().postDataJSON(); | ||
| if (body.username === 'admin') { | ||
| route.fulfill({ body: JSON.stringify({ token: 'mock-token' }) }); | ||
| } else { | ||
| route.fulfill({ status: 401, body: JSON.stringify({ error: 'Invalid' }) }); | ||
| } | ||
| }); | ||
| }" | ||
| ``` | ||
|
|
||
| ### Modify Real Response | ||
|
|
||
| ```bash | ||
| playwright-cli run-code "async page => { | ||
| await page.route('**/api/user', async route => { | ||
| const response = await route.fetch(); | ||
| const json = await response.json(); | ||
| json.isPremium = true; | ||
| await route.fulfill({ response, json }); | ||
| }); | ||
| }" | ||
| ``` | ||
|
|
||
| ### Simulate Network Failures | ||
|
|
||
| ```bash | ||
| playwright-cli run-code "async page => { | ||
| await page.route('**/api/offline', route => route.abort('internetdisconnected')); | ||
| }" | ||
| # Options: connectionrefused, timedout, connectionreset, internetdisconnected | ||
| ``` | ||
|
|
||
| ### Delayed Response | ||
|
|
||
| ```bash | ||
| playwright-cli run-code "async page => { | ||
| await page.route('**/api/slow', async route => { | ||
| await new Promise(r => setTimeout(r, 3000)); | ||
| route.fulfill({ body: JSON.stringify({ data: 'loaded' }) }); | ||
| }); | ||
| }" | ||
| ``` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The frontmatter only allows
Bash(playwright-cli:*), but this same skill later tells users to fall back tonpx playwright-cli ...if the global binary is unavailable. In that common scenario, the fallback path is blocked by the skill’s own tool restrictions, so the workflow fails exactly when recovery is needed. Please allow thenpx playwright-cliinvocation (or remove the fallback guidance) so the documented path is executable.Useful? React with 👍 / 👎.