https://github.com/chubkey3/compress

A lightweight CLI tool for compressing image files and converting them to the webp format. Built on top of the imagemin library.
https://github.com/chubkey3/compress

cli compress compression converter image-compression imagemin library minify npm package webp

Last synced: about 8 hours ago
JSON representation

A lightweight CLI tool for compressing image files and converting them to the webp format. Built on top of the imagemin library.

• Host: GitHub
• URL: https://github.com/chubkey3/compress
• Owner: chubkey3
• License: mit
• Created: 2023-07-19T03:37:08.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-07-20T20:29:38.000Z (over 1 year ago)
• Last Synced: 2023-07-20T20:54:20.846Z (over 1 year ago)
• Topics: cli, compress, compression, converter, image-compression, imagemin, library, minify, npm, package, webp
• Language: JavaScript
• Homepage: https://npmjs.com/package/@chubkey/compress
• Size: 124 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Compress

A lightweight CLI tool for compressing image files and converting them to the webp format. Built on top of the imagemin library with added functionality such as preserving folder structure.

## Installation

```npm install -g @chubkey/compress```

## Usage

Once installed, the CLI tool can be used by typing ```compress``` into a terminal.

### Options

The library comes with a couple configuration flags used to direct the tool to your needs. Options should always come before the input/output directory.

Format: ```compress [options]  ```

| Option | Description |

| --- | --- |

| ```--quality=``` | Configures quality of lossy output (default=75) |

| ```--webp``` | Enables webp conversion |

| ```--lossless``` | Use loseless over lossy compression |

## Examples

```compress images compressed_images```

```compress --quality=85 --webp images compressed_images```

```compress --lossless images compressed_images```

## License

This libary uses the [MIT License](https://github.com/chubkey3/compress/blob/master/LICENSE).