Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/massivdash/sharpmachine
SharpMachine is a global CLI module, based on sharp image engine for batch image optimization and resizing
https://github.com/massivdash/sharpmachine
Last synced: 1 day ago
JSON representation
SharpMachine is a global CLI module, based on sharp image engine for batch image optimization and resizing
- Host: GitHub
- URL: https://github.com/massivdash/sharpmachine
- Owner: MassivDash
- Created: 2019-11-24T12:17:30.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T22:40:33.000Z (over 1 year ago)
- Last Synced: 2024-10-13T11:48:49.642Z (about 1 month ago)
- Language: TypeScript
- Size: 649 KB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Sharp Machine
Sharp Machine is an image optimizing program cli meant to be installed globally. After execution Sharp Machine will scan for images and optimize them according to config set up via interactive cli.
You can resize, crop and force format and edit whole sharp module config (will open your fav editor) via cli command.
Uses sharp npm module as base for image manipulation.
## Installation
```sh
npm i -g sharpmachine
```
## Run sharp machine
Navigate to a folder with images and run
```sh
sharpmachine
```
|_|
Welcome to sharp machine
1. Either type folder name, or type "." for current folder (required)
2. Enter output folder (required)
## Commands
If selected folder contains images (png, jpg, gif, webp), you can :
1. Optimize images with default config; Images will optimized with 80 quality, unless specified via cli, the images will not be resized.
2. Optimize images to webp format with default config; Images will optimized with 80 quality, unless specified via cli, the images will not be resized.
For both options cli will ask for resizing options, if specified yes, cli will demand width (number: required), height (number: leave empty to keep the aspect ration) and image quality (0 - 100)
3. Custom Config; custom config option will open your favorite text editor, where global sharp image config resides:
```
{
"quality":90,
"rotate":false,
"trim":false,
"jpegQuality":90,
"pngQuality":90,
"webpQuality":90,
"jpegProgressive":true,
"cropFocus":"left top",
"width":false,
"height":false,
"pngCompressionLevel":9,
"pngCompressionSpeed":4,
"toFormat":"",
"useMozJpeg":false
}
```
edit, save and quit
Configuration options and types can be found at: https://sharp.pixelplumbing.com/en/stable/api-operation/
4. Show Stats (yes/no) Shows simple statistics on executed files. (Slower)
5. Add watermark to images, cli will ask for watermark addition, in order to make this work put watermark.png into input folder. Sharpmachine will add the watermark image in the bottom right corner, please note that watermark should be smaller than the pictures you are optimizing
## Contribution
All requests are more than welcome
## ToDo
* Select files from the list
* Improve progress bars
* Improve verbose statistics
## License:
Type: ISC
Author: Lukasz Celitan, "Spaceghost", https://spaceout.pl, [email protected]