NAME

repomatic format-images - Format images with lossless optimization

SYNOPSIS

repomatic format-images [OPTIONS]

DESCRIPTION

Format images by losslessly optimizing them with external CLI tools.

Discovers PNG and JPEG files and compresses them losslessly in-place using oxipng and jpegoptim. Produces a markdown summary table showing before/after sizes and savings.

Only lossless optimizers are used so that results are idempotent: running the command twice produces no further changes.

Required tools:


    oxipng is downloaded and checksum-verified from the pinned tool


    registry, once per run. jpegoptim has to be on $PATH:


    sudo apt-get install jpegoptim

OPTIONS

--min-savings FLOAT RANGE: Minimum percentage savings to keep an optimized file.
--min-savings-bytes INTEGER RANGE: Minimum absolute byte savings to keep an optimized file.
--output FILE: Output file path. Defaults to stdout.
--output-format [markdown|github-actions]: Format for --output. github-actions produces format for PR template consumption in workflows.
--help / -h: Show this message and exit.

ENVIRONMENT

FORMAT_IMAGES_MIN_SAVINGS: Minimum percentage savings to keep an optimized file.
FORMAT_IMAGES_MIN_SAVINGS_BYTES: Minimum absolute byte savings to keep an optimized file.
FORMAT_IMAGES_OUTPUT: Output file path. Defaults to stdout.
FORMAT_IMAGES_OUTPUT_FORMAT: Format for --output. github-actions produces format for PR template consumption in workflows.
FORMAT_IMAGES__CLICK_DEFAULT_HELP: Show this message and exit.

EXIT STATUS

0: Success.
1: A runtime error, or an aborted prompt (Ctrl-C, a declined confirmation).
2: A usage error: unknown option, invalid value, missing operand, or an unparsable configuration file.

EXAMPLES

Format images and print summary

repomatic format\-images

CI: write as a GitHub Actions step output

repomatic format\-images \-\-output "$GITHUB_OUTPUT" \-\-output\-format github\-actions

Use a 10% minimum savings threshold

repomatic format\-images \-\-min\-savings 10

AUTHORS

Kevin Deldycke