docs: add steps for using Playwright GUI tools

cal-itp · Feb 5, 2025 · 42d81f8 · 42d81f8
1 parent 9e0af40
commit 42d81f8
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/docs/tests/automated-tests.md b/docs/tests/automated-tests.md
@@ -109,3 +109,21 @@ In `tests/playwright/pytest.ini`, add `--headed` to `addopts`, and run all tests
 ```bash
 docker compose run --rm playwright
 ```
+
+#### Use Playwright GUI tools
+
+Start a bash session inside the `playwright` container:
+
+```bash
+docker compose run --rm playwright /bin/bash
+```
+
+From here, you can use the `playwright` CLI and any of the GUI tools it provides. Run `playwright --help` to see different commands you can run.
+
+For example, to launch a Chrome window with a Playwright Inspector attached to it, run:
+
+```bash
+playwright cr
+```
+
+![Screenshot showing a Chrome window with Playwright Inspector attached to it](img/playwright-inspector.png)
diff --git a/docs/tests/img/playwright-inspector.png b/docs/tests/img/playwright-inspector.png