Skip to content

Latest commit

 

History

History
85 lines (64 loc) · 2.31 KB

README.md

File metadata and controls

85 lines (64 loc) · 2.31 KB
Raw

avif-cli

Command line utility to convert images to AVIF, requires a Node-API v9 compatible runtime:

  • Node.js 18.17.0+
  • Deno
  • Bun

Usage

By default, will search current directory for image files and create AVIF variants.

Exit code is non-zero if one or more errors occurred.

npm

npx avif

pnpm

pnpm dlx avif

Deno

deno run --allow-ffi --allow-read npm:avif

Bun

bun x avif

yarn

yarn dlx avif

Options

Options:
      --input               Input file name(s), supports globs/wildcards
                    [string] [default: "*.{jpg,jpeg,tif,tiff,webp,png,gif,svg}"]
      --output              Output directory, default is same directory as input
                                                          [string] [default: ""]
      --quality             Quality vs file size, 1 (lowest/smallest) to 100
                            (highest/largest)             [number] [default: 50]
      --effort              CPU effort vs file size, 0 (fastest/largest) to 9
                            (slowest/smallest)             [number] [default: 4]
      --lossless            Use lossless compression  [boolean] [default: false]
      --chroma-subsampling  Set to '4:2:0' to use chroma subsampling
                         [string] [choices: "4:2:0", "4:4:4"] [default: "4:4:4"]
      --keep-metadata       Keep all metadata (EXIF, ICC, XMP, IPTC)
                                                      [boolean] [default: false]
      --overwrite           Allow existing output files to be overwritten
                                                      [boolean] [default: false]
      --append-ext          Append .avif to the file name instead of replacing
                            the current extension (foo.jpg => foo.jpg.avif)
                                                      [boolean] [default: false]
      --verbose             Write progress to stdout  [boolean] [default: false]
  -h, --help                Show help                                  [boolean]
      --version             Show version number                        [boolean]

Examples

npx avif --verbose
npx avif --input="**/*.{jpg,jpeg}" --output="/another/path" --overwrite
npx avif --input="images/*.*" --effort=0 --quality=30 --keep-metadata