talpay / rclip

AI-Powered Command-Line Photo Search Tool

rclip - AI-Powered Command-Line Photo Search Tool

[Blog] [Demo on YouTube]

rclip is a command-line photo search tool based on the awesome OpenAI's CLIP neural network.

Installation

Currently, pre-built distributable is available only for Linux x86_64.

1. Download the AppImage from the latest release.

2. Execute following commands:

$ chmod +x <downloaded AppImage filename>
$ sudo mv <downloaded AppImage filename> /usr/local/bin/rclip

Usage

$ cd photos && rclip "search query"

When you run rclip for the first time in a particular directory, it's going to extract features from the photos, and this takes time. How long it takes depends on your CPU and the number of photos you are going to search through. It took about a day to process 73 thousand of my photos on my NAS that runs an old-ish Intel Celeron J3455.

For the detailed demonstration, watch the video: https://www.youtube.com/watch?v=tAJHXOkHidw.

How do I preview the results?

The command from below will open top-5 results for "kitty" in your default image viewer:

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

I prefer to use feh's thumbnail mode to preview multiple results:

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

Help

$ rclip --help

Contributing

This repository follows the Conventional Commits standard.

Please, execute pipenv shell to set PIP_FIND_LINKS before running pipenv sync or pipenv install.

License

MIT