# xzimg

**Repository Path**: xzqx/xzimg

## Basic Information

- **Project Name**: xzimg
- **Description**: 基于python开发的终端命令行图片处理工具
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-04-13
- **Last Updated**: 2025-04-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# xzimg - 星凪图片工具

✨ 一个简单易用的图片处理命令行工具，提供抠图（去除背景）和格式转换功能 ✨

## 功能特性

- **图片抠图**：自动识别并移除图片背景，支持透明背景或自定义颜色背景
- **格式转换**：支持多种图片格式之间的转换，包括 PNG、JPG、WebP、AVIF、ICO 等
- **批量处理**：支持批量处理目录下的所有图片
- **简单易用**：命令行界面简洁明了，易于使用
- **独立环境**：自动创建 Python 虚拟环境，不影响系统环境
- **跨平台支持**：同时支持 Windows 和 Unix/Linux/macOS 系统

## 安装说明

### 前提条件

- Python 3.x
- Git（可选，用于克隆仓库）

### 安装步骤

1. 克隆或下载本仓库：

```bash
git clone https://github.com/yourusername/xzimg.git
cd xzimg
```

2. 首次运行时，工具会自动创建 Python 虚拟环境并安装所需依赖：

```bash
# Unix/Linux/macOS 系统
./xzimg

# Windows 系统
xzimg.bat
```

3. （可选）为方便使用，可以将工具添加到系统 PATH 中：

```bash
# Unix/Linux/macOS 系统，在~/.bashrc或~/.zshrc中添加以下行
export PATH="$PATH:/path/to/xzimg"

# Windows 系统，添加到系统环境变量 PATH 中
```

## 使用方法

### 抠图功能

#### 单文件处理

```bash
xzimg koutu -i input.jpg -o output.png
```

#### 使用自定义背景色

```bash
xzimg koutu -i input.jpg -o output.png -c "#FF0000"  # 红色背景
```

#### 批量处理

```bash
# 处理当前目录下的所有图片
xzimg koutu -b -o output_dir

# 处理指定目录下的所有图片
xzimg koutu -b images -o output_dir

# 批量处理并使用自定义背景色
xzimg koutu -b images -o output_dir -c "#00FF00"  # 绿色背景
```

### 格式转换功能

#### 单文件转换

```bash
xzimg format -i input.png -o output.jpg -f jpg
```

#### 批量转换

```bash
# 将当前目录下的所有图片转换为WebP格式
xzimg format -b -f webp

# 将指定目录下的所有图片转换为JPG格式
xzimg format -b images -o converted -f jpg
```

## 支持的图片格式

- PNG (.png)
- JPEG (.jpg, .jpeg)
- WebP (.webp)
- GIF (.gif)
- BMP (.bmp)
- TIFF (.tiff, .tif)
- AVIF (.avif)
- ICO (.ico)
- HEIC (.heic) (暂时不支持，有点 bug)

## 命令参数说明

### 通用参数

- `--help`, `-h`: 显示帮助信息
- `-r`: 删除并重新创建虚拟环境（用于更新依赖或修复环境问题）

### 抠图功能参数

- `-i`, `--input <文件>`: 指定输入图片文件路径
- `-o`, `--output <文件/目录>`: 指定输出图片文件路径或目录
- `-c`, `--color <颜色>`: 指定背景颜色，格式为十六进制，如 #FFFFFF
- `-b`, `--batch [目录]`: 批量处理模式，可选指定输入目录，默认为当前目录

### 格式转换功能参数

- `-i`, `--input <文件>`: 指定输入图片文件路径
- `-o`, `--output <文件/目录>`: 指定输出图片文件路径或目录
- `-f`, `--format <格式>`: 指定目标格式，如 png, jpg, webp 等，默认为 png
- `-b`, `--batch [目录]`: 批量处理模式，可选指定输入目录，默认为当前目录

## 技术细节

- 使用 Python 虚拟环境管理依赖，确保工具运行不影响系统环境
- 抠图功能基于 rembg 库和 U2Net 模型，提供高质量的背景移除效果
- 格式转换功能基于 Pillow 库，支持多种图片格式之间的转换
- 支持 AVIF 格式通过 pillow-avif-plugin
- 使用 colorama 库实现跨平台的彩色终端输出
- 自动生成唯一哈希值，避免文件覆盖问题

## 项目结构

```
xzimg/
├── scripts/             # Python 脚本目录
│   ├── koutu.py        # 抠图功能实现
│   ├── format.py       # 格式转换功能实现
│   └── color_utils.py  # 终端颜色工具
├── xzimg               # Unix/Linux/macOS 启动脚本
├── xzimg.bat           # Windows 启动脚本
├── requirements.txt    # 依赖列表
└── .gitignore          # Git 忽略文件
```

## 卸载说明

本工具所有文件均在一个文件夹内，卸载时只需删除整个文件夹，并从环境变量中移除相关路径即可。

## 许可证

[MIT License](LICENSE)

## 问题反馈

如果您在使用过程中遇到任何问题，或有任何功能建议，欢迎提交 Issue 或 Pull Request。