@blazediff/core-native

type BlazeDiffResult =
  | { match: true; interpretation?: InterpretResult }
  | { match: false; reason: "layout-diff" }
  | { match: false; reason: "pixel-diff"; diffCount: number; diffPercentage: number; interpretation?: InterpretResult }
  | { match: false; reason: "file-not-exists"; file: string };

import { compare } from '@blazediff/core-native';
 
const result = await compare('expected.png', 'actual.png', 'diff.png', {
  threshold: 0.1,
  antialiasing: true,
});
 
if (result.match) {
  console.log('Images are identical!');
} else if (result.reason === 'pixel-diff') {
  console.log(`${result.diffCount} pixels differ (${result.diffPercentage.toFixed(2)}%)`);
} else if (result.reason === 'layout-diff') {
  console.log('Images have different dimensions');
}

import { readFile } from "node:fs/promises";
import { compare } from "@blazediff/core-native";
 
const [expected, actual] = await Promise.all([
  readFile("expected.png"),
  readFile("actual.png"),
]);
 
// Reuse these same Buffer objects across comparisons without a JS-to-Rust copy.
const result = await compare(expected, actual, "diff.png");

# Compare two PNG images
npx blazediff expected.png actual.png diff.png
 
# Compare two JPEG images
npx blazediff expected.jpg actual.jpg diff.jpg
 
# Compare two QOI images
npx blazediff expected.qoi actual.qoi diff.qoi
 
# Mixed formats (PNG input, QOI output - recommended for smallest diff files)
npx blazediff expected.png actual.png diff.qoi
 
# With options
npx blazediff expected.png actual.png diff.png --threshold 0.05 --antialiasing
 
# With higher PNG compression (smaller output file, slower)
npx blazediff expected.png actual.png diff.png -c 6
 
# With JPEG quality setting
npx blazediff expected.jpg actual.jpg diff.jpg -q 85
 
# Output as text format
npx blazediff expected.png actual.png diff.png --output-format text

blazediff [OPTIONS] <IMAGE1> <IMAGE2> [OUTPUT]
 
Arguments:
  <IMAGE1>  First image path (PNG, JPEG, or QOI)
  <IMAGE2>  Second image path (PNG, JPEG, or QOI)
  [OUTPUT]  Output diff image path (optional, format detected from extension)
 
Options:
  -t, --threshold <THRESHOLD>  Color difference threshold (0.0-1.0) [default: 0.1]
  -a, --antialiasing           Enable anti-aliasing detection
      --diff-mask              Output only differences (transparent background)
      --diff-color-alt <R,G,B> Alternative RGB color for darkening differences
  -c, --compression <LEVEL>    PNG compression level (0-9, 0=fastest, 9=smallest) [default: 0]
  -q, --quality <QUALITY>      JPEG quality (1-100) [default: 90]
      --interpret              Run structured interpretation after diff
      --output-format <FORMAT> Output format (json or text) [default: json]
  -h, --help                   Print help
  -V, --version                Print version

import { compare, interpret } from '@blazediff/core-native';
 
const result = await interpret('expected.png', 'actual.png');
console.log(result.summary);
// "Moderate visual change detected (1.87% of image, 10 regions).
//  Content changed: 4 regions (bottom, center).
//  Content added: 3 regions (right, bottom, bottom-left)."
 
// Via compare()
const diff = await compare('expected.png', 'actual.png', 'diff.png', {
  interpret: true,
});

npx blazediff expected.png actual.png --interpret
npx blazediff expected.png actual.png report.html --output-format html