looqs/README.md

114 baris
5.1 KiB
Markdown
Mentah Pandangan Normal Riwayat

2022-05-31 10:48:00 +02:00
# looqs - Full-text search with previews for your files
2022-08-14 23:15:19 +02:00
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.
2018-01-03 09:40:13 +01:00
## Screenshots
2022-04-14 16:54:46 +02:00
### Preview
2022-08-14 23:15:19 +02:00
looqs allows you to look inside files. It highlights what you have searched for.
2022-04-14 16:54:46 +02:00
![Screenshot looqs](https://garage.quitesimple.org/assets/looqs/orwell.png)
![Screenshot looqs search fstream](https://garage.quitesimple.org/assets/looqs/fstream_write.png)
### Results list
#### Classic results list
2022-06-06 17:11:20 +02:00
Just enter what you want to find, it will search paths and file content.
![Screenshot looqs results](https://garage.quitesimple.org/assets/looqs/looqs_diary.png)
#### Searching with filters
You can be more specific to get what you want with filters
**Filters (long form)**
![Screenshot looqs results](https://garage.quitesimple.org/assets/looqs/opearting_systems_looqs.png)
**Filters (short form)**
There is no need to write the long form of filters. There are also booleans available
![Screenshot looqs results](https://garage.quitesimple.org/assets/looqs/looqs_beatles_marley.png)
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.
2022-04-14 16:54:46 +02:00
## Current status
2024-07-21 16:32:26 +02:00
Latest version: 2024-07-21, v0.10
2022-04-14 16:54:46 +02:00
2022-10-18 16:19:25 +02:00
Please keep in mind: looqs is still at an early stage and may exhibit some weirdness and contain bugs.
2022-10-22 17:20:14 +02:00
Please see [Changelog](CHANGELOG.md) for a human readable list of changes. For download instructions, see
further down this document.
2020-08-24 22:18:49 +02:00
2021-08-11 21:05:39 +02:00
## Goals and principles
* **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.
2022-04-24 15:51:58 +02:00
* **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
2021-08-11 21:05:39 +02:00
* **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.
2020-08-24 22:52:52 +02:00
2022-06-06 17:11:20 +02:00
## Features
- GUI, CLI interface
- Indexing of file path and some metadata.
- Indexing of file file content for FTS search. Currently: .pdf, odt, docx, plaintext.
2022-07-29 10:15:37 +02:00
- Preview of file formats: Currently: .pdf, .odt, plaintext
- Highlight searched terms.
- Quickly open PDF viewer or text editor at location of preview
- Search filters
2022-04-14 16:54:46 +02:00
## Supported platforms
2022-04-24 15:51:58 +02:00
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.
### Licence
GPLv3.
2022-04-24 15:51:58 +02:00
2022-06-29 17:58:48 +02:00
For the dependencies/third-party libraries, see: LICENSE-3RD-PARTY
2022-04-24 15:51:58 +02:00
### Contributing
2022-06-06 17:11:20 +02:00
Please see the [Contribution guidelines](CONTRIBUTING.md) file.
## Documentation
Please see [USAGE.md](USAGE.md) for the user manual. There is also [HACKING.md](HACKING.md) with more technical information.
2022-04-24 15:51:58 +02:00
2022-04-14 16:54:46 +02:00
## Build
2022-04-24 15:51:58 +02:00
### Debian/Ubuntu
2022-06-06 17:11:20 +02:00
To build on Ubuntu and Debian, clone the repo and then run:
```
2022-04-24 15:51:58 +02:00
git submodule init
git submodule update
sudo apt install build-essential qt6-base-dev libqt6sql6-sqlite libpoppler-qt6-dev libuchardet-dev libquazip1-qt6-dev
2024-07-21 16:32:26 +02:00
qmake6
make
```
The GUI is located in `gui/looqs-gui`, the binary for the CLI is in `cli/looqs`
2022-04-24 15:51:58 +02:00
2022-06-06 17:11:20 +02:00
## Packages
At this point, looqs is not in any official distro package repo, but I maintain some packages.
2023-05-07 19:46:43 +02:00
2024-07-21 16:32:26 +02:00
### Ubuntu 24.04
2022-06-06 17:11:20 +02:00
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
```
2023-05-07 19:46:43 +02:00
### Gentoo (EXPERIMENTAL)
Available in this overlay: https://github.com/quitesimpleorg/quitesimple-overlay
2022-04-24 15:51:58 +02:00
2022-06-06 17:11:20 +02:00
### Other distros
2023-05-07 19:46:43 +02:00
I appreciate help for others distros. If you create a package, let me know!
2020-08-24 22:18:49 +02:00
### Signature verification
Release tags can be verified with [my PGP public key](https://quitesimple.org/share/pubkey). 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](https://repo.quitesimple.org/repo.quitesimple.org.asc). For what little it's worth, its fingerprint is: `1B49 45B3 16B2 468A 3DAC C1E0 75EF 3FE8 D753 C8F9`