Skip to content
pxdiff

Getting Started

Getting Started

Section titled “Getting Started”

Get pixel-level visual diffs for every pull request in under 5 minutes.

Install the CLI

Section titled “Install the CLI”
Terminal window
npm install -g @pxdiff/cli

Authenticate

Section titled “Authenticate”
Terminal window
pxdiff login

This opens your browser to sign in with GitHub. For CI, set PXDIFF_API_KEY instead — see CLI Reference.

Run your first capture

Section titled “Run your first capture”

The fastest way to try pxdiff is to drop a folder of PNGs into pxdiff upload:

Terminal window
pxdiff upload ./screenshots

Snapshot names are derived from filenames. Every PNG in the directory becomes a snapshot in a new capture.

For framework-specific workflows, see the integration guides: Storybook, Ladle, Playwright, Vitest.

View your diffs

Section titled “View your diffs”

Open your pxdiff dashboard to review visual changes side-by-side.