arrayview 0.19.0__tar.gz → 0.20.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (139) hide show
  1. arrayview-0.20.0/.agents/skills/playwright-cli/SKILL.md +386 -0
  2. arrayview-0.20.0/.agents/skills/playwright-cli/references/element-attributes.md +23 -0
  3. arrayview-0.20.0/.agents/skills/playwright-cli/references/playwright-tests.md +39 -0
  4. arrayview-0.20.0/.agents/skills/playwright-cli/references/request-mocking.md +87 -0
  5. arrayview-0.20.0/.agents/skills/playwright-cli/references/running-code.md +241 -0
  6. arrayview-0.20.0/.agents/skills/playwright-cli/references/session-management.md +225 -0
  7. arrayview-0.20.0/.agents/skills/playwright-cli/references/storage-state.md +275 -0
  8. arrayview-0.20.0/.agents/skills/playwright-cli/references/test-generation.md +134 -0
  9. arrayview-0.20.0/.agents/skills/playwright-cli/references/tracing.md +139 -0
  10. arrayview-0.20.0/.agents/skills/playwright-cli/references/video-recording.md +143 -0
  11. {arrayview-0.19.0 → arrayview-0.20.0}/.agents/skills/visual-bug-fixing/SKILL.md +1 -0
  12. arrayview-0.20.0/.github/copilot-instructions.md +33 -0
  13. arrayview-0.20.0/.mex/AGENTS.md +11 -0
  14. {arrayview-0.19.0 → arrayview-0.20.0}/.mex/ROUTER.md +6 -3
  15. {arrayview-0.19.0 → arrayview-0.20.0}/.mex/SETUP.md +2 -0
  16. {arrayview-0.19.0 → arrayview-0.20.0}/.mex/SYNC.md +3 -0
  17. {arrayview-0.19.0 → arrayview-0.20.0}/.mex/context/architecture.md +11 -7
  18. {arrayview-0.19.0 → arrayview-0.20.0}/.mex/context/conventions.md +2 -1
  19. {arrayview-0.19.0 → arrayview-0.20.0}/.mex/context/decisions.md +9 -1
  20. {arrayview-0.19.0 → arrayview-0.20.0}/.mex/context/frontend.md +20 -9
  21. {arrayview-0.19.0 → arrayview-0.20.0}/.mex/context/project-state.md +11 -3
  22. {arrayview-0.19.0 → arrayview-0.20.0}/.mex/context/render-pipeline.md +2 -1
  23. {arrayview-0.19.0 → arrayview-0.20.0}/.mex/context/setup.md +11 -8
  24. {arrayview-0.19.0 → arrayview-0.20.0}/.mex/context/stack.md +3 -3
  25. {arrayview-0.19.0 → arrayview-0.20.0}/.mex/patterns/INDEX.md +2 -0
  26. {arrayview-0.19.0 → arrayview-0.20.0}/.mex/patterns/README.md +2 -0
  27. {arrayview-0.19.0 → arrayview-0.20.0}/.mex/patterns/add-file-format.md +2 -2
  28. {arrayview-0.19.0 → arrayview-0.20.0}/.mex/patterns/add-server-endpoint.md +13 -11
  29. arrayview-0.20.0/.mex/patterns/animation-verify.md +141 -0
  30. {arrayview-0.19.0 → arrayview-0.20.0}/.mex/patterns/debug-render.md +3 -3
  31. arrayview-0.20.0/.mex/patterns/extract-server-route-module.md +48 -0
  32. {arrayview-0.19.0 → arrayview-0.20.0}/.mex/patterns/frontend-change.md +8 -7
  33. arrayview-0.20.0/.mex/setup.sh +21 -0
  34. arrayview-0.20.0/.mex/sync.sh +9 -0
  35. {arrayview-0.19.0 → arrayview-0.20.0}/AGENTS.md +2 -1
  36. {arrayview-0.19.0 → arrayview-0.20.0}/CONTRIBUTING.md +2 -0
  37. {arrayview-0.19.0 → arrayview-0.20.0}/PKG-INFO +1 -1
  38. {arrayview-0.19.0 → arrayview-0.20.0}/docs/configuration.md +8 -0
  39. {arrayview-0.19.0 → arrayview-0.20.0}/pyproject.toml +1 -1
  40. {arrayview-0.19.0 → arrayview-0.20.0}/src/arrayview/ARCHITECTURE.md +15 -9
  41. arrayview-0.20.0/src/arrayview/__init__.py +26 -0
  42. arrayview-0.20.0/src/arrayview/_analysis.py +260 -0
  43. {arrayview-0.19.0 → arrayview-0.20.0}/src/arrayview/_app.py +7 -5
  44. arrayview-0.20.0/src/arrayview/_diff.py +218 -0
  45. {arrayview-0.19.0 → arrayview-0.20.0}/src/arrayview/_launcher.py +1004 -501
  46. arrayview-0.20.0/src/arrayview/_overlays.py +61 -0
  47. {arrayview-0.19.0 → arrayview-0.20.0}/src/arrayview/_platform.py +84 -6
  48. arrayview-0.20.0/src/arrayview/_routes_analysis.py +470 -0
  49. arrayview-0.20.0/src/arrayview/_routes_export.py +111 -0
  50. arrayview-0.20.0/src/arrayview/_routes_loading.py +374 -0
  51. arrayview-0.20.0/src/arrayview/_routes_persistence.py +477 -0
  52. arrayview-0.20.0/src/arrayview/_routes_preload.py +58 -0
  53. arrayview-0.20.0/src/arrayview/_routes_query.py +128 -0
  54. arrayview-0.20.0/src/arrayview/_routes_rendering.py +506 -0
  55. arrayview-0.20.0/src/arrayview/_routes_segmentation.py +467 -0
  56. arrayview-0.20.0/src/arrayview/_routes_state.py +278 -0
  57. arrayview-0.20.0/src/arrayview/_routes_vectorfield.py +194 -0
  58. arrayview-0.20.0/src/arrayview/_routes_websocket.py +308 -0
  59. arrayview-0.20.0/src/arrayview/_server.py +212 -0
  60. {arrayview-0.19.0 → arrayview-0.20.0}/src/arrayview/_session.py +26 -0
  61. {arrayview-0.19.0 → arrayview-0.20.0}/src/arrayview/_shell.html +39 -15
  62. {arrayview-0.19.0 → arrayview-0.20.0}/src/arrayview/_stdio_server.py +38 -429
  63. arrayview-0.20.0/src/arrayview/_vectorfield.py +231 -0
  64. {arrayview-0.19.0 → arrayview-0.20.0}/src/arrayview/_viewer.html +2380 -1037
  65. {arrayview-0.19.0 → arrayview-0.20.0}/src/arrayview/_vscode.py +3 -4
  66. arrayview-0.20.0/tests/capture_v_animation.py +99 -0
  67. {arrayview-0.19.0 → arrayview-0.20.0}/tests/test_api.py +1529 -7
  68. arrayview-0.20.0/tests/test_backend_shared.py +145 -0
  69. arrayview-0.20.0/tests/test_browser.py +2245 -0
  70. {arrayview-0.19.0 → arrayview-0.20.0}/tests/test_cli.py +135 -7
  71. {arrayview-0.19.0 → arrayview-0.20.0}/tests/test_command_reachability.py +1 -1
  72. {arrayview-0.19.0 → arrayview-0.20.0}/tests/test_config.py +27 -0
  73. {arrayview-0.19.0 → arrayview-0.20.0}/tests/test_large_arrays.py +7 -12
  74. arrayview-0.20.0/tests/v_anim_frames/.gitkeep +1 -0
  75. {arrayview-0.19.0 → arrayview-0.20.0}/tests/visual_smoke.py +34 -23
  76. {arrayview-0.19.0 → arrayview-0.20.0}/uv.lock +1 -1
  77. arrayview-0.19.0/.github/copilot-instructions.md +0 -39
  78. arrayview-0.19.0/.mex/AGENTS.md +0 -9
  79. arrayview-0.19.0/src/arrayview/__init__.py +0 -5
  80. arrayview-0.19.0/src/arrayview/_server.py +0 -4273
  81. arrayview-0.19.0/tests/test_browser.py +0 -1091
  82. {arrayview-0.19.0 → arrayview-0.20.0}/.agents/skills/frontend-designer/SKILL.md +0 -0
  83. {arrayview-0.19.0 → arrayview-0.20.0}/.agents/skills/invocation-consistency/SKILL.md +0 -0
  84. {arrayview-0.19.0 → arrayview-0.20.0}/.agents/skills/modes-consistency/SKILL.md +0 -0
  85. {arrayview-0.19.0 → arrayview-0.20.0}/.agents/skills/todo-workflow/SKILL.md +0 -0
  86. {arrayview-0.19.0 → arrayview-0.20.0}/.agents/skills/ui-consistency-audit/SKILL.md +0 -0
  87. {arrayview-0.19.0 → arrayview-0.20.0}/.agents/skills/viewer-ui-checklist/SKILL.md +0 -0
  88. {arrayview-0.19.0 → arrayview-0.20.0}/.github/workflows/docs.yml +0 -0
  89. {arrayview-0.19.0 → arrayview-0.20.0}/.github/workflows/python-publish.yml +0 -0
  90. {arrayview-0.19.0 → arrayview-0.20.0}/.gitignore +0 -0
  91. {arrayview-0.19.0 → arrayview-0.20.0}/.ignore +0 -0
  92. {arrayview-0.19.0 → arrayview-0.20.0}/.opencode/opencode.json +0 -0
  93. {arrayview-0.19.0 → arrayview-0.20.0}/.python-version +0 -0
  94. {arrayview-0.19.0 → arrayview-0.20.0}/.vscode/settings.json +0 -0
  95. {arrayview-0.19.0 → arrayview-0.20.0}/LICENSE +0 -0
  96. {arrayview-0.19.0 → arrayview-0.20.0}/README.md +0 -0
  97. {arrayview-0.19.0 → arrayview-0.20.0}/docs/comparing.md +0 -0
  98. {arrayview-0.19.0 → arrayview-0.20.0}/docs/display.md +0 -0
  99. {arrayview-0.19.0 → arrayview-0.20.0}/docs/index.md +0 -0
  100. {arrayview-0.19.0 → arrayview-0.20.0}/docs/loading.md +0 -0
  101. {arrayview-0.19.0 → arrayview-0.20.0}/docs/logo.png +0 -0
  102. {arrayview-0.19.0 → arrayview-0.20.0}/docs/measurement.md +0 -0
  103. {arrayview-0.19.0 → arrayview-0.20.0}/docs/remote.md +0 -0
  104. {arrayview-0.19.0 → arrayview-0.20.0}/docs/stylesheets/extra.css +0 -0
  105. {arrayview-0.19.0 → arrayview-0.20.0}/docs/viewing.md +0 -0
  106. {arrayview-0.19.0 → arrayview-0.20.0}/matlab/arrayview.m +0 -0
  107. {arrayview-0.19.0 → arrayview-0.20.0}/mkdocs.yml +0 -0
  108. {arrayview-0.19.0 → arrayview-0.20.0}/plans/2026-04-14-immersive-animation.md +0 -0
  109. {arrayview-0.19.0 → arrayview-0.20.0}/plans/webview/LOG.md +0 -0
  110. {arrayview-0.19.0 → arrayview-0.20.0}/scripts/demo.py +0 -0
  111. {arrayview-0.19.0 → arrayview-0.20.0}/scripts/release.sh +0 -0
  112. {arrayview-0.19.0 → arrayview-0.20.0}/src/arrayview/__main__.py +0 -0
  113. {arrayview-0.19.0 → arrayview-0.20.0}/src/arrayview/_config.py +0 -0
  114. {arrayview-0.19.0 → arrayview-0.20.0}/src/arrayview/_icon.png +0 -0
  115. {arrayview-0.19.0 → arrayview-0.20.0}/src/arrayview/_io.py +0 -0
  116. {arrayview-0.19.0 → arrayview-0.20.0}/src/arrayview/_render.py +0 -0
  117. {arrayview-0.19.0 → arrayview-0.20.0}/src/arrayview/_segmentation.py +0 -0
  118. {arrayview-0.19.0 → arrayview-0.20.0}/src/arrayview/_torch.py +0 -0
  119. {arrayview-0.19.0 → arrayview-0.20.0}/src/arrayview/arrayview-opener.vsix +0 -0
  120. {arrayview-0.19.0 → arrayview-0.20.0}/src/arrayview/gsap.min.js +0 -0
  121. {arrayview-0.19.0 → arrayview-0.20.0}/tests/conftest.py +0 -0
  122. {arrayview-0.19.0 → arrayview-0.20.0}/tests/make_vectorfield_test_arrays.py +0 -0
  123. {arrayview-0.19.0 → arrayview-0.20.0}/tests/test_cross_mode_parametrized.py +0 -0
  124. {arrayview-0.19.0 → arrayview-0.20.0}/tests/test_interactions.py +0 -0
  125. {arrayview-0.19.0 → arrayview-0.20.0}/tests/test_loading_server.py +0 -0
  126. {arrayview-0.19.0 → arrayview-0.20.0}/tests/test_mode_consistency.py +0 -0
  127. {arrayview-0.19.0 → arrayview-0.20.0}/tests/test_mode_entry_batching.py +0 -0
  128. {arrayview-0.19.0 → arrayview-0.20.0}/tests/test_mode_matrix.py +0 -0
  129. {arrayview-0.19.0 → arrayview-0.20.0}/tests/test_mode_roundtrip.py +0 -0
  130. {arrayview-0.19.0 → arrayview-0.20.0}/tests/test_nifti_meta.py +0 -0
  131. {arrayview-0.19.0 → arrayview-0.20.0}/tests/test_rgb_pixel_art.py +0 -0
  132. {arrayview-0.19.0 → arrayview-0.20.0}/tests/test_torch.py +0 -0
  133. {arrayview-0.19.0 → arrayview-0.20.0}/tests/test_view_component_integration.py +0 -0
  134. {arrayview-0.19.0 → arrayview-0.20.0}/tests/test_view_component_unit.py +0 -0
  135. {arrayview-0.19.0 → arrayview-0.20.0}/tests/ui_audit.py +0 -0
  136. {arrayview-0.19.0 → arrayview-0.20.0}/vscode-extension/AGENTS.md +0 -0
  137. {arrayview-0.19.0 → arrayview-0.20.0}/vscode-extension/LICENSE +0 -0
  138. {arrayview-0.19.0 → arrayview-0.20.0}/vscode-extension/extension.js +0 -0
  139. {arrayview-0.19.0 → arrayview-0.20.0}/vscode-extension/package.json +0 -0
@@ -0,0 +1,386 @@
1
+ ---
2
+ name: playwright-cli
3
+ description: Automate browser interactions, test web pages and work with Playwright tests.
4
+ allowed-tools: Bash(playwright-cli:*) Bash(npx:*) Bash(npm:*)
5
+ ---
6
+
7
+ # Browser Automation with playwright-cli
8
+
9
+ ## Quick start
10
+
11
+ ```bash
12
+ # open new browser
13
+ playwright-cli open
14
+ # navigate to a page
15
+ playwright-cli goto https://playwright.dev
16
+ # interact with the page using refs from the snapshot
17
+ playwright-cli click e15
18
+ playwright-cli type "page.click"
19
+ playwright-cli press Enter
20
+ # take a screenshot (rarely used, as snapshot is more common)
21
+ playwright-cli screenshot
22
+ # close the browser
23
+ playwright-cli close
24
+ ```
25
+
26
+ ## Commands
27
+
28
+ ### Core
29
+
30
+ ```bash
31
+ playwright-cli open
32
+ # open and navigate right away
33
+ playwright-cli open https://example.com/
34
+ playwright-cli goto https://playwright.dev
35
+ playwright-cli type "search query"
36
+ playwright-cli click e3
37
+ playwright-cli dblclick e7
38
+ # --submit presses Enter after filling the element
39
+ playwright-cli fill e5 "user@example.com" --submit
40
+ playwright-cli drag e2 e8
41
+ # drop files or data onto an element (from outside the page)
42
+ playwright-cli drop e4 --path=./image.png
43
+ playwright-cli drop e4 --data="text/plain=hello world"
44
+ playwright-cli hover e4
45
+ playwright-cli select e9 "option-value"
46
+ playwright-cli upload ./document.pdf
47
+ playwright-cli check e12
48
+ playwright-cli uncheck e12
49
+ playwright-cli snapshot
50
+ playwright-cli eval "document.title"
51
+ playwright-cli eval "el => el.textContent" e5
52
+ # get element id, class, or any attribute not visible in the snapshot
53
+ playwright-cli eval "el => el.id" e5
54
+ playwright-cli eval "el => el.getAttribute('data-testid')" e5
55
+ playwright-cli dialog-accept
56
+ playwright-cli dialog-accept "confirmation text"
57
+ playwright-cli dialog-dismiss
58
+ playwright-cli resize 1920 1080
59
+ playwright-cli close
60
+ ```
61
+
62
+ ### Navigation
63
+
64
+ ```bash
65
+ playwright-cli go-back
66
+ playwright-cli go-forward
67
+ playwright-cli reload
68
+ ```
69
+
70
+ ### Keyboard
71
+
72
+ ```bash
73
+ playwright-cli press Enter
74
+ playwright-cli press ArrowDown
75
+ playwright-cli keydown Shift
76
+ playwright-cli keyup Shift
77
+ ```
78
+
79
+ ### Mouse
80
+
81
+ ```bash
82
+ playwright-cli mousemove 150 300
83
+ playwright-cli mousedown
84
+ playwright-cli mousedown right
85
+ playwright-cli mouseup
86
+ playwright-cli mouseup right
87
+ playwright-cli mousewheel 0 100
88
+ ```
89
+
90
+ ### Save as
91
+
92
+ ```bash
93
+ playwright-cli screenshot
94
+ playwright-cli screenshot e5
95
+ playwright-cli screenshot --filename=page.png
96
+ playwright-cli pdf --filename=page.pdf
97
+ ```
98
+
99
+ ### Tabs
100
+
101
+ ```bash
102
+ playwright-cli tab-list
103
+ playwright-cli tab-new
104
+ playwright-cli tab-new https://example.com/page
105
+ playwright-cli tab-close
106
+ playwright-cli tab-close 2
107
+ playwright-cli tab-select 0
108
+ ```
109
+
110
+ ### Storage
111
+
112
+ ```bash
113
+ playwright-cli state-save
114
+ playwright-cli state-save auth.json
115
+ playwright-cli state-load auth.json
116
+
117
+ # Cookies
118
+ playwright-cli cookie-list
119
+ playwright-cli cookie-list --domain=example.com
120
+ playwright-cli cookie-get session_id
121
+ playwright-cli cookie-set session_id abc123
122
+ playwright-cli cookie-set session_id abc123 --domain=example.com --httpOnly --secure
123
+ playwright-cli cookie-delete session_id
124
+ playwright-cli cookie-clear
125
+
126
+ # LocalStorage
127
+ playwright-cli localstorage-list
128
+ playwright-cli localstorage-get theme
129
+ playwright-cli localstorage-set theme dark
130
+ playwright-cli localstorage-delete theme
131
+ playwright-cli localstorage-clear
132
+
133
+ # SessionStorage
134
+ playwright-cli sessionstorage-list
135
+ playwright-cli sessionstorage-get step
136
+ playwright-cli sessionstorage-set step 3
137
+ playwright-cli sessionstorage-delete step
138
+ playwright-cli sessionstorage-clear
139
+ ```
140
+
141
+ ### Network
142
+
143
+ ```bash
144
+ playwright-cli route "**/*.jpg" --status=404
145
+ playwright-cli route "https://api.example.com/**" --body='{"mock": true}'
146
+ playwright-cli route-list
147
+ playwright-cli unroute "**/*.jpg"
148
+ playwright-cli unroute
149
+ ```
150
+
151
+ ### DevTools
152
+
153
+ ```bash
154
+ playwright-cli console
155
+ playwright-cli console warning
156
+ playwright-cli network
157
+ playwright-cli run-code "async page => await page.context().grantPermissions(['geolocation'])"
158
+ playwright-cli run-code --filename=script.js
159
+ playwright-cli tracing-start
160
+ playwright-cli tracing-stop
161
+ playwright-cli video-start video.webm
162
+ playwright-cli video-chapter "Chapter Title" --description="Details" --duration=2000
163
+ playwright-cli video-stop
164
+
165
+ # launch the dashboard with annotation prompt to ask the user for input
166
+ playwright-cli show --annotate
167
+
168
+ # generate a Playwright locator for an element from its ref or selector
169
+ playwright-cli generate-locator e5 --raw
170
+
171
+ # show a persistent highlight overlay for an element, optionally with a custom style
172
+ playwright-cli highlight e5
173
+ playwright-cli highlight e5 --style="outline: 3px dashed red"
174
+ # hide a single element highlight, or all page highlights when no target is given
175
+ playwright-cli highlight e5 --hide
176
+ playwright-cli highlight --hide
177
+ ```
178
+
179
+ ## Raw output
180
+
181
+ The global `--raw` option strips page status, generated code, and snapshot sections from the output, returning only the result value. Use it to pipe command output into other tools. Commands that don't produce output return nothing.
182
+
183
+ ```bash
184
+ playwright-cli --raw eval "JSON.stringify(performance.timing)" | jq '.loadEventEnd - .navigationStart'
185
+ playwright-cli --raw eval "JSON.stringify([...document.querySelectorAll('a')].map(a => a.href))" > links.json
186
+ playwright-cli --raw snapshot > before.yml
187
+ playwright-cli click e5
188
+ playwright-cli --raw snapshot > after.yml
189
+ diff before.yml after.yml
190
+ TOKEN=$(playwright-cli --raw cookie-get session_id)
191
+ playwright-cli --raw localstorage-get theme
192
+ ```
193
+
194
+ For structured output wrapping every reply as JSON, pass --json
195
+ ```bash
196
+ playwright-cli list --json
197
+ ```
198
+
199
+ ## Open parameters
200
+ ```bash
201
+ # Use specific browser when creating session
202
+ playwright-cli open --browser=chrome
203
+ playwright-cli open --browser=firefox
204
+ playwright-cli open --browser=webkit
205
+ playwright-cli open --browser=msedge
206
+
207
+ # Use persistent profile (by default profile is in-memory)
208
+ playwright-cli open --persistent
209
+ # Use persistent profile with custom directory
210
+ playwright-cli open --profile=/path/to/profile
211
+
212
+ # Connect to browser via Playwright Extension
213
+ playwright-cli attach --extension=chrome
214
+
215
+ # Connect to a running Chrome or Edge by channel name
216
+ playwright-cli attach --cdp=chrome
217
+ playwright-cli attach --cdp=msedge
218
+
219
+ # Connect to a running browser via CDP endpoint
220
+ playwright-cli attach --cdp=http://localhost:9222
221
+
222
+ # Start with config file
223
+ playwright-cli open --config=my-config.json
224
+
225
+ # Close the browser
226
+ playwright-cli close
227
+ # Detach from an attached browser (leaves the external browser running)
228
+ playwright-cli -s=msedge detach
229
+ # Delete user data for the default session
230
+ playwright-cli delete-data
231
+ ```
232
+
233
+ ## Snapshots
234
+
235
+ After each command, playwright-cli provides a snapshot of the current browser state.
236
+
237
+ ```bash
238
+ > playwright-cli goto https://example.com
239
+ ### Page
240
+ - Page URL: https://example.com/
241
+ - Page Title: Example Domain
242
+ ### Snapshot
243
+ [Snapshot](.playwright-cli/page-2026-02-14T19-22-42-679Z.yml)
244
+ ```
245
+
246
+ You can also take a snapshot on demand using `playwright-cli snapshot` command. All the options below can be combined as needed.
247
+
248
+ ```bash
249
+ # default - save to a file with timestamp-based name
250
+ playwright-cli snapshot
251
+
252
+ # save to file, use when snapshot is a part of the workflow result
253
+ playwright-cli snapshot --filename=after-click.yaml
254
+
255
+ # snapshot an element instead of the whole page
256
+ playwright-cli snapshot "#main"
257
+
258
+ # limit snapshot depth for efficiency, take a partial snapshot afterwards
259
+ playwright-cli snapshot --depth=4
260
+ playwright-cli snapshot e34
261
+
262
+ # include each element's bounding box as [box=x,y,width,height]
263
+ playwright-cli snapshot --boxes
264
+ ```
265
+
266
+ ## Targeting elements
267
+
268
+ By default, use refs from the snapshot to interact with page elements.
269
+
270
+ ```bash
271
+ # get snapshot with refs
272
+ playwright-cli snapshot
273
+
274
+ # interact using a ref
275
+ playwright-cli click e15
276
+ ```
277
+
278
+ You can also use css selectors or Playwright locators.
279
+
280
+ ```bash
281
+ # css selector
282
+ playwright-cli click "#main > button.submit"
283
+
284
+ # role locator
285
+ playwright-cli click "getByRole('button', { name: 'Submit' })"
286
+
287
+ # test id
288
+ playwright-cli click "getByTestId('submit-button')"
289
+ ```
290
+
291
+ ## Browser Sessions
292
+
293
+ ```bash
294
+ # create new browser session named "mysession" with persistent profile
295
+ playwright-cli -s=mysession open example.com --persistent
296
+ # same with manually specified profile directory (use when requested explicitly)
297
+ playwright-cli -s=mysession open example.com --profile=/path/to/profile
298
+ playwright-cli -s=mysession click e6
299
+ playwright-cli -s=mysession close # stop a named browser
300
+ playwright-cli -s=mysession delete-data # delete user data for persistent session
301
+
302
+ playwright-cli list
303
+ # Close all browsers
304
+ playwright-cli close-all
305
+ # Forcefully kill all browser processes
306
+ playwright-cli kill-all
307
+ ```
308
+
309
+ ## Installation
310
+
311
+ If global `playwright-cli` command is not available, try a local version via `npx playwright-cli`:
312
+
313
+ ```bash
314
+ npx --no-install playwright-cli --version
315
+ ```
316
+
317
+ When local version is available, use `npx playwright-cli` in all commands. Otherwise, install `playwright-cli` as a global command:
318
+
319
+ ```bash
320
+ npm install -g @playwright/cli@latest
321
+ ```
322
+
323
+ ## Example: Form submission
324
+
325
+ ```bash
326
+ playwright-cli open https://example.com/form
327
+ playwright-cli snapshot
328
+
329
+ playwright-cli fill e1 "user@example.com"
330
+ playwright-cli fill e2 "password123"
331
+ playwright-cli click e3
332
+ playwright-cli snapshot
333
+ playwright-cli close
334
+ ```
335
+
336
+ ## Example: Multi-tab workflow
337
+
338
+ ```bash
339
+ playwright-cli open https://example.com
340
+ playwright-cli tab-new https://example.com/other
341
+ playwright-cli tab-list
342
+ playwright-cli tab-select 0
343
+ playwright-cli snapshot
344
+ playwright-cli close
345
+ ```
346
+
347
+ ## Example: Debugging with DevTools
348
+
349
+ ```bash
350
+ playwright-cli open https://example.com
351
+ playwright-cli click e4
352
+ playwright-cli fill e7 "test"
353
+ playwright-cli console
354
+ playwright-cli network
355
+ playwright-cli close
356
+ ```
357
+
358
+ ```bash
359
+ playwright-cli open https://example.com
360
+ playwright-cli tracing-start
361
+ playwright-cli click e4
362
+ playwright-cli fill e7 "test"
363
+ playwright-cli tracing-stop
364
+ playwright-cli close
365
+ ```
366
+
367
+ ## Example: Interactive session
368
+
369
+ Ask the user to annotate the UI. User can provide contextual tasks or ask contextual questions using annotations:
370
+
371
+ ```bash
372
+ playwright-cli open https://example.com
373
+ playwright-cli show --annotate
374
+ ```
375
+
376
+ ## Specific tasks
377
+
378
+ * **Running and Debugging Playwright tests** [references/playwright-tests.md](references/playwright-tests.md)
379
+ * **Request mocking** [references/request-mocking.md](references/request-mocking.md)
380
+ * **Running Playwright code** [references/running-code.md](references/running-code.md)
381
+ * **Browser session management** [references/session-management.md](references/session-management.md)
382
+ * **Storage state (cookies, localStorage)** [references/storage-state.md](references/storage-state.md)
383
+ * **Test generation** [references/test-generation.md](references/test-generation.md)
384
+ * **Tracing** [references/tracing.md](references/tracing.md)
385
+ * **Video recording** [references/video-recording.md](references/video-recording.md)
386
+ * **Inspecting element attributes** [references/element-attributes.md](references/element-attributes.md)
@@ -0,0 +1,23 @@
1
+ # Inspecting Element Attributes
2
+
3
+ When the snapshot doesn't show an element's `id`, `class`, `data-*` attributes, or other DOM properties, use `eval` to inspect them.
4
+
5
+ ## Examples
6
+
7
+ ```bash
8
+ playwright-cli snapshot
9
+ # snapshot shows a button as e7 but doesn't reveal its id or data attributes
10
+
11
+ # get the element's id
12
+ playwright-cli eval "el => el.id" e7
13
+
14
+ # get all CSS classes
15
+ playwright-cli eval "el => el.className" e7
16
+
17
+ # get a specific attribute
18
+ playwright-cli eval "el => el.getAttribute('data-testid')" e7
19
+ playwright-cli eval "el => el.getAttribute('aria-label')" e7
20
+
21
+ # get a computed style property
22
+ playwright-cli eval "el => getComputedStyle(el).display" e7
23
+ ```
@@ -0,0 +1,39 @@
1
+ # Running Playwright Tests
2
+
3
+ To run Playwright tests, use the `npx playwright test` command, or a package manager script. To avoid opening the interactive html report, use `PLAYWRIGHT_HTML_OPEN=never` environment variable.
4
+
5
+ ```bash
6
+ # Run all tests
7
+ PLAYWRIGHT_HTML_OPEN=never npx playwright test
8
+
9
+ # Run all tests through a custom npm script
10
+ PLAYWRIGHT_HTML_OPEN=never npm run special-test-command
11
+ ```
12
+
13
+ # Debugging Playwright Tests
14
+
15
+ To debug a failing Playwright test, run it with `--debug=cli` option. This command will pause the test at the start and print the debugging instructions.
16
+
17
+ **IMPORTANT**: run the command in the background and check the output until "Debugging Instructions" is printed.
18
+
19
+ Once instructions containing a session name are printed, use `playwright-cli` to attach the session and explore the page.
20
+
21
+ ```bash
22
+ # Run the test
23
+ PLAYWRIGHT_HTML_OPEN=never npx playwright test --debug=cli
24
+ # ...
25
+ # ... debugging instructions for "tw-abcdef" session ...
26
+ # ...
27
+
28
+ # Attach to the test
29
+ playwright-cli attach tw-abcdef
30
+ ```
31
+
32
+ Keep the test running in the background while you explore and look for a fix.
33
+ The test is paused at the start, so you should step over or pause at a particular location
34
+ where the problem is most likely to be.
35
+
36
+ Every action you perform with `playwright-cli` generates corresponding Playwright TypeScript code.
37
+ This code appears in the output and can be copied directly into the test. Most of the time, a specific locator or an expectation should be updated, but it could also be a bug in the app. Use your judgement.
38
+
39
+ After fixing the test, stop the background test run. Rerun to check that test passes.
@@ -0,0 +1,87 @@
1
+ # Request Mocking
2
+
3
+ Intercept, mock, modify, and block network requests.
4
+
5
+ ## CLI Route Commands
6
+
7
+ ```bash
8
+ # Mock with custom status
9
+ playwright-cli route "**/*.jpg" --status=404
10
+
11
+ # Mock with JSON body
12
+ playwright-cli route "**/api/users" --body='[{"id":1,"name":"Alice"}]' --content-type=application/json
13
+
14
+ # Mock with custom headers
15
+ playwright-cli route "**/api/data" --body='{"ok":true}' --header="X-Custom: value"
16
+
17
+ # Remove headers from requests
18
+ playwright-cli route "**/*" --remove-header=cookie,authorization
19
+
20
+ # List active routes
21
+ playwright-cli route-list
22
+
23
+ # Remove a route or all routes
24
+ playwright-cli unroute "**/*.jpg"
25
+ playwright-cli unroute
26
+ ```
27
+
28
+ ## URL Patterns
29
+
30
+ ```
31
+ **/api/users - Exact path match
32
+ **/api/*/details - Wildcard in path
33
+ **/*.{png,jpg,jpeg} - Match file extensions
34
+ **/search?q=* - Match query parameters
35
+ ```
36
+
37
+ ## Advanced Mocking with run-code
38
+
39
+ For conditional responses, request body inspection, response modification, or delays:
40
+
41
+ ### Conditional Response Based on Request
42
+
43
+ ```bash
44
+ playwright-cli run-code "async page => {
45
+ await page.route('**/api/login', route => {
46
+ const body = route.request().postDataJSON();
47
+ if (body.username === 'admin') {
48
+ route.fulfill({ body: JSON.stringify({ token: 'mock-token' }) });
49
+ } else {
50
+ route.fulfill({ status: 401, body: JSON.stringify({ error: 'Invalid' }) });
51
+ }
52
+ });
53
+ }"
54
+ ```
55
+
56
+ ### Modify Real Response
57
+
58
+ ```bash
59
+ playwright-cli run-code "async page => {
60
+ await page.route('**/api/user', async route => {
61
+ const response = await route.fetch();
62
+ const json = await response.json();
63
+ json.isPremium = true;
64
+ await route.fulfill({ response, json });
65
+ });
66
+ }"
67
+ ```
68
+
69
+ ### Simulate Network Failures
70
+
71
+ ```bash
72
+ playwright-cli run-code "async page => {
73
+ await page.route('**/api/offline', route => route.abort('internetdisconnected'));
74
+ }"
75
+ # Options: connectionrefused, timedout, connectionreset, internetdisconnected
76
+ ```
77
+
78
+ ### Delayed Response
79
+
80
+ ```bash
81
+ playwright-cli run-code "async page => {
82
+ await page.route('**/api/slow', async route => {
83
+ await new Promise(r => setTimeout(r, 3000));
84
+ route.fulfill({ body: JSON.stringify({ data: 'loaded' }) });
85
+ });
86
+ }"
87
+ ```