npmpackage.info

Gathering detailed insights and metrics for odiff-bin-no-output

odiff-bin-no-output - 2.5.3 | npmpackage.info

odiff-bin-no-output

The fastest pixel-by-pixel image visual difference tool in the world.

2.5.3

2,190

MIT

OCaml

3.44 MB

3.6

Installations

npm install odiff-bin-no-output

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

12.22.8

NPM Version

6.14.15 Score

68.9

Supply Chain

99.1

Quality

75.2

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

3

Total

55

Closed

5

Merged

47

Issues

Open

21

Total

64

Closed

43

Releases

v3.2.1

Updated on Feb 14, 2025

v3.2.0

Updated on Nov 22, 2024

v3.1.2

Updated on Oct 02, 2024

v3.1.1

Updated on Aug 27, 2024

v3.1.0

Updated on Aug 26, 2024

v0.3.1-rc.2

Updated on Aug 25, 2024

View All 20 releases

Languages

OCaml

JavaScript

Dune

Shell

TypeScript

OCaml (70.05%)

JavaScript (15.34%)

C (11.11%)

Dune (1.89%)

Shell (1.01%)

TypeScript (0.59%)

Developer

dmtrKovalenko

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

2,190 Stars

250 Commits

87 Forks

17 Watchers

7 Branches

10 Contributors

Updated on Jul 14, 2025

Maintainers

View All 10 Contributors

Package Meta Information

Latest Version

2.5.3

Package Id

odiff-bin-no-output@2.5.3

Unpacked Size

3.44 MB

Size

2.37 MB

File Count

NPM Version

6.14.15

Node Version

12.22.8

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

No dependencies detected.

ODIFF

The fastest* (one-thread) pixel-by-pixel image difference tool in the world.

Why Odiff?

ODiff is a blazing fast native image comparison tool. Check benchmarks for the results, but it compares the visual difference between 2 images in milliseconds. It was originally designed to handle the "big" images. Thanks to OCaml and its speedy and predictable compiler we can significantly speed up your CI pipeline.

Demo

base	comparison	diff

Features

✅ Cross-format comparison - Yes .jpg vs .png comparison without any problems.
✅ Support for .png, .jpeg, .jpg, and .tiff
✅ Supports comparison of images with different layouts.
✅ Anti-aliasing detection
✅ Ignoring regions
✅ Using YIQ NTSC transmission algorithm to determine visual difference.

Coming in the nearest future:

⏹ Reading image from memory buffer
⏹ Reading images from url

Usage

Basic comparison

Run the simple comparison. Image paths can be one of supported formats, diff output can only be .png.

odiff <IMG1 path> <IMG2 path> <DIFF output path>

Node.js

We also provides direct node.js binding for the odiff. Run the odiff from nodejs:

1const { compare } = require("odiff-bin");
2
3const { match, reason } = await compare(
4  "path/to/first/image.png",
5  "path/to/second/image.png",
6  "path/to/diff.png"
7);

Api

Here is an api reference:

CLI

The best way to get up-to-date cli interface is just to type the

odiff --help

Node.js

NodeJS Api is pretty tiny as well. Here is a typescript interface we have:

1export type ODiffOptions = Partial<{
2  /** Color used to highlight different pixels in the output (in hex format e.g. #cd2cc9). */
3  diffColor: string;
4  /** Output full diff image. */
5  outputDiffMask: boolean;
6  /** Do not compare images and produce output if images layout is different. */
7  failOnLayoutDiff: boolean;
8  /** Return { match: false, reason: '...' } instead of throwing error if file is missing. */
9  noFailOnFsErrors: boolean;
10  /** Color difference threshold (from 0 to 1). Less more precise. */
11  threshold: number;
12  /** If this is true, antialiased pixels are not counted to the diff of an image */
13  antialiasing: boolean;
14  /** An array of regions to ignore in the diff. */
15  ignoreRegions: Array<{
16    x1: number;
17    y1: number;
18    x2: number;
19    y2: number;
20  }>;
21}>;
22
23declare function compare(
24  basePath: string,
25  comparePath: string,
26  diffPath: string,
27  options?: ODiffOptions
28): Promise<
29  | { match: true }
30  | { match: false; reason: "layout-diff" }
31  | {
32      match: false;
33      reason: "pixel-diff";
34      /** Amount of different pixels */
35      diffCount: number;
36      /** Percentage of different pixels in the whole image */
37      diffPercentage: number;
38    }
39  | {
40      match: false;
41      reason: "file-not-exists";
42      /** Errored file path */
43      file: string;
44    }
45>;
46
47export { compare };

Compare option will return { match: true } if images are identical. Otherwise return { match: false, reason: "*" } with a reason why images were different.

Make sure that diff output file will be created only if images have pixel difference we can see 👀

Installation

We provide prebuilt binaries for most of the used platforms, there are a few ways to install them:

Cross-platform

The recommended and cross-platform way to install this lib is npm and node.js. Make sure that this package is compiled directly to the platform binary executable, so the npm package contains all binaries and post-install script will automatically link the right one for the current platform.

Important: package name is odiff-bin. But the binary itself is odiff

npm install odiff-bin

Then give it a try 👀

odiff --help

MacOS

⛔️ Doesn't work. Waiting for brew approve ⛔️

brew install odiff

Alpine Linux

apk add odiff

From binaries

Download the binaries for your platform from release page.

Benchmarks

Run the benchmarks by yourself. Instructions of how to run the benchmark is here

benchmark

Performance matters. At least for sort of tasks like visual regression. For example, if you are running 25000 image snapshots per month you can save 20 hours of CI time per month by speeding up comparison time in just 3 seconds per snapshot.

3s * 25000 / 3600 = 20,83333 hours

Here is odiff performance comparison with other popular visual difference solutions. We are going to compare some real-world use cases.

Lets compare 2 screenshots of full-size https://cypress.io page:

Command	Mean [s]	Min [s]	Max [s]	Relative
`pixelmatch www.cypress.io-1.png www.cypress.io.png www.cypress-diff.png`	7.712 ± 0.069	7.664	7.896	6.67 ± 0.03
ImageMagick `compare www.cypress.io-1.png www.cypress.io.png -compose src diff-magick.png`	8.881 ± 0.121	8.692	9.066	7.65 ± 0.04
`odiff www.cypress.io-1.png www.cypress.io.png www.cypress-diff.png`	1.168 ± 0.008	1.157	1.185	1.00

Wow. Odiff is mostly 6 times faster than imagemagick and pixelmatch. And this will be even clearer if image will become larger. Lets compare an 8k image to find a difference with another 8k image:

Command	Mean [s]	Min [s]	Max [s]	Relative
`pixelmatch water-4k.png water-4k-2.png water-diff.png`	10.614 ± 0.162	10.398	10.910	5.50 ± 0.05
Imagemagick `compare water-4k.png water-4k-2.png -compose src water-diff.png`	9.326 ± 0.436	8.819	10.394	5.24 ± 0.10
`odiff water-4k.png water-4k-2.png water-diff.png`	1.951 ± 0.014	1.936	1.981	1.00

Yes it is significant improvement. And the produced difference will be the same for all 3 commands.

Changelog

If you have recently updated, please read the changelog for details of what has changed.

License

The project is licensed under the terms of MIT license

Thanks

This project was highly inspired by pixelmatch and imagemagick.

Support the project

...one day a donation button will appear here. But for now you can follow author's twitter :)

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

9

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

1

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 1

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/dmtrKovalenko/odiff/build.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/dmtrKovalenko/odiff/build.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/dmtrKovalenko/odiff/build.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:82: update your workflow using https://app.stepsecurity.io/secureworkflow/dmtrKovalenko/odiff/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:95: update your workflow using https://app.stepsecurity.io/secureworkflow/dmtrKovalenko/odiff/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:101: update your workflow using https://app.stepsecurity.io/secureworkflow/dmtrKovalenko/odiff/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:123: update your workflow using https://app.stepsecurity.io/secureworkflow/dmtrKovalenko/odiff/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:137: update your workflow using https://app.stepsecurity.io/secureworkflow/dmtrKovalenko/odiff/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:140: update your workflow using https://app.stepsecurity.io/secureworkflow/dmtrKovalenko/odiff/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:147: update your workflow using https://app.stepsecurity.io/secureworkflow/dmtrKovalenko/odiff/build.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:162: update your workflow using https://app.stepsecurity.io/secureworkflow/dmtrKovalenko/odiff/build.yml/main?enable=pin
Warn: npmCommand not pinned by hash: release.sh:25
Warn: chocoCommand not pinned by hash: .github/workflows/build.yml:46
Info: 0 out of 7 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 4 third-party GitHubAction dependencies pinned
Info: 1 out of 2 npmCommand dependencies pinned
Info: 0 out of 1 chocoCommand dependencies pinned

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

SAST

Determines if the project uses static code analysis.

Score

3.6

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More