# quick-resize

> Resize images directly from your command line

Latest version **2.0.0** (published 2020-02-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install quick-resize
pnpm add quick-resize
yarn add quick-resize
bun add quick-resize
```

Provides the command `quick-resize`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2020-02-11 |
| First published | 2019-01-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 14.7 KB |
| Known vulnerabilities | 0 (+4 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Thomas Blom |
| Maintainers | thomasblom |
| Keywords | resize, images, icons |

## Links

- npm: https://www.npmjs.com/package/quick-resize
- Repository: https://github.com/thomasblom/quick-resize
- Issues: https://github.com/thomasblom/quick-resize/issues
- npm.io page: https://npm.io/package/quick-resize

## Dependencies (4)

- [sharp](https://npm.io/package/sharp.md) ^0.24.0
- [yargs](https://npm.io/package/yargs.md) ^12.0.5
- [colors](https://npm.io/package/colors.md) ^1.3.3
- [cli-progress](https://npm.io/package/cli-progress.md) ^2.1.1

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2020-02-11
- 1.0.0 — 2019-01-10

## README

# Quick resize
Use this package to easily resize images.
#### Installation
Start with installing the package:  `$ npm install -g quick-resize`  

#### Usage
Execute in your command line:  
```
$ quick-resize --image=image.png --destination=resized/ [--config=resize-config.json] [--width=256] [--height=256]
```

##### Parameters
Parameter | Description
--- | --- |
`--config` | JSON config file |
`--image` | The image to resize |
`--destination` | The destination folder for your generated images |
`--width` | Width of the resized image
`--height` | Height of the resized image

##### Configuration
By using the `config` parameter, the rest of the possible parameters won't be used.
The `image`, `destination`, `width` and `height` parameter must be present in this JSON file. Besides these parameters, there are some more:

Parameter | Type | Description
--- | ---| ---|
`image` | String |The image to resize |
`destination` | String |The destination folder for your generated images |
`width` | Number| Width of the resized image
`height` | Number |Height of the resized image
`multipleImages` | Boolean | If `true`, `images` will be used instead of `image`. Default is `false`
`images` | String[] | Array of images to resize
`multipleSizes` | Boolean | If `true`, `sizes` will be used instead of `width` and `height`. Default is `false`
`sizes` | { width: Number, height: Number }[] | Array with multiple sizes

*Example config file*  
```json
{
  "image": "logo.png",
  "destination": "your/destination/folder/",
  "width": 100,
  "height": 100,
  "multipleImages": false,
  "images": [],
  "multipleSizes": false,
  "sizes": []
}
```

---
_Source: https://npm.io/package/quick-resize · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._