There are lots of great utilities out there to losslessly optimize images, but most people forget to run them. Pullcrusher makes it easy to optimize the images of any GitHub repository, and contribute the optimizations back to the maintainer as a pull request.
Get dependencies for image optimization, on MacOSX, using homebrew:
brew install advancecomp gifsicle jhead jpegoptim jpeg optipng pngcrush pngquant
sudo apt-get install -y advancecomp gifsicle jhead jpegoptim libjpeg-progs optipng pngcrush pngquant
Install it via:
$ gem install pullcrusher
On some setups (default MacOSX) that may need a
Simply do a
pullcrusher [repo_name] using the github style short-name
for a repository, e.g.
Pullcrusher will locate all images, compress them, and then ask you if you want it to automatically fork on github and submit a pull request. Simply type "Y" if you like and you are done!
% pullcrusher waferbaby/usesthis *** Asking GitHub to find us the URI for waferbaby/usesthis *** Cloning firstname.lastname@example.org:waferbaby/usesthis.git to local filesystem *** Finding and processing any candidate files public/images/interviews/chris.ilias.knives.jpg 34415 -> 34204 (211 saved) public/images/interviews/chris.ilias.spoons.jpg 40466 -> 40126 (340 saved) public/images/interviews/julian.bleecker.cameras.jpg 135909 -> 133247 (2662 saved) public/images/interviews/khoi.vinh.home.jpg
public/images/portraits/zed.shaw.jpg 143185 -> 141055 (2130 saved) *** 286 files processed, 136 successfully optimized for total savings of 400438 bytes. Do you want to automatically fork and pull request? [y/N] y *** Git branching and commiting all changed files *** Forking the original repo on github *** Pushing changes to your forked copy of the repo *** Creating a pull request... *** Done! Pull request is at https://github.com/waferbaby/usesthis/pull/5
SSH setup and caveats
We use standard git ssh to push changes to your github account. You'll want to make sure you have SSH keys properly setup.
(Does anyone actually prefer HTTPS with credential caching as github thinks? lmk if this is something we need to add to pullcrusher).
The first time you run pullcrusher, it will ask for your GitHub username
and password to obtain a oAuth token (or possibly just your password, if
it can locate your GitHub username in your git configuration). This is
totally cool and awesome, but if you don't want that token on your hard
drive for any reason, its located at
We use this so we can use the GitHub API to handle forking repositories.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Added some feature')
- Push to the branch (
git push origin my-new-feature)
- Create new Pull Request
I'm trying to learn more about using tests so bonus points if you include a test for your new functionality or fix. (Or, if you just want to write some tests for existing functionality, that's awesome too!)
NOTE: This was one of the first things I ever wrote in Ruby, and I was a much poorer programmer back then! A pull request to clean it up and modernize it would very welcome, but I've moved on to other projects and it isn't worth it for me to do it myself since it currently performs its function.