Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dchakro/optimoze
allows you to encode your PNG and JPEG files with MOZjpeg
https://github.com/dchakro/optimoze
Last synced: 11 days ago
JSON representation
allows you to encode your PNG and JPEG files with MOZjpeg
- Host: GitHub
- URL: https://github.com/dchakro/optimoze
- Owner: dchakro
- License: mit
- Created: 2021-04-04T19:05:08.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-02T18:29:49.000Z (4 months ago)
- Last Synced: 2024-10-25T21:11:06.413Z (about 2 months ago)
- Language: Shell
- Homepage:
- Size: 53.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# optiMOZe - a shell script to encode with mozjpeg
### What is optiMOZe ?
I got the idea to write `optiMOZe`, which is a shell script to automatically compress random JPEG and PNGs lying around my mac (like screenshots, image exports for powerpoint etc.) after I tried [MOZjpeg](https://github.com/mozilla/mozjpeg) on google's [squoosh app](https://squoosh.app) to compress some images for [my blog](https://blog.dchakro.com). I was blown away by the compression ratio and looking at the images side by side. Try `optiMOZe` for yourself, I'll let the images on your computer do the talking.
P.S. the name optiMOZe is a play on the word optimise: *optimise -> optimize -> optimoze*.
### Dependencies:
`optiMOZe` is basically a wrapper around two very well built pieces of software: [imagemagick](https://github.com/ImageMagick/ImageMagick) & [MOZjpeg](https://github.com/mozilla/mozjpeg). You can get these on a mac from homebrew.
**Tip**: `brew` doesn't maintain a log of its activity so if you want to keep a log, check out my simple tool [`brewlog`](https://github.com/dchakro/brewlog), which allows you to run a `brew` command of your choice while writing the output to a local log file.
To install these dependencies on other platforms follow instructions in their repos or official websites.
### How to use:
Prepare your machine to run optiMOZe by installing dependencies:
```sh
# Note: If you do not have homebrew you can get it from https://brew.sh
# Install dependencies
brew install imagemagick mozjpeg
# Symlink mozjpeg (see point #1 in caveats listed below)
# Replace "4.0.3" in the path below with the vesion number of mozjpeg on your system.
ln -s /usr/local/Cellar/mozjpeg/4.0.3/bin/cjpeg /usr/local/bin/mozcjpeg
ln -s /usr/local/Cellar/mozjpeg/4.0.3/bin/jpegtran /usr/local/bin/mozjpegtran
```
Now you're ready to get optiMOZe running on your machine. Here's how to do it:
```sh
# Get optiMOZe source
curl -OJL 'https://github.com/dchakro/optiMOZe/raw/main/optiMOZe.sh'
# Make optiMOZe executable
chmod +x optiMOZe.sh
# Symlink optiMOZe
ln -s $(pwd)/optiMOZe.sh /usr/local/bin/optiMOZe
```
Just navigate to the folder where you want to encode images using mozjpeg and run `optiMOZe` (optiMOZe must be in your system path, otherwise use full path to optiMOZe).
+ The first line shows (reminds you) the status of autoremove.
+ OFF = original file backed up as `moz.bak.`.
+ ON = original file will be removed automatically.
+ Ask = optiMOZe will ask you for confirmation for removing each file. Allows granular control.
+ Run `optiMOZe --help` to display the CLI args to use to control autoremove status.
### Caveats:
1. On a mac `MOZjpeg` is installed via [`homebrew`]((https://brew.sh)) but not symlinked to prevent conflicts with the standard `libjpeg`. So it is recommended to symlink cjpeg from MOZjpeg with a different name. I use `mozcjpeg` on my machines, which is the name used in the shell script. If you use a different name, just use Find-Replace or [sd](https://github.com/chmln/sd) on the shell script.
### Example of compression:
I took a screenshot while writing this readme and was able to compress it with optiMOZe down to 13% of its original size.
### Tips