Install

Node 20 or newer.

npm i -D shotlist playwright

Playwright is an optional peer dependency, and shotlist does not install it. Its postinstall downloads browsers, and a project that only depends on shotlist should not pay for that on every install. When it is missing, shotlist prints the command that fixes it.

A first recipe

--init writes a commented shotlist.config.yaml and a first recipe to edit. Neither is overwritten, so it is safe to run in a project that already has some.

npx shotlist --init

Start the site the config points at, then shoot it:

npx shotlist example

The image lands in screenshots/out/, and --install copies it to the destination the recipe names.

The recipe file carries a yaml-language-server line, so an editor completes and validates the keys from the JSON Schemas the package ships.