UNPKG

webimgo

Version:

Batch image resizing and optimisation CLI tool

github.com/shaan07/webimgo

shaan07/webimgo

121 lines (70 loc) • 3.29 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# WebIMGo Batch image resizing and optimisation CLI tool. This is CLI tool is helpful for anyone who wants to quickly resize and optimise images in batch within a directory and its subdirectories. It will replace those images with optimised ones. <br/> --- ## Prerequisites You should have Nodejs v7.6 or greater running on your system. Install if you already haven't. Use a <a href="https://docs.npmjs.com/downloading-and-installing-node-js-and-npm" target="_blank">Node Version Manager</a> to install Nodejs and NPM on your system. - (Recommended) OR You can use <a href="https://nodejs.org/" target="_blank">Nodejs installer</a> --- ## Installing Installing this CLI tool simple and straightforward using NPM. Install it as global. ``` sudo npm i webimgo -g ``` Enter system password if prompted <br/> If any permission issues on global install, you may try the below code ``` sudo npm i webimgo -g --unsafe-perm flag ``` <br/> ## Usage To optimise all images in a folder, simply point your terminal to that folder and type command `webimgo` then press 'Enter' key. This will compress all JPG/PNG images within that folder as well as its sub folders. ``` webimgo ``` To resize width along with optimising images in a folder and its subfolder, simply type below command passing `<width>` parameter. ``` webimgo -w <width> ``` Replace `<width>` width with the amount of maximum width in pixels allowed. ![Webimgo default coommand](./assets/webimgo-base.gif) ### Examples E.g. To resize images width to 1200 pixels for all images with width more than 1200 pixels and to compress all images, use: ``` webimgo -w 1200 ``` This will resize images width to 1200 pixels for all images with width more than 1200 pixels and compress all images. ![Webimgo width coommand](./assets/webimgo-width.gif) <br/> ## Updating To update this NPM package, run below command. ``` npm update -g webimgo ``` <br/> --- #### Built Using * [Nodejs](https://nodejs.org/) - Javascript runtime * [Sharp](https://www.npmjs.com/package/sharp) - Used to resize images * [imagemin](https://www.npmjs.com/package/imagemin) - Used to compress images * [imagemin-mozjpeg](https://www.npmjs.com/package/imagemin-mozjpeg) - Used for compressing JPGs * [imagemin-pngquant](https://www.npmjs.com/package/imagemin-pngquant) - Used for compressing PNGs * [Yargs](https://www.npmjs.com/package/yargs) - Used as command line parser * [image-size](https://www.npmjs.com/package/image-size) - Used for reading image dimensions * [Chalk](https://www.npmjs.com/package/chalk) - stylising the terminal #### Versioning We use [GIT](https://git-scm.com/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). #### Authors * **Sharun John** - [Github Profile](https://github.com/shaan07) - [Facebook](https://www.facebook.com/sharunjon) - [LinkdedIn](https://nz.linkedin.com/in/sharun-john) See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project. #### License This project is licensed under the MIT License - see the [LICENSE.txt](LICENSE.txt) file for details. ### Acknowledgments * Hats off to all package developers and contributers for those amazing works.