https://github.com/mcnaveen/blurhash-cli

Generate blurhash without leaving your terminal
https://github.com/mcnaveen/blurhash-cli

blurhash blurhash-cli blurhash-cli-generator blurhash-from-url blurhash-generator lazyload next-image-optimizer

Last synced: about 2 months ago
JSON representation

Generate blurhash without leaving your terminal

• Host: GitHub
• URL: https://github.com/mcnaveen/blurhash-cli
• Owner: mcnaveen
• Created: 2022-09-08T07:52:40.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-11T08:53:59.000Z (8 months ago)
• Last Synced: 2024-10-30T10:51:32.022Z (about 2 months ago)
• Topics: blurhash, blurhash-cli, blurhash-cli-generator, blurhash-from-url, blurhash-generator, lazyload, next-image-optimizer
• Language: JavaScript
• Homepage: https://npmjs.com/package/blurhash-cli
• Size: 464 KB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Blurhash CLI

:unicorn: Generate blurhash without leaving your terminal.

![Test](https://github.com/mcnaveen/blurhash-cli/workflows/CI/badge.svg)

![Downloads this Week](https://img.shields.io/npm/dw/blurhash-cli)

![Bundle Size](https://img.shields.io/bundlephobia/min/blurhash-cli)

![Version](https://img.shields.io/npm/v/blurhash-cli)

![Blurhash from URL](./image/cover.png)

### :package: Requirements

- Node.js 16X LTS or Higher 📦

### :sparkles: Installation

- Install the NPM Package with the below command:

```bash

#npm

npm install -g blurhash-cli

#yarn

yarn global add blurhash-cli

```

> Please note that you can also use `npx` to run the package without installing it globally.

> Example: `npx blurhash-cli`

### :bulb: Usage

In your terminal, run the below command:

```bash

npx blurhash-cli https://i.imgur.com/NhfEdg2.png

```

Modify the Size (Size is optional, it defaults to 32):

> The size flag controls the quality of the generated blurhash. A higher size value results in better quality but longer generation time.

```bash

npx blurhash-cli https://i.imgur.com/NhfEdg2.png --size=64

```

### :ballot_box_with_check: Output

```

✔ 🥳 Blurhash Generated

› Hash: UnR.*,kW.TnPt7WBocozpJV@nMkWadofWCV@

› Width: 600

› Height: 600

```

### :rocket: Example with Local Image

```bash

npx blurhash-cli ./image.png --local

```

### :six_pointed_star: Credits

- This CLI uses the [blurhash-from-url](https://www.github.com/mcnaveen/blurhash-from-url) library to generate the blurhash for the given URL.

#### :green_heart: Message

I hope you find this useful. If you have any questions, please create an issue.