# placeholder-image-generator

**Repository Path**: github-9819409/placeholder-image-generator

## Basic Information

- **Project Name**: placeholder-image-generator
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-18
- **Last Updated**: 2025-12-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# placeholder-image-cli (pd-img)

一个轻量级、功能丰富的命令行占位图片生成工具。当你在开发中需要一个占位图片时，可以使用这个工具一键生成。

支持生成 PNG、JPG、SVG、WebP 格式，支持自定义尺寸、背景色、文本内容、字体样式及圆角等。

## 特性

*   🚀 **一键生成**：通过简单的命令快速生成测试图片。
*   🎨 **高度自定义**：支持自定义宽高、背景色、文本内容、字体大小/颜色/字体族。
*   🔲 **圆角支持**：支持生成带圆角的透明背景图片。
*   🖼️ **多格式支持**：支持 PNG, JPEG, WebP, SVG 多种输出格式。
*   ⚡ **自动推断**：根据输出文件名后缀自动推断生成格式。
*   📂 **自动创建目录**：如果输出路径的目录不存在，会自动创建。

## 安装

需要 Node.js >= 14。

```bash
# 全局安装
npm install -g placeholder-image-cli

# 或者使用 npx 直接运行
npx placeholder-image-cli [options]
```

## 使用方法

安装后，你可以使用 `pd-img` 或 `placeholder-image` 命令。

```bash
pd-img [options]
```

### 选项说明

| 参数 (简写) | 描述 | 默认值 |
| :--- | :--- | :--- |
| `--width`, `-w` | 图片宽度 | `300` |
| `--height`, `-h` | 图片高度 | `200` |
| `--bg`, `-b` | 背景颜色 (支持 Hex, RGB, RGBA) | `#CCCCCC` |
| `--text`, `-t` | 文本内容 | `<width>x<height>` |
| `--fontSize`, `-s` | 文本字号 (px) | `min(w,h)*0.18` |
| `--color`, `-c` | 文本颜色 | `#333333` |
| `--fontFamily` | 字体族 | `Arial, Helvetica...` |
| `--radius`, `-r` | 圆角大小 (px) | `0` |
| `--format`, `-f` | 输出格式 (`png`, `jpg`, `svg`, `webp`) | `png` |
| `--out`, `-o` | 输出文件路径 | `./placeholder-<ts>.png` |
| `--help` | 显示帮助信息 | - |

> **注意**：
> 1.  颜色值建议加上引号，例如 `"#ff0000"`，以避免终端解析错误。
> 2.  带有空格的文本内容必须加上引号，例如 `"Hello World"`。

### 示例

**1. 最简单的用法**
生成一个默认的 300x200 PNG 图片，文件名包含时间戳。
```bash
pd-img
```

**2. 自定义尺寸和颜色**
生成 400x300，黄色背景，深色文字。
```bash
pd-img -w 400 -h 300 -b "#ffcc00" -c "#333"
```

**3. 生成圆角透明图片**
生成 200x200，红色背景，50px 圆角，输出为 `avatar.png`。
```bash
pd-img -w 200 -h 200 -b "#ff0000" -r 50 -o avatar.png
```

**4. 生成 WebP 格式**
工具会自动根据后缀推断格式。
```bash
pd-img -w 500 -h 300 -t "WebP Image" -o banner.webp
```

**5. 生成 SVG (纯矢量)**
生成 SVG 文件，无损缩放。
```bash
pd-img -w 100 -h 100 -f svg -o icon.svg
```

## License

MIT