GETTING STARTED
Everything you need to optimize images automatically in your repositories.
QUICK START
HOW IT WORKS
Automatic Pull Requests
When you push images, ImageWrangler automatically optimizes them and opens a pull request with the compressed versions. The PR shows exactly how much space you'll save.
Lossless by Default
Images are optimized without any quality loss. File sizes shrink while your images remain pixel-perfect. Enable lossy mode for even higher compression when quality trade-offs are acceptable.
SUPPORTED FORMATS
| FORMAT | EXTENSIONS | OPTIMIZATION |
|---|---|---|
| JPEG | .jpg, .jpeg | MozJPEG encoder, lossless or quality-based |
| PNG | .png | Maximum compression, optional palette conversion |
| WebP | .webp | Lossless or lossy with configurable quality |
| GIF | .gif | Lossless optimization |
| SVG | .svg | Removes metadata and unnecessary markup |
| AVIF | .avif | Next-gen format with superior compression |
MANAGING REPOSITORIES
Activating & Deactivating Repos
After installing the GitHub App, go to Settings → Repositories to manage which repos are active. Toggle repos on to enable optimization, or off to pause it. Public repos are always free and unlimited.
Optimize Now
Want to optimize existing images immediately? Click the "Optimize Now" button on any active repository to trigger a full scan. ImageWrangler will find all unoptimized images and create a PR with the results.
Initial Setup
Newly activated repos show an "Awaiting Configuration" badge. Click "Use Defaults" to start immediately with standard settings, or add a config file for custom behavior.
Trigger via Comment
You can also trigger an optimization scan by commenting on any issue or pull request in your repository:
/imagewrangler scanImageWrangler will reply with a confirmation and create a PR with any optimizations found.
CONFIGURATION
Optional Config File
ImageWrangler works out of the box with sensible defaults. For custom behavior, add an .imagewrangler.yml file to your repository root.
Configure which directories to scan, enable lossy compression, set quality levels per format, customize PR behavior, and more.
FEATURES AT A GLANCE
Multi-format support
JPEG, PNG, WebP, GIF, SVG, AVIF
Automatic PRs
Review before merging
Lossless default
No quality degradation
Configurable
YAML config per repo
On-demand scans
Optimize existing images
Comment commands
/imagewrangler scan
Free for public
Unlimited public repos