img-squeeze 0.1.0

A fast and efficient image compression tool with Walrus storage support
Documentation

img-squeeze

Rust License: MIT Crates.io Parallel

一个用 Rust 编写的快速、高效的图片压缩工具，支持多线程并行处理、批量压缩、多种图片格式和去中心化存储。

✨ 特性

  • 🖼️ 多格式支持 - 支持 JPEG、PNG、WebP、BMP、TIFF、GIF 格式
  • 🎯 质量调整 - 可自定义压缩质量 (1-100)
  • 📏 尺寸调整 - 可调整图片宽度和高度
  • 🚀 多线程处理 - 基于 Rayon 的高性能并行处理
  • 📦 批量处理 - 支持目录批量压缩和文件通配符
  • 📊 详细统计 - 实时进度显示和性能统计
  • 🔧 灵活配置 - 自定义线程数和递归处理
  • 🎨 友好界面 - 清晰的进度提示和错误信息
  • 🚀 PNG 优化 - 使用 oxipng 库进行高级 PNG 压缩优化
  • 🌐 Walrus 上传 - 支持上传到 Walrus 去中心化存储网络

📦 安装

从源码构建

# 克隆仓库
git clone https://github.com/yourusername/img-squeeze.git
cd img-squeeze

# 构建项目
cargo build --release

# 将二进制文件添加到 PATH
sudo cp target/release/img-squeeze /usr/local/bin/

使用 Cargo 安装

cargo install img-squeeze

🚀 使用方法

基本压缩

# 基本压缩（自动线程数）
img-squeeze compress input.jpg output.jpg

# 查看帮助
img-squeeze --help
img-squeeze compress --help
img-squeeze batch --help

多线程压缩

# 指定线程数压缩
img-squeeze compress input.jpg output.jpg -j 4        # 使用 4 个线程
img-squeeze compress input.jpg output.jpg -j 8        # 使用 8 个线程

# 自动线程数（默认，根据CPU核心数）
img-squeeze compress input.jpg output.jpg

高级选项

# 指定压缩质量 (1-100, 默认 80)
img-squeeze compress input.jpg output.jpg -q 90

# 调整图片尺寸
img-squeeze compress input.jpg output.jpg -w 800        # 设置宽度为 800px
img-squeeze compress input.jpg output.jpg -H 600        # 设置高度为 600px
img-squeeze compress input.jpg output.jpg -w 800 -H 600 # 同时设置宽度和高度

# 指定输出格式
img-squeeze compress input.png output.jpg -f jpeg
img-squeeze compress input.jpg output.webp -f webp

# 多线程 + 高级选项组合
img-squeeze compress input.jpg output.jpg -j 6 -q 85 -w 1200 -H 800 -f webp

批量处理（新增功能）

# 批量压缩整个目录
img-squeeze batch ./images ./compressed

# 批量压缩（递归处理子目录）
img-squeeze batch ./photos ./output -r

# 批量压缩 + 线程控制
img-squeeze batch ./images ./compressed -j 8

# 批量压缩 + 质量和尺寸调整
img-squeeze batch ./images ./compressed -q 85 -w 1200 -H 800

# 批量压缩 + 格式转换
img-squeeze batch ./images ./webp_output -f webp

# 使用通配符批量处理
img-squeeze batch "*.jpg" ./compressed
img-squeeze batch "./photos/*.png" ./compressed

Walrus 上传（新增功能）

# 上传到 Walrus（默认设置）
img-squeeze upload image.jpg

# 上传到自定义 Walrus 节点
img-squeeze upload image.jpg -a https://aggregator.walrus-testnet.walrus.space -p https://publisher.walrus-testnet.walrus.space

# 上传并设置存储时长（epochs）
img-squeeze upload image.jpg -e 20        # 存储20个epoch，约20天

# 临时上传（1 epoch，约24小时后自动删除）
img-squeeze upload image.jpg -t

# 组合选项
img-squeeze upload image.jpg -a https://aggregator.walrus-testnet.walrus.space -e 15

临时文件管理：

  • 使用 -t 标志上传临时文件，24小时后自动删除
  • 适合测试、开发、临时分享等场景
  • 无需手动删除，系统自动清理

上传成功后，您将获得：

  • 🆔 Blob ID - 用于唯一标识上传的文件
  • 🌐 访问 URL - 直接访问上传文件的链接
  • 📊 文件信息 - 文件大小和存储详情

输出示例：

📤 Uploading to Walrus: "image.jpg"
🔗 Aggregator URL: https://aggregator.walrus-testnet.walrus.space
🔗 Publisher URL: https://publisher.walrus-testnet.walrus.space
⏰ Epochs: Some(10)
✅ Upload successful!
🆔 Blob ID: 3xAm...V7n9
🌐 Access URL: https://aggregator.walrus-testnet.walrus.space/v1/blobs/3xAm...V7n9
📊 File size: 1024 bytes
💡 You can use the blob ID to retrieve the file later

临时上传示例：

📤 Uploading to Walrus: "temp_image.jpg"
🔗 Aggregator URL: https://aggregator.walrus-testnet.walrus.space
🔗 Publisher URL: https://publisher.walrus-testnet.walrus.space
⏰ Epochs: Some(1)
✅ Upload successful!
🆔 Blob ID: MZwz...oSE
🌐 Access URL: https://aggregator.walrus-testnet.walrus.space/v1/blobs/MZwz...oSE
⏰ Temporary file: Will expire after 1 epoch (~24 hours)
🔄 Use without -t flag for longer storage
📊 File size: 406 bytes
💡 You can use the blob ID to retrieve the file later

查看图片信息

# 查看图片详细信息
img-squeeze info image.jpg

输出示例：

📋 Getting info for: "image.jpg"
📸 Image Information:
  📏 Dimensions: 1920x1080
  🎨 Color type: Rgb8
  💾 Format: Jpeg
  📊 File size: 2,456,789 bytes
  📈 Megapixels: 2.1

批量处理性能统计

批量处理完成后会显示详细的性能统计：

📊 Batch Compression Summary:
  📁 Total files processed: 150
  📊 Total original size: 456,789,123 bytes
  📊 Total compressed size: 234,567,890 bytes
  🎯 Overall compression ratio: 48.6%
  ⏱️  Total time: 45.2s
  ⚡ Average speed: 3.32 files/second

📖 命令详解

compress 命令

压缩图片文件。

参数：

  • INPUT - 输入图片文件路径
  • OUTPUT - 输出图片文件路径

选项：

  • -q, --quality <QUALITY> - 压缩质量 (1-100)，默认 80
  • -w, --width <WIDTH> - 最大宽度（像素）
  • -H, --height <HEIGHT> - 最大高度（像素）
  • -f, --format <FORMAT> - 输出格式 (jpeg, png, webp)

upload 命令

上传图片到 Walrus 去中心化存储网络。

参数：

  • INPUT - 要上传的图片文件路径

选项：

  • -a, --aggregator-url <AGGREGATOR_URL> - Walrus aggregator URL
  • -p, --publisher-url <PUBLISHER_URL> - Walrus publisher URL
  • -e, --epochs <EPOCHS> - 存储时长（epochs）

info 命令

显示图片的详细信息。

参数：

  • INPUT - 要分析的图片文件路径

🛠️ 开发

环境要求

  • Rust 1.70+
  • Cargo

构建项目

# 开发构建
cargo build

# 发布构建
cargo build --release

# 运行测试
cargo test

# 检查代码
cargo check
cargo clippy

项目结构

img-squeeze/
├── src/
│   ├── main.rs          # 主程序入口
│   ├── cli.rs           # 命令行接口
│   ├── processing.rs   # 核心压缩逻辑
│   ├── batch.rs         # 批量处理
│   ├── info.rs          # 图片信息分析
│   ├── walrus.rs        # Walrus 存储集成
│   └── error.rs         # 错误处理
├── Cargo.toml           # 项目配置
├── LICENSE              # MIT 许可证
├── README.md            # 项目说明
├── CLAUDE.md            # Claude Code 开发指南
└── WALRUS_URLS.md       # Walrus 网络地址说明

📊 性能特点

  • 内存效率 - 使用 Rust 的零成本抽象和内存安全
  • 处理速度 - 基于高性能的 image 库
  • 并行处理 - 支持多线程图片处理（基于 Rayon）
  • PNG 优化 - 使用 oxipng 进行无损 PNG 压缩，支持 Zopfli 算法
  • 流式处理 - 大文件的流式处理（未来版本）
  • 去中心化存储 - 集成 Walrus 网络，支持区块链存储
  • 异步上传 - 基于 tokio 的异步文件上传
  • 网络优化 - 智能重试和错误处理机制

🤝 贡献

欢迎贡献代码！请遵循以下步骤：

  1. Fork 本仓库
  2. 创建特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交更改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 创建 Pull Request

📄 许可证

本项目采用 MIT 许可证 - 详见 LICENSE 文件。

🙏 致谢

📞 支持

如果您遇到问题或有建议，请：

  1. 查看 Issues
  2. 创建新的 Issue
  3. 发送邮件至：your.email@example.com

注意：这是一个开源项目，欢迎任何形式的贡献和反馈！