rclip - 基于 AI 的命令行照片搜索工具

[博客] [YouTube 演示] [论文]

rclip 是一款由强大的 OpenAI CLIP 神经网络驱动的命令行照片搜索工具。

安装

Linux

sudo snap install rclip

chmod +x <下载的 AppImage 文件名>
sudo mv <下载的 AppImage 文件名> /usr/local/bin/rclip

pip install --extra-index-url https://download.pytorch.org/whl/cpu rclip

macOS

brew install yurijmikhalevich/tap/rclip

注意： 我们仅支持并提供适用于 Apple Silicon (arm64) 的预编译二进制包。您也可以尝试自行为基于 Intel 的 Mac 构建 brew rclip，或使用下面的替代安装方式。

pip install rclip

Windows

1. 从最新的 release 下载 "*.msi" 文件。
2. 运行安装程序以安装 rclip。

pip install rclip

使用

cd photos && rclip "搜索查询"

当您首次在某个目录中运行 rclip 时，它会提取照片的特征，这需要一些时间。所需时间取决于您的 CPU 性能以及要搜索的照片数量。在我的 NAS 上处理 7.3 万张照片大约花费了一天时间，该设备搭载的是较旧的 Intel Celeron J3455 处理器；而在我的配备 M1 Max CPU 的 MacBook 上，索引 5 万张图片仅需 7 分钟；同样在这台 MacBook 上，处理 128 万张图片则耗时约三小时。

有关详细演示，请观看视频：https://www.youtube.com/watch?v=tAJHXOkHidw。

相似图片搜索

您可以通过传递文件路径甚至图片文件的 URL 来使用另一张图片作为查询，rclip 将找到与您提供的查询图片最相似的图片。如果您通过相对路径引用本地图片，必须在其前面加上 ./。例如：

cd photos && rclip ./cat.jpg

# 或者使用 URL
cd photos && rclip https://raw.githubusercontent.com/yurijmikhalevich/rclip/main/tests/e2e/images/cat.jpg

请观看此视频以了解图片到图片的搜索演示：https://www.youtube.com/watch?v=1YQZKeCBxWM。

组合多个查询

您可以对图像和文本查询进行加减操作，以下是一些使用示例：

cd photos && rclip horse + stripes
cd photos && rclip apple - fruit
cd photos && rclip "./new york city.jpg" + night
cd photos && rclip "2:golden retriever" + "./swimming pool.jpg"
cd photos && rclip "./racing car.jpg" - "2:sports car" + "2:snow"

如果您想查看这些查询在 ImageNet-1k 数据集的 128 万张图片上执行的效果，请观看 YouTube 上的演示：https://www.youtube.com/watch?v=MsTgYdOpgcQ。

如何预览结果？

如果您使用的是 iTerm2、Konsole（版本 22.04 及以上）、wezterm、Mintty 或 mlterm 中的任意一个，只需向 rclip 传递 --preview（或 -p）参数即可：

rclip -p kitty

rclip -f -t 5 kitty | xargs -d '\n' -n 1 xdg-open

rclip -f -t 5 kitty | feh -f - -t

我能否使用 rclip 复制符合特定查询的照片？

是的，您可以将 rclip 的输出通过管道传递给其他工具来复制图片。例如，在 macOS、Linux 或 WSL 上，要将匹配“搜索查询”的前 3 张图片复制到 /path/to/destination，您可以这样做：

rclip -f -t 3 "搜索查询" | xargs -I {} cp {} /path/to/destination

rclip 如何更新索引？

当您在已处理过的目录中运行 rclip 时，它只会索引自上次运行以来新增的照片，并从索引中移除已删除的照片。这使得后续运行速度更快。

如果您确定自上次运行以来没有新增或删除照片，可以使用 --no-indexing（或 -n）参数来完全跳过索引步骤，从而进一步加快搜索速度。

rclip -n cat

获取帮助

https://github.com/yurijmikhalevich/rclip/discussions/new/choose

贡献

本仓库遵循 Conventional Commits 标准。

从源代码本地运行

要从源代码本地运行 rclip, 您需要安装 Python 和 Poetry。

然后执行：

# 克隆源代码仓库
git clone git@github.com:yurijmikhalevich/rclip.git

# 安装依赖和 rclip
cd rclip
poetry install

# 激活新的 poetry 环境
poetry shell

如果 poetry 环境已激活，您可以按照上面的 使用方法 部分所述，在本地使用 rclip。

贡献者 ✨

感谢以下优秀的人士和组织（emoji key）：

ramayer 💻

Caphyon 🚇

AbId KhAn 💻

Ben 💻

Tanmay Chaudhari 💻

Leo Auri 💻

特别感谢 Caphyon 和 Advanced Installer 团队，他们慷慨地为 rclip 项目提供了 Professional Advanced Installer 许可证，用于制作 Windows 安装程序。

本项目遵循 all-contributors 规范。欢迎任何形式的贡献！

许可证

MIT

rclip 快速上手指南

rclip 是一款基于 OpenAI CLIP 神经网络的命令行照片搜索工具，支持通过自然语言描述或图片来检索本地相册。

环境准备

• 操作系统：Linux、macOS (推荐 Apple Silicon)、Windows
• 前置依赖：
  • Linux: 需支持 snap，或使用 pip/AppImage
  • macOS: 需安装 Homebrew (推荐) 或 pip
  • Windows: 直接运行安装包或使用 pip
  • Python 环境（若使用 pip 安装）

注意：首次运行时会提取图片特征，耗时取决于图片数量和 CPU 性能。后续运行仅索引新增图片，速度极快。

安装步骤

Linux

推荐方式 (Snap):

sudo snap install rclip

备选方式 (pip):

pip install --extra-index-url https://download.pytorch.org/whl/cpu rclip

macOS

推荐方式 (Homebrew - 仅限 Apple Silicon):

brew install yurijmikhalevich/tap/rclip

备选方式 (pip - 适用于 Intel Mac 或其他情况):

pip install rclip

Windows

1. 前往 Releases 页面 下载最新的 .msi 安装包。
2. 运行安装程序完成安装。

备选方式 (pip):

pip install rclip

基本使用

进入包含照片的目录，直接输入搜索关键词即可：

cd photos && rclip "search query"

更多实用示例：

• 以图搜图（本地图片需加 ./ 前缀）：

  rclip ./cat.jpg
  

• 组合搜索（添加或排除概念）：

  rclip horse + stripes       # 搜索带条纹的马
  rclip apple - fruit         # 搜索苹果但排除水果类概念
  rclip "./new york city.jpg" + night # 基于图片并增加“夜晚”概念
  

• 预览结果（需终端支持如 iTerm2, wezterm 等）：

  rclip -p kitty
  

• 跳过索引（当确认无新图片时加速搜索）：

  rclip -n cat