butteraugli-cli
| Crates.io | butteraugli-cli |
| lib.rs | butteraugli-cli |
| version | 0.4.0 |
| created_at | 2025-12-29 11:54:19.338852+00 |
| updated_at | 2026-01-08 10:20:17.199546+00 |
| description | Command-line tool for butteraugli perceptual image quality comparison |
| homepage | https://github.com/imazen/butteraugli |
| repository | https://github.com/imazen/butteraugli |
| max_upload_size | |
| id | 2010494 |
| size | 55,135 |
Lilith River (lilith)
documentation
README
butteraugli-cli
Command-line tool for computing butteraugli perceptual image quality scores.
Installation
cargo install butteraugli-cli
Or download pre-built binaries from GitHub Releases.
Usage
# Compare two images
butteraugli original.png compressed.jpg
# Show quality rating with colors
butteraugli -q original.png compressed.jpg
# CI mode - exit code 1 if score exceeds threshold
butteraugli --max-score 1.5 original.png compressed.jpg
# Compare all images in two directories
butteraugli --batch dir1/ dir2/
# Output JSON for scripting
butteraugli --json original.png compressed.jpg
# Save difference heatmap
butteraugli --diffmap diff.png original.png compressed.jpg
Score Interpretation
| Score | Quality | Description |
|---|---|---|
| 0.0 - 0.5 | Excellent | Imperceptible difference |
| 0.5 - 1.0 | Good | Barely noticeable |
| 1.0 - 2.0 | Acceptable | Noticeable but acceptable |
| 2.0 - 3.0 | Poor | Clearly visible difference |
| 3.0+ | Bad | Large, obvious difference |
Exit Codes
0- Success (score within threshold if--max-scorespecified)1- Score exceeded threshold2- Error (file not found, invalid image, etc.)
Library
For programmatic use, see the butteraugli library crate.
License
BSD-3-Clause