looqs is a tool that creates a full-text search index for your files. It allows you to look at previews where your search terms have been found, as shown in the screenshots below.
looqs allows you to look inside files. It highlights what you have searched for.
Just enter what you want to find, it will search paths and file content.
You can be more specific to get what you want with filters
Filters (long form)
Filters (short form)
There is no need to write the long form of filters. There are also booleans available
The screenshots in this section may occasionally be slightly outdated, but they are usually recent enough to get an overall impression of the current state of the GUI.
Latest version: 2024-07-21, v0.10
Please keep in mind: looqs is still at an early stage and may exhibit some weirdness and contain bugs.
Please see Changelog for a human readable list of changes. For download instructions, see further down this document.
- Find & Preview. Instead of merely telling you where your search phrase has been found, it should also render the corresponding portion/pages of the documents and highlight the searched words.
- No daemons. As some other desktop search projects are prone to have annoying daemons running that eat system resources away, this solution should make do without daemons where possible.
- Easy setup. Similarly, there should be no need for heavy-weight databases. Instead, looqs tries to squeeze out the most from simple approaches. In particular, it relies on sqlite.
- GUI & CLI. Provide CLI interfaces and GUI interfaces
- Sandboxing. As reading and rendering lots of formats naturally opens the door for security bugs, those tasks are offloaded to small, sandboxed sub-processes to mitigate the effect of exploited vulnerabilities.
- GUI, CLI interface
- Indexing of file path and some metadata.
- Indexing of file file content for FTS search. Currently: .pdf, odt, docx, plaintext.
- Preview of file formats: Currently: .pdf, .odt, plaintext
- Highlight searched terms.
- Quickly open PDF viewer or text editor at location of preview
- Search filters
Linux (on amd64) is currently the main focus. Currently, I don't plan on supporting anything else and the sandboxing architecture does not make it likely. I suppose a version without sandboxing might be conceivable for other platforms, but I have no plans or resources to actively target anything but Linux at this point.
GPLv3.
For the dependencies/third-party libraries, see: LICENSE-3RD-PARTY
Please see the Contribution guidelines file.
Please see USAGE.md for the user manual. There is also HACKING.md with more technical information.
To build on Ubuntu and Debian, clone the repo and then run:
git submodule init
git submodule update
sudo apt install build-essential qt6-base-dev libqt6sql6-sqlite libpoppler-qt6-dev libuchardet-dev libquazip1-qt6-dev
qmake6
make
The GUI is located in gui/looqs-gui, the binary for the CLI is in cli/looqs
At this point, looqs is not in any official distro package repo, but I maintain some packages.
Latest release can be installed using apt from the repo.
# First, obtain key, assume it's trusted.
wget -O- https://repo.quitesimple.org/repo.quitesimple.org.asc | gpg --dearmor > repo.quitesimple.org-keyring.gpg
cat repo.quitesimple.org-keyring.gpg | sudo tee -a /usr/share/keyrings/repo.quitesimple.org.gpg > /dev/null
echo "deb [arch=amd64 signed-by=/usr/share/keyrings/repo.quitesimple.org.gpg] https://repo.quitesimple.org/debian/ $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/quitesimple.list
sudo apt-get update
sudo apt-get install looqs
Available in this overlay: https://github.com/quitesimpleorg/quitesimple-overlay
I appreciate help for others distros. If you create a package, let me know!
Release tags can be verified with my PGP public key. For what little it's worth, its fingerprint is: C342 CA02 D2EC 2E14 F3C3 D5FF 7F7B 4C08 02CD 02F2
Packages can be verified with the repo-specific public key. For what little it's worth, its fingerprint is: 1B49 45B3 16B2 468A 3DAC C1E0 75EF 3FE8 D753 C8F9