@braid-cloud/cli 0.1.18 → 0.1.20

package/README.md

@@ -194,6 +194,52 @@ braid manage --no-open
 
 This starts the local manager server and opens a browser unless `--no-open` is passed.
 
+## E2E Testing
+
+The CLI has two Playwright E2E modes.
+
+For the default local packaged-binary smoke suite:
+
+```bash
+cd apps/cli
+bun run test:e2e
+```
+
+That run is local-first on purpose:
+
+- it builds and packs the real published CLI binary
+- it covers local user-facing failures and filesystem side effects
+- it does not require the web app, WorkOS, or local Convex to be running
+
+For the full browser-backed auth flow and real web handshake:
+
+```bash
+cd apps/cli
+CLI_E2E_AUTH=1 bun run test:e2e
+```
+
+or the equivalent convenience script:
+
+```bash
+cd apps/cli
+bun run test:e2e:auth
+```
+
+Full auth-backed E2E requires:
+
+- local workspace setup to have written `apps/web/.env.local` and `apps/convex/.env.local`
+- `E2E_TEST_USER_PASSWORD`
+- `WORKOS_API_KEY` or `E2E_WORKOS_API_KEY`
+- a supported local Node version for Convex (`18`, `20`, `22`, or `24`)
+
+If Playwright auto-start hits local watch limits, start the web stack manually first and rerun the auth suite. The CLI Playwright config will reuse an existing server on `PLAYWRIGHT_PORT`.
+
+```bash
+cd apps/convex && bun run dev:convex
+cd apps/web && bun run dev
+cd apps/cli && CLI_E2E_AUTH=1 bun run test:e2e
+```
+
 ### Scaffold a pack repo
 
 ```bash