# imgconv

**Repository Path**: shudingbo/imgconv

## Basic Information

- **Project Name**: imgconv
- **Description**: 把 image 转换成 webp
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-14
- **Last Updated**: 2025-06-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# imgconv - 图片格式转换工具

一个强大的命令行图片转换工具，支持将各种格式的图片转换为 WebP 格式。

## 功能特性

- 🖼️ **多格式支持**: 支持 JPG、PNG、GIF、BMP、TIFF、WebP、SVG 等格式
- 📁 **批量转换**: 支持单个文件和整个文件夹的转换
- 🔄 **递归处理**: 可选择递归处理子目录
- 📂 **目录结构保持**: 指定输出目录时保持原始文件夹结构
- 🎨 **透明度保留**: 自动保留原图片的透明通道
- 📊 **进度显示**: 批量转换时显示实时进度
- ⚙️ **质量控制**: 可自定义 WebP 压缩质量
- 🌍 **全局安装**: 支持 npm 全局安装，随处使用

## 安装

```bash
# 克隆项目
git clone <repository-url>
cd imgconv

# 安装依赖
npm install

# 全局安装（推荐）
npm install -g .

# 或者链接到全局（开发模式）
npm link
```

## 使用方法

### 基本用法

```bash
# 转换单个文件
imgconv image.jpg

# 转换文件夹
imgconv ./images

# 递归转换文件夹（包含子目录）
imgconv ./images -r

# 指定输出目录
imgconv ./images -o ./output

# 递归转换并指定输出目录
imgconv ./images -r -o ./output

# 指定 WebP 质量（1-100）
imgconv image.jpg -q 90
```

### 命令行选项

| 选项 | 简写 | 描述 | 默认值 |
|------|------|------|--------|
| `--output <path>` | `-o` | 输出目录路径 | 源文件所在目录 |
| `--recursive` | `-r` | 递归处理子目录 | false |
| `--quality <number>` | `-q` | WebP 质量 (1-100) | 80 |
| `--help` | `-h` | 显示帮助信息 | - |
| `--version` | `-V` | 显示版本号 | - |

### 使用示例

#### 1. 转换单个文件
```bash
imgconv photo.jpg
# 输出: photo.webp (在同一目录)
```

#### 2. 转换文件夹（不递归）
```bash
imgconv ./images
# 转换 images 目录下的所有图片文件
```

#### 3. 递归转换所有子目录
```bash
imgconv ./images -r
# 转换 images 目录及其所有子目录下的图片文件
```

#### 4. 指定输出目录
```bash
imgconv ./images -o ./webp-output
# 将转换后的文件保存到 webp-output 目录
# 保持原始目录结构
```

#### 5. 高质量转换
```bash
imgconv ./images -q 95 -o ./high-quality
# 使用 95% 质量转换图片
```

## 支持的图片格式

- **输入格式**: JPG, JPEG, PNG, GIF, BMP, TIFF, WebP, SVG
- **输出格式**: WebP

## 技术特点

- **透明度保留**: 自动检测并保留原图片的 Alpha 通道
- **智能压缩**: 使用 Sharp 库的高效 WebP 压缩算法
- **进度显示**: 批量转换时显示彩色进度条和当前处理文件
- **错误处理**: 友好的错误提示和异常处理
- **跨平台**: 支持 Windows、macOS 和 Linux

## 依赖项

- [sharp](https://sharp.pixelplumbing.com/) - 高性能图片处理库
- [commander](https://github.com/tj/commander.js/) - 命令行参数解析
- [chalk](https://github.com/chalk/chalk) - 终端字符串样式
- [cli-progress](https://github.com/npkgz/cli-progress) - 命令行进度条

## 开发

```bash
# 安装依赖
npm install

# 开发模式运行
npm start

# 链接到全局（开发测试）
npm link
```

## 许可证

MIT License

## 版本历史

- v1.0.0 - 初始版本
  - 支持多种图片格式转换为 WebP
  - 支持文件和文件夹批量转换
  - 支持递归处理
  - 支持自定义输出目录
  - 支持透明度保留
  - 支持进度显示