Documentation

Installation

Requirements

  • Node.js 18 or later
  • npm

Chromium is downloaded separately after install — it’s not bundled in the npm package.

Install globally so the snapwright command is available system-wide. This is required if you want to use snapwright with AI agents like Claude Code.

npm install -g @meldocio/snapwright
snapwright install-browsers

snapwright install-browsers downloads Chromium using the exact Playwright version that comes with snapwright. This avoids version mismatches.

Verify the install:

snapwright help

Local install (per project)

npm install @meldocio/snapwright
npx snapwright install-browsers

Run via npx or the local binary:

npx snapwright start
./node_modules/.bin/snapwright start

Installing Claude Code skills

If you plan to use snapwright with Claude Code, install the built-in skills after the global install:

snapwright install-skills

Then restart Claude Code. See Using with AI Agents for the full setup.

Updating

npm update -g @meldocio/snapwright
snapwright install-browsers

Run install-browsers again after updating — Playwright may have bumped the Chromium version.