An open API service indexing awesome lists of open source software.

https://github.com/lovell/avif-cli

Command line utility to convert images to AVIF
https://github.com/lovell/avif-cli

avif avif-encoder cli

Last synced: 6 months ago
JSON representation

Command line utility to convert images to AVIF

Awesome Lists containing this project

README

          

# 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

```sh
npx avif
```

### pnpm

```sh
pnpm dlx avif
```

### Deno

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

### Bun

```sh
bun x avif
```

### yarn

```sh
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

```sh
npx avif --verbose
```

```sh
npx avif --input="**/*.{jpg,jpeg}" --output="/another/path" --overwrite
```

```sh
npx avif --input="images/*.*" --effort=0 --quality=30 --keep-metadata
```