@blazediff/cli

npm install -g @blazediff/cli

pnpm add -g @blazediff/cli

yarn global add @blazediff/cli

bun add --global @blazediff/cli

npm install --save-dev @blazediff/cli

pnpm add --save-dev @blazediff/cli

yarn add --dev @blazediff/cli

bun add --dev @blazediff/cli

npx blazediff-cli image1.png image2.png diff.png

pnpm dlx blazediff-cli image1.png image2.png diff.png

yarn dlx blazediff-cli image1.png image2.png diff.png

bun x blazediff-cli image1.png image2.png diff.png

# Default command (core-native)
blazediff-cli image1.png image2.png diff.png
 
# Or explicitly
blazediff-cli core-native image1.png image2.png diff.png

blazediff-cli image1.png image2.png diff.png --threshold 0.05 --antialiasing

blazediff-cli core-native <image1> <image2> [output] [options]
 
Options:
  -t, --threshold <n>        Color difference threshold (0-1, default: 0.1)
  -a, --antialiasing         Enable anti-aliasing detection
  --diff-mask                Output only differences (transparent background)
  -c, --compression <n>      PNG compression level (0-9, default: 0)
  -h, --help                 Display help

blazediff-cli image1.png image2.png diff.png
if [ $? -eq 0 ]; then
  echo "Images match!"
else
  echo "Images differ!"
fi

blazediff-cli interpret <image1> <image2> [output] [options]
 
Options:
  --source <name>           How to locate regions: pixel (default), ssim,
                            ms-ssim, hitchhikers-ssim
  -t, --threshold <num>     Color difference threshold (0-1, default: 0.1). pixel only
  -a, --antialiasing        Exclude anti-aliased pixels. pixel only
  -c, --compression <num>   PNG compression level (0-9, default: 0)
  --window-size <num>       Local window size for the metric sources (default: 11)
  --region-floor <num>      Window score at or below which it counts as changed (default: 0.99)
  --regions <json>          Skip the search and classify these boxes instead
  --json                    Print the full result as JSON
  -h, --help                Display help

$ blazediff-cli interpret image1.png image2.png --json
{
  "summary": "Moderate visual change detected (1.87% of image, 4 regions).\n...",
  "severity": "Medium",
  "diffPercentage": 1.87,
  "regions": [...]
}

blazediff-cli core image1.png image2.png

blazediff-cli core image1.png image2.png --output diff.png

blazediff-cli core <image1> <image2> [options]
 
Options:
  -o, --output <path>      Output diff image path
  -t, --threshold <n>      Matching threshold (0-1, default: 0.1)
  -a, --alpha <n>          Opacity of original in diff (0-1, default: 0.1)
  --diff-color <r,g,b>     Color for different pixels (default: 255,0,0)
  --aa-color <r,g,b>       Color for anti-aliased pixels (default: 255,255,0)
  --include-aa             Include anti-aliased pixels in diff count
  --diff-mask              Output diff mask with transparent background
  --codec <name>           Image codec (pngjs, sharp, jsquash-png)
  -h, --help               Display help

blazediff-cli core image1.png image2.png
if [ $? -eq 0 ]; then
  echo "Images match!"
else
  echo "Images differ!"
fi

blazediff-cli gmsd image1.png image2.png

blazediff-cli gmsd image1.png image2.png --output gms-map.png

blazediff-cli gmsd <image1> <image2> [options]
 
Options:
  -o, --output <path>      Output GMS map image path
  --downsample <n>         Downsample factor (0 or 1, default: 0)
  -h, --help              Display help

$ blazediff-cli gmsd reference.png test.png
GMSD: 0.0234
 
$ blazediff-cli gmsd reference.png test.png --output gms-map.png
GMSD: 0.0234
GMS map saved to: gms-map.png

blazediff-cli ssim image1.png image2.png

blazediff-cli ssim image1.png image2.png --output ssim-map.png

blazediff-cli ssim <image1> <image2> [options]
 
Options:
  -o, --output <path>      Output SSIM map image path
  --window-size <n>        Gaussian window size (default: 11)
  --k1 <n>                 Algorithm parameter (default: 0.01)
  --k2 <n>                 Algorithm parameter (default: 0.03)
  -h, --help              Display help

$ blazediff-cli ssim reference.png test.png
SSIM: 0.9876
 
$ blazediff-cli ssim reference.png test.png --output ssim-map.png --window-size 8
SSIM: 0.9823
SSIM map saved to: ssim-map.png

blazediff-cli msssim image1.png image2.png

blazediff-cli msssim image1.png image2.png --output msssim-map.png

blazediff-cli msssim <image1> <image2> [options]
 
Options:
  -o, --output <path>      Output SSIM map at finest scale
  --window-size <n>        Gaussian window size (default: 11)
  --scales <n>             Number of scales (default: 5)
  --method <type>          Aggregation method: product or sum (default: product)
  -h, --help              Display help

$ blazediff-cli msssim reference.png test.png
MS-SSIM: 0.9912

blazediff-cli hitchhikers-ssim image1.png image2.png

blazediff-cli hitchhikers-ssim image1.png image2.png --output ssim-map.png

blazediff-cli hitchhikers-ssim <image1> <image2> [options]
 
Options:
  -o, --output <path>      Output SSIM map image path
  --window-size <n>        Rectangular window size (default: 11)
  --window-stride <n>      Window stride (default: window-size)
  --no-cov-pooling         Disable CoV pooling (use mean pooling)
  --k1 <n>                 Algorithm parameter (default: 0.01)
  --k2 <n>                 Algorithm parameter (default: 0.03)
  -h, --help              Display help

$ blazediff-cli hitchhikers-ssim reference.png test.png
SSIM: 0.9597