Installation

imgsqz requires Node.js 18 or newer. Check your version first:

node --version
# v18.0.0 or higher

Global install (recommended)

A global install puts the imgsqz command on your PATH so you can run it from anywhere.

npm install -g @wdalhaj/imgsqz

pnpm add -g @wdalhaj/imgsqz

yarn global add @wdalhaj/imgsqz

bun add -g @wdalhaj/imgsqz

Verify the install:

imgsqz --version
# 1.0.1

imgsqz --help

For a one-off, or in CI, skip the install entirely:

npx @wdalhaj/imgsqz photo.png -f webp -q 70

npx downloads the package, runs it, and caches it. Great for trying imgsqz or pinning a version in a script:

npx @wdalhaj/imgsqz@1.0.1 photo.png

If you want imgsqz pinned in a repo (for a reproducible optimization script):

npm install --save-dev @wdalhaj/imgsqz

pnpm add -D @wdalhaj/imgsqz

yarn add -D @wdalhaj/imgsqz

bun add -d @wdalhaj/imgsqz

Then call it from an npm script in package.json:

{
  "scripts": {
    "optimize": "imgsqz public/img/*.png -f webp -q 75"
  }
}

npm run optimize

npm update -g @wdalhaj/imgsqz

pnpm update -g @wdalhaj/imgsqz

yarn global upgrade @wdalhaj/imgsqz

bun update -g @wdalhaj/imgsqz

npm uninstall -g @wdalhaj/imgsqz

Installed? Continue to the Quick start.