Command line interface for pixelpact-core: extract a visual contract from a live page or
a Figma file, then measure or diff an implementation against it.
pnpm add -D pixelpact playwright
pnpm exec playwright install chromiumplaywright is a peer dependency, so the browser download stays under your control. Node
22.12 or newer is required.
Extracts a visual contract and writes it to disk. <source> is either a live page url or
a figma.com file url; the right extractor is picked automatically, there is no separate
subcommand.
| Flag | Description |
|---|---|
--out <path> |
Where to write the contract JSON. Default pixelpact.contract.json. |
--selector <css> |
Restrict extraction to this CSS selector. Default: the whole page. Http source only. |
--viewport <list> |
Comma separated viewport names (desktop, tablet, mobile) or WIDTHxHEIGHT pairs. Repeatable. Http source only. |
--max-elements <n> |
Maximum number of elements to walk. 0 means unbounded. |
--max-states <n> |
Maximum number of interactive elements to probe for hover/focus. Http source only. |
--mask <css> |
CSS selector to mask out of the contract. Repeatable. |
--screenshots <dir> |
Directory to write per-viewport screenshots to. |
--wait <ms> |
Extra settle time after navigation. Http source only. |
--timeout <ms> |
Navigation timeout. Http source only. |
--headful |
Show the browser window instead of running headless. Http source only. |
--channel <name> |
Browser channel, e.g. chrome. Http source only. |
--locale <tag> |
Browser locale, e.g. en-US. |
--timezone <tz> |
Browser timezone, e.g. UTC. |
--no-stealth |
Disable stealth mode. Http source only. |
--no-dismiss |
Do not dismiss cookie banners and other overlays. Http source only. |
--no-freeze |
Do not freeze CSS animations before extracting. Http source only. |
--no-full-page |
Capture only the viewport instead of the full scrollable page. Http source only. |
--figma-token <token> |
Figma personal access token. Default $FIGMA_TOKEN. Figma source only. |
--node <id> |
Overrides the node id in the url. Figma source only. |
--scale <n> |
PNG scale for the downloaded reference image. Default 1. Figma source only. |
--json |
Print the contract as JSON to stdout instead of a summary. |
--quiet |
Suppress progress output on stderr. |
Passing a flag that does not apply to the source you gave (a browser flag with a Figma
url, or a Figma flag with an http url) is a usage error, exit code 2, naming the flags
that were rejected, rather than silently doing nothing.
A contract extracted from a live page matches an implementation by CSS selector. A Figma
layer has no selector, so a Figma sourced contract matches through data-contract
attributes instead: write data-contract="Hero/CTA" on the element that implements the
Figma layer named Hero/CTA. Anything without a matching attribute is reported as
missing, never guessed from tag names.
export FIGMA_TOKEN=your-personal-access-token
pixelpact extract "https://www.figma.com/design/abc123/Site?node-id=1-23" --out figma.contract.json
pixelpact check figma.contract.json https://staging.example.comMeasures a live implementation against a contract and reports deviations.
| Flag | Description |
|---|---|
--viewport <name> |
Viewport to check. Default: the first one in the contract. |
--selector <css> |
Root selector to check. Default: the contract root. |
--tolerance <px> |
Pixel tolerance for box and length values. Default 1. |
--out <path> |
Also write the report JSON to this path. |
--max-states <n> |
Maximum number of interactive elements to probe. Default 120. |
--wait <ms>, --timeout <ms>, --headful, --channel <name>, --locale <tag>, --timezone <tz>, --no-stealth, --no-dismiss |
Same as extract. |
--json |
Print the report as JSON to stdout instead of a summary. |
--quiet |
Suppress progress output on stderr. |
Pixel compares screenshots for an implementation against a contract's reference images.
| Flag | Description |
|---|---|
--viewport <name> |
Viewport to diff. Default: the first one in the contract. |
--selector <css> |
Root selector to diff. Default: the contract root. |
--threshold <pct> |
Allowed percent of differing pixels. Default 0.5. |
--out-dir <dir> |
Directory to write the diff images to. Default: the OS temp dir. |
--mask <css> |
CSS selector to mask out. Repeatable. |
--wait <ms>, --timeout <ms>, --headful, --channel <name>, --locale <tag>, --timezone <tz>, --no-stealth, --no-dismiss |
Same as extract. |
--json |
Print the report as JSON to stdout instead of a summary. |
--quiet |
Suppress progress output on stderr. |
Splits the reference page and the target page into sections, puts each pair side by side,
boxes the differing pixels in red and gives every section its own verdict. This is the
command to run before telling anyone a page is finished; a passing check and diff do
not show where a page is still wrong, this does.
| Flag | Description |
|---|---|
--widths <list> |
Comma separated list of viewport widths. Default 1440,390. |
--sections <css> |
Root selector whose direct children become sections. Default: main, falling back to body. |
--only <n|slug> |
Restrict the comparison to a single section, by index or by slug. |
--threshold <pct> |
Allowed percent of differing pixels per section. Default 0.5. |
--out-dir <dir> |
Directory to write the composed images to. Default .pixelpact/side. |
--mask <css> |
CSS selector to mask out. Repeatable. |
--column-width <px> |
Width in pixels of each half of the composed image. Default 900. |
--wait <ms>, --timeout <ms>, --headful, --channel <name>, --locale <tag>, --timezone <tz>, --no-stealth, --no-dismiss, --no-freeze |
Same as extract. |
--json |
Print the report as JSON to stdout instead of a summary. |
--quiet |
Suppress progress output on stderr. |
When a section is outside its threshold, the summary ends with the directory the composed images were written to, since the images are the reason to run this command.
| Code | Meaning |
|---|---|
0 |
Success, no deviations. Every side section is inside its threshold. |
1 |
Deviations found, the pixel threshold was exceeded, or a side section was outside its budget or unmatched. |
2 |
Usage error: bad flags or a missing file. |
3 |
Runtime failure: browser unavailable, navigation failed, the page blocked access, or a Figma request failed. |
Progress is written to stderr so stdout stays pipeable. Human readable summaries are
written to stdout by default; pass --json on any command to print the raw contract or
report as JSON instead. Color is used only when stdout is a TTY and NO_COLOR is unset;
set FORCE_COLOR to override either way.
pixelpact extract https://example.com --out example.contract.json
pixelpact check example.contract.json https://staging.example.com --tolerance 2
pixelpact extract "https://www.figma.com/design/abc123/Site?node-id=1-23" --out figma.contract.json
pixelpact check figma.contract.json https://staging.example.com
pixelpact side https://reference.example https://staging.example.com --out-dir .pixelpact/side