@pixellpeep/client

Framework-agnostic SDK for PixellPeep visual regression.

Install

npm install @pixellpeep/client

Quick start

import { createPixellPeep } from '@pixellpeep/client';

const pp = createPixellPeep({
  apiUrl: process.env.PIXELLPEEP_API,
  apiKey: process.env.PIXELLPEEP_API_KEY,
  projectId: process.env.PIXELLPEEP_PROJECT_ID,
  baselineMode: 'local', // or 'cloud'
  snapshotsDir: '__snapshots__',
});

await pp.snapshot({
  name: 'login-page',
  image: Buffer.from(await page.screenshot()),
});

Environment variables

| Variable | Description | |----------|-------------| | PIXELLPEEP_API | API base URL | | PIXELLPEEP_API_KEY | API key from Settings | | PIXELLPEEP_PROJECT_ID | Project ID | | PIXELLPEEP_APP_URL | Optional dashboard URL for diff links |

CI metadata (buildId, branch, commitSha) is auto-filled from GITHUB_* when present.

Baseline modes

• local — stores baselines under __snapshots__/{name}.png in your repo
• cloud — uses named baselines via GET/POST /api/projects/{id}/baselines/{name}

Set updateBaseline: true to refresh baselines (local write or cloud seed).