@playcraft/cli 0.1.22 → 0.1.24

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 (278) hide show
  1. package/README.md +3 -38
  2. package/dist/agent/local-backend.js +1 -1
  3. package/dist/cli-root-help.js +0 -1
  4. package/dist/commands/build.js +4 -9
  5. package/dist/commands/create.js +33 -26
  6. package/dist/commands/image.js +6 -2
  7. package/dist/commands/login.js +42 -84
  8. package/dist/commands/skills.js +0 -2
  9. package/dist/commands/tools-generation.js +4 -2
  10. package/dist/commands/tools.js +0 -2
  11. package/dist/config.js +4 -59
  12. package/dist/index.js +1 -6
  13. package/dist/remix/clone.js +0 -2
  14. package/dist/remix/init-template.js +0 -2
  15. package/dist/remix/pull.js +0 -2
  16. package/dist/remix/push.js +1 -21
  17. package/dist/utils/agent-api-client.js +29 -148
  18. package/dist/utils/playcraft-http-client.js +4 -6
  19. package/package.json +4 -10
  20. package/project-template/.claude/skills/playcraft-image-generation/SKILL.md +61 -23
  21. package/project-templates/phaser/.claude/skills/playcraft-image-generation/SKILL.md +61 -23
  22. package/project-templates/threejs/.claude/skills/playcraft-image-generation/SKILL.md +61 -23
  23. package/dist/auth/account-activation.js +0 -157
  24. package/dist/auth/messages.js +0 -30
  25. package/dist/commands/platform-skills.generated.js +0 -19
  26. package/dist/commands/tools-batch.js +0 -59
  27. package/dist/commands/workspace-runtime.js +0 -54
  28. package/dist/project-skills/commands.js +0 -72
  29. package/dist/project-skills/lifecycle.js +0 -28
  30. package/dist/project-skills/local-run.js +0 -112
  31. package/dist/project-skills/local-store.js +0 -149
  32. package/dist/project-skills/messages.js +0 -72
  33. package/dist/project-skills/reconcile.js +0 -62
  34. package/dist/project-skills/remote-cache.js +0 -51
  35. package/dist/project-skills/validation.js +0 -19
  36. package/dist/utils/environment-endpoints.js +0 -17
  37. package/dist/utils/tool-operation-journal.js +0 -124
  38. package/dist/workspace-runtime/codex/app-server.js +0 -571
  39. package/dist/workspace-runtime/codex/config-toml.js +0 -108
  40. package/dist/workspace-runtime/codex/jsonrpc-stdio.js +0 -123
  41. package/dist/workspace-runtime/codex/launcher-client.js +0 -163
  42. package/dist/workspace-runtime/codex/loopback.js +0 -143
  43. package/dist/workspace-runtime/codex/model-broker.js +0 -239
  44. package/dist/workspace-runtime/codex/native-adapter.js +0 -9
  45. package/dist/workspace-runtime/main.js +0 -10
  46. package/dist/workspace-runtime/persistence/journal.js +0 -355
  47. package/dist/workspace-runtime/persistence/sqlite-client.js +0 -61
  48. package/dist/workspace-runtime/persistence/sqlite-worker.js +0 -1015
  49. package/dist/workspace-runtime/previews/publish.js +0 -259
  50. package/dist/workspace-runtime/previews/single-file.js +0 -43
  51. package/dist/workspace-runtime/processes/managed-writes.js +0 -69
  52. package/dist/workspace-runtime/production/contracts.js +0 -17
  53. package/dist/workspace-runtime/production/controller.js +0 -207
  54. package/dist/workspace-runtime/production/dependencies.js +0 -60
  55. package/dist/workspace-runtime/production/native.js +0 -70
  56. package/dist/workspace-runtime/production/processes.js +0 -86
  57. package/dist/workspace-runtime/production/save-command.js +0 -20
  58. package/dist/workspace-runtime/production/stages.js +0 -175
  59. package/dist/workspace-runtime/production/storage.js +0 -32
  60. package/dist/workspace-runtime/serve.js +0 -199
  61. package/dist/workspace-runtime/server/auth.js +0 -21
  62. package/dist/workspace-runtime/server/connectivity.js +0 -201
  63. package/dist/workspace-runtime/server/desktop-host.js +0 -429
  64. package/dist/workspace-runtime/server/desktop-preview-config.js +0 -81
  65. package/dist/workspace-runtime/server/desktop-preview-service.js +0 -157
  66. package/dist/workspace-runtime/server/desktop-preview-static.js +0 -53
  67. package/dist/workspace-runtime/server/desktop-preview.js +0 -189
  68. package/dist/workspace-runtime/server/dispatch.js +0 -845
  69. package/dist/workspace-runtime/server/endpoints.js +0 -19
  70. package/dist/workspace-runtime/server/execution-group.js +0 -85
  71. package/dist/workspace-runtime/server/http.js +0 -919
  72. package/dist/workspace-runtime/server/lock.js +0 -53
  73. package/dist/workspace-runtime/server/rfb-watch-gate.js +0 -168
  74. package/dist/workspace-runtime/server/terminal-host.js +0 -294
  75. package/dist/workspace-runtime/server/types.js +0 -1
  76. package/dist/workspace-runtime/workspaces/attachments.js +0 -109
  77. package/dist/workspace-runtime/workspaces/batch-commit.js +0 -142
  78. package/dist/workspace-runtime/workspaces/cli-credentials.js +0 -111
  79. package/dist/workspace-runtime/workspaces/context-error.js +0 -2
  80. package/dist/workspace-runtime/workspaces/dependencies.js +0 -264
  81. package/dist/workspace-runtime/workspaces/developer-command.js +0 -64
  82. package/dist/workspace-runtime/workspaces/directories.js +0 -106
  83. package/dist/workspace-runtime/workspaces/directory-access.js +0 -20
  84. package/dist/workspace-runtime/workspaces/directory-maintenance.js +0 -111
  85. package/dist/workspace-runtime/workspaces/directory-stats.js +0 -49
  86. package/dist/workspace-runtime/workspaces/empty-template.js +0 -32
  87. package/dist/workspace-runtime/workspaces/files.js +0 -113
  88. package/dist/workspace-runtime/workspaces/git-credential-broker.js +0 -312
  89. package/dist/workspace-runtime/workspaces/git-credential-helper.js +0 -68
  90. package/dist/workspace-runtime/workspaces/git-direct-store.js +0 -155
  91. package/dist/workspace-runtime/workspaces/git.js +0 -471
  92. package/dist/workspace-runtime/workspaces/json5-edit.js +0 -170
  93. package/dist/workspace-runtime/workspaces/parameters.js +0 -272
  94. package/dist/workspace-runtime/workspaces/prepare.js +0 -263
  95. package/dist/workspace-runtime/workspaces/registry.js +0 -192
  96. package/dist/workspace-runtime/workspaces/revisions.js +0 -31
  97. package/dist/workspace-runtime/workspaces/skill-artifact-loader.js +0 -46
  98. package/dist/workspace-runtime/workspaces/skills.js +0 -179
  99. package/project-template-v2/.claude/agents/artist.md +0 -82
  100. package/project-template-v2/.claude/agents/developer.md +0 -153
  101. package/project-template-v2/.claude/agents/game-designer.md +0 -264
  102. package/project-template-v2/.claude/agents/refs/artist-art-style-catalog.md +0 -533
  103. package/project-template-v2/.claude/agents/refs/artist-color-audio-recipes.md +0 -153
  104. package/project-template-v2/.claude/agents/refs/artist-dimension-axis.md +0 -27
  105. package/project-template-v2/.claude/agents/refs/artist-master-composite-recipes.md +0 -208
  106. package/project-template-v2/.claude/agents/refs/atom-skill-library.md +0 -81
  107. package/project-template-v2/.claude/agents/refs/developer-impl-cookbook.md +0 -432
  108. package/project-template-v2/.claude/agents/refs/framework-5-component-filter.md +0 -252
  109. package/project-template-v2/.claude/agents/refs/framework-game-feel-juice.md +0 -266
  110. package/project-template-v2/.claude/agents/refs/framework-mda.md +0 -147
  111. package/project-template-v2/.claude/agents/refs/game-designer-gameplay-sufficiency.md +0 -123
  112. package/project-template-v2/.claude/agents/refs/ta-3d-flip-recipe.md +0 -88
  113. package/project-template-v2/.claude/agents/refs/ta-atlas-deliverable-standard.md +0 -67
  114. package/project-template-v2/.claude/agents/refs/ta-batch-pipeline-recipes.md +0 -120
  115. package/project-template-v2/.claude/agents/refs/ta-image-generation-detail.md +0 -300
  116. package/project-template-v2/.claude/agents/refs/ta-image-ops-reference.md +0 -495
  117. package/project-template-v2/.claude/agents/refs/ta-pipeline-cookbook.md +0 -1141
  118. package/project-template-v2/.claude/agents/refs/ta-tools-reference.md +0 -111
  119. package/project-template-v2/.claude/agents/refs/ta-vfx-preset-catalog.md +0 -365
  120. package/project-template-v2/.claude/agents/refs/threejs-cannon-pitfalls.md +0 -412
  121. package/project-template-v2/.claude/agents/reviewer.md +0 -75
  122. package/project-template-v2/.claude/agents/technical-artist.md +0 -86
  123. package/project-template-v2/.claude/hooks/snapshot-milestone.mjs +0 -243
  124. package/project-template-v2/.claude/hooks/user-prompt.mjs +0 -133
  125. package/project-template-v2/.claude/settings.json +0 -33
  126. package/project-template-v2/.claude/skills/brainstorming/SKILL.md +0 -161
  127. package/project-template-v2/.claude/skills/brainstorming/scripts/frame-template.html +0 -270
  128. package/project-template-v2/.claude/skills/brainstorming/scripts/helper.js +0 -177
  129. package/project-template-v2/.claude/skills/brainstorming/scripts/server.cjs +0 -354
  130. package/project-template-v2/.claude/skills/brainstorming/scripts/start-server.sh +0 -148
  131. package/project-template-v2/.claude/skills/brainstorming/scripts/stop-server.sh +0 -56
  132. package/project-template-v2/.claude/skills/brainstorming/scripts/wait-for-selection.sh +0 -62
  133. package/project-template-v2/.claude/skills/brainstorming/spec-document-reviewer-prompt.md +0 -49
  134. package/project-template-v2/.claude/skills/brainstorming/visual-companion.md +0 -309
  135. package/project-template-v2/.claude/skills/playcraft-ad-psychology/SKILL.md +0 -182
  136. package/project-template-v2/.claude/skills/playcraft-art-style-guide/SKILL.md +0 -123
  137. package/project-template-v2/.claude/skills/playcraft-asset-state-sheet/SKILL.md +0 -205
  138. package/project-template-v2/.claude/skills/playcraft-audio-generation/SKILL.md +0 -280
  139. package/project-template-v2/.claude/skills/playcraft-batch-pipeline/SKILL.md +0 -184
  140. package/project-template-v2/.claude/skills/playcraft-build-optimizer/SKILL.md +0 -306
  141. package/project-template-v2/.claude/skills/playcraft-image-generation/SKILL.md +0 -298
  142. package/project-template-v2/.claude/skills/playcraft-image-generation/reference/build-sprite-sheet.template.mjs +0 -123
  143. package/project-template-v2/.claude/skills/playcraft-image-generation/reference/compare-style.template.mjs +0 -254
  144. package/project-template-v2/.claude/skills/playcraft-image-generation/reference/gen-batch-sprite.template.mjs +0 -324
  145. package/project-template-v2/.claude/skills/playcraft-image-generation/reference/gen-batch.template.mjs +0 -97
  146. package/project-template-v2/.claude/skills/playcraft-image-generation/reference/gen-edit-variants.template.mjs +0 -118
  147. package/project-template-v2/.claude/skills/playcraft-image-generation/reference/process-batch.template.mjs +0 -137
  148. package/project-template-v2/.claude/skills/playcraft-image-generation/reference/prompt-cookbook.md +0 -397
  149. package/project-template-v2/.claude/skills/playcraft-image-generation/reference/validate-sprite-sheet.template.mjs +0 -296
  150. package/project-template-v2/.claude/skills/playcraft-image-ops/SKILL.md +0 -122
  151. package/project-template-v2/.claude/skills/playcraft-image-processing/SKILL.md +0 -219
  152. package/project-template-v2/.claude/skills/playcraft-masking/SKILL.md +0 -373
  153. package/project-template-v2/.claude/skills/playcraft-playable-optimization/SKILL.md +0 -161
  154. package/project-template-v2/.claude/skills/playcraft-research/SKILL.md +0 -215
  155. package/project-template-v2/.claude/skills/playcraft-skill-recommender/SKILL.md +0 -382
  156. package/project-template-v2/.claude/skills/playcraft-sprite-generation/SKILL.md +0 -423
  157. package/project-template-v2/.claude/skills/playcraft-sprite-remix/SKILL.md +0 -158
  158. package/project-template-v2/.claude/skills/playcraft-sprite-sheet/SKILL.md +0 -100
  159. package/project-template-v2/.claude/skills/playcraft-storyboard/SKILL.md +0 -167
  160. package/project-template-v2/.claude/skills/playcraft-style-qa/SKILL.md +0 -270
  161. package/project-template-v2/.claude/skills/playcraft-text-rendering/SKILL.md +0 -236
  162. package/project-template-v2/.claude/skills/playcraft-vfx-animation/SKILL.md +0 -130
  163. package/project-template-v2/.claude/skills/playwright-cli/SKILL.md +0 -390
  164. package/project-template-v2/.claude/skills/playwright-cli/references/element-attributes.md +0 -23
  165. package/project-template-v2/.claude/skills/playwright-cli/references/playwright-tests.md +0 -39
  166. package/project-template-v2/.claude/skills/playwright-cli/references/request-mocking.md +0 -87
  167. package/project-template-v2/.claude/skills/playwright-cli/references/running-code.md +0 -240
  168. package/project-template-v2/.claude/skills/playwright-cli/references/session-management.md +0 -226
  169. package/project-template-v2/.claude/skills/playwright-cli/references/spec-driven-testing.md +0 -308
  170. package/project-template-v2/.claude/skills/playwright-cli/references/storage-state.md +0 -275
  171. package/project-template-v2/.claude/skills/playwright-cli/references/test-generation.md +0 -134
  172. package/project-template-v2/.claude/skills/playwright-cli/references/tracing.md +0 -142
  173. package/project-template-v2/.claude/skills/playwright-cli/references/video-recording.md +0 -153
  174. package/project-template-v2/.claude/skills/session-analyzer/SKILL.md +0 -386
  175. package/project-template-v2/.claude/skills/session-analyzer/scripts/execution-breakdown.mjs +0 -182
  176. package/project-template-v2/.claude/skills/session-analyzer/scripts/find-turns.mjs +0 -72
  177. package/project-template-v2/.claude/skills/session-analyzer/scripts/heavy-output.mjs +0 -121
  178. package/project-template-v2/.claude/skills/session-analyzer/scripts/resolve-session.mjs +0 -102
  179. package/project-template-v2/.claude/skills/session-analyzer/scripts/subagent-stats.mjs +0 -127
  180. package/project-template-v2/.claude/skills/session-analyzer/scripts/subagent-tool-timeline.mjs +0 -106
  181. package/project-template-v2/.claude/skills/session-analyzer/scripts/time-gaps.mjs +0 -128
  182. package/project-template-v2/.claude/skills/session-analyzer/scripts/turn-timeline.mjs +0 -67
  183. package/project-template-v2/.claude/snapshot.mjs +0 -263
  184. package/project-template-v2/.playcraft/skills.lock.json +0 -152
  185. package/project-template-v2/CLAUDE.md +0 -146
  186. package/project-template-v2/assets/audio/bgm/.gitkeep +0 -0
  187. package/project-template-v2/assets/audio/sfx/.gitkeep +0 -0
  188. package/project-template-v2/assets/bundles/.gitkeep +0 -0
  189. package/project-template-v2/assets/images/bg/.gitkeep +0 -0
  190. package/project-template-v2/assets/images/reference/.gitkeep +0 -0
  191. package/project-template-v2/assets/images/storyboard/.gitkeep +0 -0
  192. package/project-template-v2/assets/images/tiles/.gitkeep +0 -0
  193. package/project-template-v2/assets/images/ui/.gitkeep +0 -0
  194. package/project-template-v2/assets/images/vfx/.gitkeep +0 -0
  195. package/project-template-v2/assets/models/.gitkeep +0 -0
  196. package/project-template-v2/docs/harness/iteration-1/context-flow.md +0 -254
  197. package/project-template-v2/docs/harness/iteration-1/generate-flow.md +0 -91
  198. package/project-template-v2/docs/harness/iteration-1/ideate-flow.md +0 -214
  199. package/project-template-v2/docs/harness/iteration-1/optimize-flow.md +0 -75
  200. package/project-template-v2/docs/harness/iteration-1/wrapup-flow.md +0 -63
  201. package/project-template-v2/docs/harness/iteration-2/context-flow.md +0 -223
  202. package/project-template-v2/docs/harness/iteration-2/generate-flow.md +0 -129
  203. package/project-template-v2/docs/harness/iteration-2/ideate-flow.md +0 -267
  204. package/project-template-v2/docs/harness/iteration-2/optimize-flow.md +0 -164
  205. package/project-template-v2/docs/harness/iteration-2/wrapup-flow.md +0 -115
  206. package/project-template-v2/docs/harness/orchestrator-flow.md +0 -364
  207. package/project-template-v2/docs/project-state.json +0 -60
  208. package/project-template-v2/docs/project-state.md +0 -72
  209. package/project-template-v2/docs/standards/README.md +0 -225
  210. package/project-template-v2/docs/standards/agent-behavior-standards.md +0 -174
  211. package/project-template-v2/docs/standards/artifacts/design-brief.md +0 -19
  212. package/project-template-v2/docs/standards/artifacts/design.md +0 -22
  213. package/project-template-v2/docs/standards/artifacts/game-code.md +0 -41
  214. package/project-template-v2/docs/standards/artifacts/todo-list.md +0 -41
  215. package/project-template-v2/docs/standards/iter1-agent-behavior-standards.md +0 -343
  216. package/project-template-v2/game/index.ts +0 -18
  217. package/project-template-v2/globals.d.ts +0 -51
  218. package/project-template-v2/index.css +0 -34
  219. package/project-template-v2/index.html +0 -18
  220. package/project-template-v2/main.ts +0 -9
  221. package/project-template-v2/package.json +0 -46
  222. package/project-template-v2/skills/_shared/scripts/dispatch-clear.mjs +0 -31
  223. package/project-template-v2/skills/_shared/scripts/dispatch-set.mjs +0 -86
  224. package/project-template-v2/skills/_shared/scripts/dod-check.mjs +0 -153
  225. package/project-template-v2/skills/_shared/scripts/handoff-append.mjs +0 -70
  226. package/project-template-v2/skills/_shared/scripts/lib/validator-artifacts.mjs +0 -91
  227. package/project-template-v2/skills/_shared/scripts/pipeline/dod-config.mjs +0 -131
  228. package/project-template-v2/skills/_shared/scripts/pipeline/index.mjs +0 -80
  229. package/project-template-v2/skills/_shared/scripts/pipeline/iteration-1-core.mjs +0 -90
  230. package/project-template-v2/skills/_shared/scripts/pipeline/iteration-2-wrap.mjs +0 -93
  231. package/project-template-v2/skills/_shared/scripts/pipeline/iteration-3-visual.mjs +0 -23
  232. package/project-template-v2/skills/_shared/scripts/render-project-state.mjs +0 -230
  233. package/project-template-v2/skills/_shared/scripts/state-advance-stage.mjs +0 -58
  234. package/project-template-v2/skills/_shared/scripts/state-get.mjs +0 -339
  235. package/project-template-v2/skills/_shared/scripts/state-handoff.mjs +0 -39
  236. package/project-template-v2/skills/_shared/scripts/state-set.mjs +0 -94
  237. package/project-template-v2/skills/_shared/scripts/state-store.mjs +0 -783
  238. package/project-template-v2/skills/_shared/scripts/todo-add.mjs +0 -88
  239. package/project-template-v2/skills/_shared/scripts/todo-get.mjs +0 -130
  240. package/project-template-v2/skills/_shared/scripts/todo-remove.mjs +0 -33
  241. package/project-template-v2/skills/_shared/scripts/todo-set.mjs +0 -47
  242. package/project-template-v2/skills/_shared/scripts/verify-asset-code-sync.mjs +0 -268
  243. package/project-template-v2/skills/_shared/scripts/verify-env.mjs +0 -285
  244. package/project-template-v2/skills/_shared/scripts/verify-placeholders.mjs +0 -161
  245. package/project-template-v2/skills/playable-autoplay/SKILL.md +0 -176
  246. package/project-template-v2/skills/playable-autoplay/agents/openai.yaml +0 -4
  247. package/project-template-v2/skills/playable-debug/SKILL.md +0 -116
  248. package/project-template-v2/skills/playable-debug/agents/openai.yaml +0 -4
  249. package/project-template-v2/skills/playable-debug/references/debug-config.md +0 -40
  250. package/project-template-v2/skills/playable-record/SKILL.md +0 -140
  251. package/project-template-v2/skills/playable-record/scripts/lib/dev-server.mjs +0 -104
  252. package/project-template-v2/skills/playable-record/scripts/lib/record-audio-bridge.js +0 -141
  253. package/project-template-v2/skills/playable-record/scripts/record-playable.mjs +0 -425
  254. package/project-template-v2/skills/playable-record/scripts/verify-contract.mjs +0 -261
  255. package/project-template-v2/skills/playable-record/scripts/verify-firstwin.mjs +0 -398
  256. package/project-template-v2/skills/playable-record/scripts/verify-fusion.mjs +0 -322
  257. package/project-template-v2/skills/playable-record/scripts/verify-lifecycle.mjs +0 -105
  258. package/project-template-v2/skills/playable-record/scripts/verify-vlm-video.mjs +0 -230
  259. package/project-template-v2/skills/playable-validate/SKILL.md +0 -61
  260. package/project-template-v2/skills/playable-validate/validation-rules.md +0 -14
  261. package/project-template-v2/skills/playable-verify-ui/SKILL.md +0 -63
  262. package/project-template-v2/skills/playable-verify-ui/scripts/lib/__init__.py +0 -1
  263. package/project-template-v2/skills/playable-verify-ui/scripts/lib/config_expr.js +0 -218
  264. package/project-template-v2/skills/playable-verify-ui/scripts/lib/node_utils.js +0 -51
  265. package/project-template-v2/skills/playable-verify-ui/scripts/lib/profile_loader.py +0 -59
  266. package/project-template-v2/skills/playable-verify-ui/scripts/lib/report.py +0 -106
  267. package/project-template-v2/skills/playable-verify-ui/scripts/lib/runtime_contract.js +0 -116
  268. package/project-template-v2/skills/playable-verify-ui/scripts/verify_fetch_antipatterns.py +0 -59
  269. package/project-template-v2/skills/playable-verify-ui/scripts/verify_hardcoded_layout.js +0 -64
  270. package/project-template-v2/skills/playable-verify-ui/scripts/verify_runtime_contract.js +0 -58
  271. package/project-template-v2/skills/playable-verify-ui/scripts/verify_text_overlap.py +0 -333
  272. package/project-template-v2/ta-workspace/scripts/.gitkeep +0 -0
  273. package/project-template-v2/tsconfig.json +0 -20
  274. package/project-template-v2/vite.config.ts +0 -27
  275. package/project-templates/batch-locks/phaser.yaml +0 -922
  276. package/project-templates/batch-locks/threejs.yaml +0 -978
  277. package/project-templates/empty/AGENTS.md +0 -23
  278. package/project-templates/empty/gitignore +0 -31
@@ -1,134 +0,0 @@
1
- # Test Generation
2
-
3
- Generate Playwright test code automatically as you interact with the browser.
4
-
5
- ## How It Works
6
-
7
- Every action you perform with `playwright-cli` generates corresponding Playwright TypeScript code.
8
- This code appears in the output and can be copied directly into your test files.
9
-
10
- ## Example Workflow
11
-
12
- ```bash
13
- # Start a session
14
- playwright-cli open https://example.com/login
15
-
16
- # Take a snapshot to see elements
17
- playwright-cli snapshot
18
- # Output shows: e1 [textbox "Email"], e2 [textbox "Password"], e3 [button "Sign In"]
19
-
20
- # Fill form fields - generates code automatically
21
- playwright-cli fill e1 "user@example.com"
22
- # Ran Playwright code:
23
- # await page.getByRole('textbox', { name: 'Email' }).fill('user@example.com');
24
-
25
- playwright-cli fill e2 "password123"
26
- # Ran Playwright code:
27
- # await page.getByRole('textbox', { name: 'Password' }).fill('password123');
28
-
29
- playwright-cli click e3
30
- # Ran Playwright code:
31
- # await page.getByRole('button', { name: 'Sign In' }).click();
32
- ```
33
-
34
- ## Building a Test File
35
-
36
- Collect the generated code into a Playwright test:
37
-
38
- ```typescript
39
- import { test, expect } from '@playwright/test';
40
-
41
- test('login flow', async ({ page }) => {
42
- // Generated code from playwright-cli session:
43
- await page.goto('https://example.com/login');
44
- await page.getByRole('textbox', { name: 'Email' }).fill('user@example.com');
45
- await page.getByRole('textbox', { name: 'Password' }).fill('password123');
46
- await page.getByRole('button', { name: 'Sign In' }).click();
47
-
48
- // Add assertions
49
- await expect(page).toHaveURL(/.*dashboard/);
50
- });
51
- ```
52
-
53
- ## Best Practices
54
-
55
- ### 1. Use Semantic Locators
56
-
57
- The generated code uses role-based locators when possible, which are more resilient:
58
-
59
- ```typescript
60
- // Generated (good - semantic)
61
- await page.getByRole('button', { name: 'Submit' }).click();
62
-
63
- // Avoid (fragile - CSS selectors)
64
- await page.locator('#submit-btn').click();
65
- ```
66
-
67
- ### 2. Explore Before Recording
68
-
69
- Take snapshots to understand the page structure before recording actions:
70
-
71
- ```bash
72
- playwright-cli open https://example.com
73
- playwright-cli snapshot
74
- # Review the element structure
75
- playwright-cli click e5
76
- ```
77
-
78
- ### 3. Add Assertions Manually
79
-
80
- Generated code captures actions but not assertions. Add expectations in your test using one of the recommended matchers:
81
-
82
- - `toBeVisible()` — element is rendered and visible
83
- - `toHaveText(text)` — element text content matches
84
- - `toHaveValue(value) / toBeEmpty()` — input/select value matches
85
- - `toBeChecked() / toBeUnchecked()` — checkbox state matches
86
- - `toMatchAriaSnapshot(snapshot)` — page (or locator) matches a partial accessibility snapshot
87
-
88
- Use `playwright-cli generate-locator <target>` to produce the locator expression for the assertion, and the snapshot/eval commands to capture the expected value.
89
-
90
- 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.
91
-
92
- 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.
93
-
94
- ```bash
95
- # Get a stable locator for an element ref to use in the assertion
96
- playwright-cli --raw generate-locator e5
97
- # getByRole('button', { name: 'Submit' })
98
-
99
- # Capture expected text content for toHaveText
100
- playwright-cli --raw eval "el => el.textContent" e5
101
-
102
- # Capture expected input value for toHaveValue/toBeEmpty
103
- playwright-cli --raw eval "el => el.value" e5
104
-
105
- # Capture expected aria snapshot for toMatchAriaSnapshot/toBeChecked
106
- # (whole page, or use a ref to scope to a region)
107
- playwright-cli --raw snapshot
108
- playwright-cli --raw snapshot e5
109
- ```
110
-
111
- ```typescript
112
- // Generated action
113
- await page.getByRole('button', { name: 'Submit' }).click();
114
-
115
- // Manual assertions using the outputs above:
116
- await expect(page.getByRole('alert', { name: 'Success' })).toBeVisible();
117
- await expect(page.getByTestId('main-header')).toHaveText('Welcome, user');
118
- await expect(page.getByRole('textbox', { name: 'Email' })).toHaveValue('user@example.com');
119
- await expect(page.getByRole('checkbox', { name: 'Enable notifications' })).toBeChecked();
120
-
121
- // toMatchAriaSnapshot on the whole page, finds a matching region
122
- await expect(page).toMatchAriaSnapshot(`
123
- - heading "Welcome, user"
124
- - link /\\d+ new messages?/
125
- - button "Sign out"
126
- `);
127
-
128
- // toMatchAriaSnapshot scoped to a region
129
- await expect(page.getByRole('navigation')).toMatchAriaSnapshot(`
130
- - link "Home"
131
- - link /\\d+ new messages?/
132
- - link "Profile"
133
- `);
134
- ```
@@ -1,142 +0,0 @@
1
- # Tracing
2
-
3
- Capture detailed execution traces for debugging and analysis. Traces include DOM snapshots, screenshots, network activity, and console logs.
4
-
5
- ## Basic Usage
6
-
7
- ```bash
8
- # Start trace recording
9
- playwright-cli tracing-start
10
-
11
- # Perform actions
12
- playwright-cli open https://example.com
13
- playwright-cli click e1
14
- playwright-cli fill e2 "test"
15
-
16
- # Stop trace recording
17
- playwright-cli tracing-stop
18
- ```
19
-
20
- ## Trace Output Files
21
-
22
- When you start tracing, Playwright creates a `traces/` directory with several files:
23
-
24
- ### `trace-{timestamp}.trace`
25
-
26
- **Action log** - The main trace file containing:
27
-
28
- - Every action performed (clicks, fills, navigations)
29
- - DOM snapshots before and after each action
30
- - Screenshots at each step
31
- - Timing information
32
- - Console messages
33
- - Source locations
34
-
35
- ### `trace-{timestamp}.network`
36
-
37
- **Network log** - Complete network activity:
38
-
39
- - All HTTP requests and responses
40
- - Request headers and bodies
41
- - Response headers and bodies
42
- - Timing (DNS, connect, TLS, TTFB, download)
43
- - Resource sizes
44
- - Failed requests and errors
45
-
46
- ### `resources/`
47
-
48
- **Resources directory** - Cached resources:
49
-
50
- - Images, fonts, stylesheets, scripts
51
- - Response bodies for replay
52
- - Assets needed to reconstruct page state
53
-
54
- ## What Traces Capture
55
-
56
- | Category | Details |
57
- | --------------- | -------------------------------------------------- |
58
- | **Actions** | Clicks, fills, hovers, keyboard input, navigations |
59
- | **DOM** | Full DOM snapshot before/after each action |
60
- | **Screenshots** | Visual state at each step |
61
- | **Network** | All requests, responses, headers, bodies, timing |
62
- | **Console** | All console.log, warn, error messages |
63
- | **Timing** | Precise timing for each operation |
64
-
65
- ## Use Cases
66
-
67
- ### Debugging Failed Actions
68
-
69
- ```bash
70
- playwright-cli tracing-start
71
- playwright-cli open https://app.example.com
72
-
73
- # This click fails - why?
74
- playwright-cli click e5
75
-
76
- playwright-cli tracing-stop
77
- # Open trace to see DOM state when click was attempted
78
- ```
79
-
80
- ### Analyzing Performance
81
-
82
- ```bash
83
- playwright-cli tracing-start
84
- playwright-cli open https://slow-site.com
85
- playwright-cli tracing-stop
86
-
87
- # View network waterfall to identify slow resources
88
- ```
89
-
90
- ### Capturing Evidence
91
-
92
- ```bash
93
- # Record a complete user flow for documentation
94
- playwright-cli tracing-start
95
-
96
- playwright-cli open https://app.example.com/checkout
97
- playwright-cli fill e1 "4111111111111111"
98
- playwright-cli fill e2 "12/25"
99
- playwright-cli fill e3 "123"
100
- playwright-cli click e4
101
-
102
- playwright-cli tracing-stop
103
- # Trace shows exact sequence of events
104
- ```
105
-
106
- ## Trace vs Video vs Screenshot
107
-
108
- | Feature | Trace | Video | Screenshot |
109
- | ----------------------- | ----------- | ----------- | ---------------- |
110
- | **Format** | .trace file | .webm video | .png/.jpeg image |
111
- | **DOM inspection** | Yes | No | No |
112
- | **Network details** | Yes | No | No |
113
- | **Step-by-step replay** | Yes | Continuous | Single frame |
114
- | **File size** | Medium | Large | Small |
115
- | **Best for** | Debugging | Demos | Quick capture |
116
-
117
- ## Best Practices
118
-
119
- ### 1. Start Tracing Before the Problem
120
-
121
- ```bash
122
- # Trace the entire flow, not just the failing step
123
- playwright-cli tracing-start
124
- playwright-cli open https://example.com
125
- # ... all steps leading to the issue ...
126
- playwright-cli tracing-stop
127
- ```
128
-
129
- ### 2. Clean Up Old Traces
130
-
131
- Traces can consume significant disk space:
132
-
133
- ```bash
134
- # Remove traces older than 7 days
135
- find .playwright-cli/traces -mtime +7 -delete
136
- ```
137
-
138
- ## Limitations
139
-
140
- - Traces add overhead to automation
141
- - Large traces can consume significant disk space
142
- - Some dynamic content may not replay perfectly
@@ -1,153 +0,0 @@
1
- # Video Recording
2
-
3
- Capture browser automation sessions as video for debugging, documentation, or verification. Produces WebM (VP8/VP9 codec).
4
-
5
- ## Basic Recording
6
-
7
- ```bash
8
- # Open browser first
9
- playwright-cli open
10
-
11
- # Start recording
12
- playwright-cli video-start demo.webm
13
-
14
- # Add a chapter marker for section transitions
15
- playwright-cli video-chapter "Getting Started" --description="Opening the homepage" --duration=2000
16
-
17
- # Navigate and perform actions
18
- playwright-cli goto https://example.com
19
- playwright-cli snapshot
20
- playwright-cli click e1
21
-
22
- # Add another chapter
23
- playwright-cli video-chapter "Filling Form" --description="Entering test data" --duration=2000
24
- playwright-cli fill e2 "test input"
25
-
26
- # Stop and save
27
- playwright-cli video-stop
28
- ```
29
-
30
- ## Best Practices
31
-
32
- ### 1. Use Descriptive Filenames
33
-
34
- ```bash
35
- # Include context in filename
36
- playwright-cli video-start recordings/login-flow-2024-01-15.webm
37
- playwright-cli video-start recordings/checkout-test-run-42.webm
38
- ```
39
-
40
- ### 2. Record entire hero scripts.
41
-
42
- When recording a video for the user or as a proof of work, it is best to create a code snippet and execute it with run-code.
43
- It allows pulling appropriate pauses between the actions and annotating the video. There are new Playwright APIs for that.
44
-
45
- 1. Perform scenario using CLI and take note of all locators and actions. You'll need those locators to request their bounding boxes for highlight.
46
- 2. Create a file with the intended script for video (below). Use pressSequentially w/ delay for nice typing, make reasonable pauses.
47
- 3. Use playwright-cli run-code --filename your-script.js
48
-
49
- **Important**: Overlays are `pointer-events: none` — they do not interfere with page interactions. You can safely keep sticky overlays visible while clicking, filling, or performing any actions on the page.
50
-
51
- ```js
52
- async (page) => {
53
- await page.screencast.start({
54
- path: 'video.webm',
55
- size: { width: 1280, height: 800 },
56
- });
57
- await page.goto('https://demo.playwright.dev/todomvc');
58
-
59
- // Show a chapter card — blurs the page and shows a dialog.
60
- // Blocks until duration expires, then auto-removes.
61
- // Use this for simple use cases, but always feel free to hand-craft your own beautiful
62
- // overlay via await page.screencast.showOverlay().
63
- await page.screencast.showChapter('Adding Todo Items', {
64
- description: 'We will add several items to the todo list.',
65
- duration: 2000,
66
- });
67
-
68
- // Perform action
69
- await page
70
- .getByRole('textbox', { name: 'What needs to be done?' })
71
- .pressSequentially('Walk the dog', { delay: 60 });
72
- await page.getByRole('textbox', { name: 'What needs to be done?' }).press('Enter');
73
- await page.waitForTimeout(1000);
74
-
75
- // Show next chapter
76
- await page.screencast.showChapter('Verifying Results', {
77
- description: 'Checking the item appeared in the list.',
78
- duration: 2000,
79
- });
80
-
81
- // Add a sticky annotation that stays while you perform actions.
82
- // Overlays are pointer-events: none, so they won't block clicks.
83
- const annotation = await page.screencast.showOverlay(`
84
- <div style="position: absolute; top: 8px; right: 8px;
85
- padding: 6px 12px; background: rgba(0,0,0,0.7);
86
- border-radius: 8px; font-size: 13px; color: white;">
87
- ✓ Item added successfully
88
- </div>
89
- `);
90
-
91
- // Perform more actions while the annotation is visible
92
- await page
93
- .getByRole('textbox', { name: 'What needs to be done?' })
94
- .pressSequentially('Buy groceries', { delay: 60 });
95
- await page.getByRole('textbox', { name: 'What needs to be done?' }).press('Enter');
96
- await page.waitForTimeout(1500);
97
-
98
- // Remove the annotation when done
99
- await annotation.dispose();
100
-
101
- // You can also highlight relevant locators and provide contextual annotations.
102
- const bounds = await page.getByText('Walk the dog').boundingBox();
103
- await page.screencast.showOverlay(
104
- `
105
- <div style="position: absolute;
106
- top: ${bounds.y}px;
107
- left: ${bounds.x}px;
108
- width: ${bounds.width}px;
109
- height: ${bounds.height}px;
110
- border: 1px solid red;">
111
- </div>
112
- <div style="position: absolute;
113
- top: ${bounds.y + bounds.height + 5}px;
114
- left: ${bounds.x + bounds.width / 2}px;
115
- transform: translateX(-50%);
116
- padding: 6px;
117
- background: #808080;
118
- border-radius: 10px;
119
- font-size: 14px;
120
- color: white;">Check it out, it is right above this text
121
- </div>
122
- `,
123
- { duration: 2000 },
124
- );
125
-
126
- await page.screencast.stop();
127
- };
128
- ```
129
-
130
- Embrace creativity, overlays are powerful.
131
-
132
- ### Overlay API Summary
133
-
134
- | Method | Use Case |
135
- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
136
- | `page.screencast.showChapter(title, { description?, duration?, styleSheet? })` | Full-screen chapter card with blurred backdrop — ideal for section transitions |
137
- | `page.screencast.showOverlay(html, { duration? })` | Custom HTML overlay — use for callouts, labels, highlights |
138
- | `disposable.dispose()` | Remove a sticky overlay added without duration |
139
- | `page.screencast.hideOverlays()` / `page.screencast.showOverlays()` | Temporarily hide/show all overlays |
140
-
141
- ## Tracing vs Video
142
-
143
- | Feature | Video | Tracing |
144
- | -------- | -------------------- | ---------------------------------------- |
145
- | Output | WebM file | Trace file (viewable in Trace Viewer) |
146
- | Shows | Visual recording | DOM snapshots, network, console, actions |
147
- | Use case | Demos, documentation | Debugging, analysis |
148
- | Size | Larger | Smaller |
149
-
150
- ## Limitations
151
-
152
- - Recording adds slight overhead to automation
153
- - Large recordings can consume significant disk space