$ img-ssim

[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations]    

> CLI Tool for comparing images using the SSIM algorithm.

:cloud: Installation

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

``sh


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 [options]

CLI Tool for comparing images using the SSIM algorithm.

Command arguments:
The first image source.
The second image source.

Options:
-s, --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.
-n, --no-size-check Whether to bypass the size check and comparing the
images which do not have identic sizes. Not
enabled by default.
-r, --resize Whether to resize the images to be the same size.
Default: not enabled (meaning, the images should
have the same number of pixels)
-h, --help Displays this help.
-v, --version Displays version information.

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

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can use Codementor. :rocket:




:yum: How to contribute

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

: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:
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [![Support me on Patreon][badge_patreon]][patreon]—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][license] © [Ionică Bizău][website]

[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW