UNPKG

placeholder-craft-cli

Version:

a cli tool to generate placeholder images

github.com/macaroni10y/placeholder-craft-cli

macaroni10y/placeholder-craft-cli

28 lines (23 loc) • 1.21 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
# placeholder-craft-cli [![NPM Downloads](https://img.shields.io/npm/dt/placeholder-craft-cli)](https://www.npmjs.com/package/placeholder-craft-cli) [![GitHub License](https://img.shields.io/github/license/macaroni10y/placeholder-craft-cli)](https://github.com/macaroni10y/placeholder-craft-cli/blob/main/LICENSE) [![Author](https://img.shields.io/badge/Author-macaroni10y-pink)](https://github.com/macaroni10y) A simple CLI tool to generate placeholder images for your projects. ## example ![placeholder](https://github.com/macaroni10y/placeholder-craft-cli/assets/56068155/b01b477e-1e52-4a35-bd5f-8e6627474d0b) ## Installation You can install the package globally by running the following command. ```shell npm install -g placeholder-craft-cli ``` ## Usage You can run the following command to generate a placeholder image. ```shell phcraft --width 500 --height 500 --filename hoge.png ``` ### Options - `--width` (required): The width of the image. - `--height` (required): The height of the image. - `--filename` : The filename of the image. (default: `placeholder.png`) - `--bgColor` : The background color of the image. (default: `grey`) - `--textColor` : The text color of the image. (default: `white`)