Registry / devops / images-minifier

images-minifier

library2.1.0jsnpmunverified

CLI tool to compress image folders or convert them to WebP. Current version 2.1.0, updated sporadically. Copies an input directory, then compresses or converts images to WebP, leaving originals untouched. Supports beautifying output directory structure. Works on whole folders at once, requires Node >=18. Differentiator: simple CLI for batch folder processing, no extra WebP package needed after install.

devops

npm install images-minifier

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · IMAGES-MINIFIER

images-minifier

devopsjavascriptv2.1.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

minifyImages

✓ import { minifyImages } from 'images-minifier'

✗ import minifyImages from 'images-minifier'

Named export; default import is undefined.

minifyImages (CommonJS)

✓ const { minifyImages } = require('images-minifier')

✗ const imagesMinifier = require('images-minifier'); imagesMinifier.minifyImages()

Direct destructure works.

CLI usage

✓ imini <input_dir> <output_dir>

✗ images-minifier <input_dir> <output_dir>

The CLI binary is called 'imini', not the package name.

Install globally, then compress or convert folders via CLI or programmatic API with minifyImages.

// Install globally npm install -g images-minifier // Compress a folder (CLI) imini ./images ./compressed-images // Convert to WebP (CLI) imini --use-webp ./images ./webp-images // Programmatic usage import { minifyImages } from 'images-minifier'; await minifyImages('./images', { webp: true, beautifyDir: true }); console.log('Done');

Debug

Known issues

breakingVersion 2.x removed the old default export; now only named export minifyImages is available.

fix

Use named import: const { minifyImages } = require('images-minifier')

affects: >=2.0.0

gotchaCLI binary is named 'imini', not 'images-minifier' or 'imagemin'.

fix

Run command as: imini <input> <output>

affects: all

deprecatedThe --beautify-dir option may produce unexpected folder structures if input has deeply nested folders.

fix

Test with small folder first; consider manual folder rearrangement.

affects: all

gotchaThe tool copies the input directory first, so output directory must have enough free space for duplicate.

fix

Ensure output disk space is at least double the input size.

affects: all

breakingNode.js >=18 required; older versions will fail to install or run.

fix

Upgrade Node to v18 or later.

affects: >=2.0.0

Errors

Common errors & fixes

Error: Cannot find module 'sharp'

sharp native module failed to install or is missing.

fix

Run 'npm install sharp' or reinstall images-minifier with 'npm install -g images-minifier --build-from-source'

imini: command not found

Package not installed globally or PATH not set.

fix

Install globally: 'npm install -g images-minifier'

TypeError: imagesMinifier.minifyImages is not a function

Using wrong import pattern: importing default instead of named export.

fix

Use: const { minifyImages } = require('images-minifier')

Error: Input directory does not exist

Specified input path is wrong or missing.

fix

Check the input path and ensure it exists: ls <input_dir>

Upgrade

Version history

2.1.0latest on npm

Audit

Dependencies

sharprequiredimage processing (compress, convert to webp)

fs-extrarequiredfilesystem operations (copy, ensure directory)

yargsrequiredCLI argument parsing

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/zhuylanz/images-minifier ↗

packageimages-minifier ↗

homepagehttps://github.com/zhuylanz/images-minifier#readme ↗