Skip to main content

Getting Started

Get up and running with playwright-tui in minutes.

Prerequisites​

Installation​

Clone and build from source​

git clone https://github.com/catesandrew/playwright-tui.git
cd playwright-tui
bun install

Compile to standalone binary​

Build a self-contained executable that you can copy anywhere:

bun run build:exe

The binary will be at ./dist/playwright-tui.

Running​

From the playwright-tui directory​

bun run dev

With Playwright arguments​

Use -- to separate playwright-tui options from Playwright arguments:

bun run dev -- -- --grep @smoke --workers=4

Against a different project​

Point to a directory containing a playwright.config.* file:

bun run dev -- -C ../my-playwright-project -- --project=chromium

Using the wrapper script​

./bin/playwright-tui -- --grep login

Using the compiled binary​

./dist/playwright-tui -- --workers=8

Headless mode​

When stdin or stdout is not a TTY (e.g., in CI), playwright-tui automatically falls back to a compact text-based progress output:

Playwright TUI (headless mode)
Progress 12/48 pass=10 fail=1 flaky=0 skip=1 ETA=1m 23s
...
Done in 2m 14s. pass=46 fail=1 flaky=0 skip=1

What's next?​