Squoosh!

Squoosh is an image compression web app that reduces image sizes through numerous formats.

API & CLI

Squoosh has an API and a CLI to compress many images at once.

Privacy

Squoosh does not send your image to a server. All image compression processes locally.

However, Squoosh utilizes Google Analytics to collect the following:

• Basic visitor data.
• The before and after image size value.
• If Squoosh PWA, the type of Squoosh installation.
• If Squoosh PWA, the installation time and date.

Developing

To develop for Squoosh:

1. Clone the repository
2. To install node packages, run:

   npm install

3. Then build the app by running:

   npm run build

4. After building, start the development server by running:

   npm run dev

Releasing (Maintainers)

To release new versions of the Squoosh packages to npm, run the automated release script:

npm run release -- patch  # for bug fixes (0.0.x)
npm run release -- minor  # for new features (0.x.0)
npm run release -- major  # for breaking changes (x.0.0)

This will automatically bump package versions, synchronize lockfiles, and tag the release. Afterward, run git push origin dev --tags to trigger the GitHub Actions workflow, which securely publishes the packages using npm Trusted Publishing.

Contributing

Squoosh is an open-source project that appreciates all community involvement. To contribute to the project, follow the contribute guide.