Skip to content

🐼 CLI client for images compressing using tinypng.com API

License

Notifications You must be signed in to change notification settings

domoritz/tinifier

 
 

Repository files navigation

Logo

CLI tool for images compressing

Release version Project language Build Status Coverage Go Report Image size License

This tool uses tinypng.com API endpoint for compressing your local jpg/png images (it supports parallel jobs):

API key can be passed in environment variable named TINYPNG_API_KEY

Recursive (deep) directories walking is not supported

🔥 Usage example

tinypng.com API key is required. You get own API key by pressing link "login" on service main page.

Compress single image:

$ tinifier -k 'YOUR-API-KEY-GOES-HERE' ./image.png

Compress all png images in some directory and 2 another images:

$ tinifier -k 'YOUR-API-KEY-GOES-HERE' -e png ./images-directory ./image-1.png ./image-2.png

Compress all images in some directory using 20 threads:

$ tinifier -k 'YOUR-API-KEY-GOES-HERE' -e png -e jpg -e PNG,JPG -t 20 ./images-directory

🐳 Using docker

Compress all images in current directory:

$ docker run --rm \
    -v "$(pwd):/rootfs:rw" \
    -w /rootfs \
    tarampampam/tinifier -k 'YOUR-API-KEY-GOES-HERE' .

or

$ docker run --rm \
    -v "$(pwd):/rootfs:rw" \
    -w /rootfs \
    -e 'TINYPNG_API_KEY=YOUR-API-KEY-GOES-HERE' \
    tarampampam/tinifier .

Testing

For application testing we use built-in golang testing feature and docker-ce + docker-compose as develop environment. So, just write into your terminal after repository cloning:

$ make test

Or build binary file:

$ make build

Changes log

Release date Commits since latest release

Changes log can be found here.

Support

Issues Issues

If you will find any package errors, please, make an issue in current repository.

License

This is open-sourced software licensed under the MIT License.

About

🐼 CLI client for images compressing using tinypng.com API

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 93.0%
  • Makefile 5.3%
  • Dockerfile 1.7%