$ img-ssim

CLI Tool for comparing images using the SSIM algorithm.

:cloud: Installation

You can install the package globally and use it as command line tool:

# Using npm
npm install --global img-ssim-cli

# Using yarn
yarn global add img-ssim-cli

Then, run img-ssim --help and see what the CLI tool can do.

$ img-ssim --help
Usage: img-ssim <first_image> <second_image> [options]

CLI Tool for comparing images using the SSIM algorithm.

Command arguments:
  <first_image>   The first image source.
  <second_image>  The second image source.

Options:
  -r, --resize <resize>                Whether to resize the images to be the same size.
                                       Default: not enabled (meaning, the images should
                                       have the same number of pixels)
  -n, --no-size-check <no-size-check>  Whether to bypass the size check and comparing the
                                       images which do *not* have identic sizes. Not
                                       enabled by default.
  -s, --window-size <window-size>      The images are divided in regions of 8 x 8 pixels,
                                       by default. Use this option to provide a different
                                       size of the square.
  -v, --version                        Displays version information.
  -h, --help                           Displays this help.

Documentation can be found at https://github.com/IonicaBizau/img-ssim-cli#readme.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:scroll: License

MIT © Ionică Bizău