https://github.com/dvhar/pikeru
File picker with semantic search and image viewer
https://github.com/dvhar/pikeru
filepicker iced linux rust xdg-desktop-portal
Last synced: 9 months ago
JSON representation
File picker with semantic search and image viewer
- Host: GitHub
- URL: https://github.com/dvhar/pikeru
- Owner: dvhar
- Created: 2024-02-27T03:21:13.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-04-10T01:13:14.000Z (9 months ago)
- Last Synced: 2025-04-10T02:28:04.695Z (9 months ago)
- Topics: filepicker, iced, linux, rust, xdg-desktop-portal
- Language: Rust
- Homepage:
- Size: 1.5 MB
- Stars: 36
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-rust - pikeru - File picker for linux with good thumbnails and search (Applications / File manager)
README
# File Picker with Good Thumbnails and Search
Pikeru is a file picker, file searcher, and image viewer for linux that works on any desktop environment or window manager. It has an xdg-desktop-portal backend that makes it useable with web browsers and anything else that uses portal for file selection.
## Special features other filepickers don't have
* Semantic file search can search images by visual content in addition to file name.
* Select multiple directories and click `Open` to view the contents of all of them at the same time.
* Right click an image to view it. Scroll the image to view the next and previous images.
* `Cmd` menu shows commands specified in the config. Click one to run it on the selected files.
* Set a postprocessor script to convert, resize, compress or do anything else with selected files automatically.
## Installation and Usage
First install the dependencies at the bottom of the readme
### Install the filepicker and make applications use it
* Run `./install.sh` to build and install the filepicker and xdg portal.
* To make firefox use the portal, open `about:config` and set `widget.use-xdg-desktop-portal.file-picker` to `1`. Chromium-based browsers should use it by default.
### What if I want my old filepicker back?
* Run `pikeru -d` to disable pikeru and restore your old filepicker, and `pikeru -e` to re-enable pikeru.
* If your xdg-desktop-portal version is older than 1.18, you'll have to delete /usr/share/xdg-desktop-portal/portals/pikeru.portal or remove your $XDG_CURRENT_DESKTOP from that file to disable it.
### How to enable semantic search
* This is configured in `~/.config/xdg-desktop-portal-pikeru/config` in the `indexer` section.
* The config requires 3 things in addition to `enable = true`:
* a command that prints text associated with a file, like a description or tags
* a command that checks if the above command can be used, for example checking if an API is online
* a list of file extensions the above command can handle
* A caption generator is included in `indexer/caption_server` which can run on this computer or separate server to generate searchable text for images.
* The example configuration uses `indexer/img_indexer.py` to communicate with the caption generator and build the search index.
* Pikeru's xdg portal daemon uses the provided command to build a semantic search index of any directory opened or searched by the filepicker so that next time you search that directory, you can search files by semantic content instead of just file name.
* You can pause the indexer with `pikeru -c` and resume it with `pikeru -b`.
* More details are in the man page for xdg-desktop-portal-pikeru.
### What's configured where
The filepicker and the portal that launches the filepicker each have their own config files.
* `~/.config/pikeru.conf`:
* Anything related to the GUI, like dpi-scale
* Patterns to ignore when searching
* Bookmarks saved by drag-and-drop
* Commands you can run on files
* `~/.config/xdg-desktop-portal-pikeru/config`:
* Location of filepicker (you probably don't need to touch this part)
* Postprocessor for selected files
* Semantic search indexer
## Install Dependencies
### Ubuntu:
```
sudo apt install build-essential scdoc pkg-config libavutil-dev libavformat-dev libavfilter-dev libavdevice-dev libclang-dev
```
### Arch:
```
sudo pacman -S scdoc xdg-desktop-portal ffmpeg clang
```
## License
MIT License