Cashew (name not final) is a terminal user interface for recoll. The goal of this project is to offer a keyboard driven UI for recoll and integrate well into workflows centered around the terminal.
- Search recoll index
- easy keyboard driven navigation
- Detail View for each entry
- easily open the entry in your preferred pdf viewer
- Snippets View
- Open pdf at snippet location (currently only supporting zathura)
- flags to integrate into bash script
- determine preferred document viewers
- easily open possible source files (latex, typst) in your editor
- Surrounding Directory View
Assuming you have Go installed on your system, the installation process is as follows. Just clone this repo:
git clone https://github.com/Gedeon23/cashew.git cd into the directory:
cd cashew
build the binary:
go build .
Right now the only requirement is recoll itself. I might add features in the future which are not accessible within the recoll cli.
cashew -h
Usage of cashew:
-log
turn on error logging, usage: --log=true, file: /tmp/cashew_debug.log, default: false
-search string
predefine search query, usage: --search='<query>'I'm using bubbletea for the TUI and recoll for indexing and querying PDFs