https://github.com/liblor/knovleks
Personal Search Engine for different types of resources
https://github.com/liblor/knovleks
Last synced: about 1 year ago
JSON representation
Personal Search Engine for different types of resources
- Host: GitHub
- URL: https://github.com/liblor/knovleks
- Owner: Liblor
- License: apache-2.0
- Created: 2022-06-11T12:01:00.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-18T10:32:04.000Z (over 2 years ago)
- Last Synced: 2025-02-01T09:29:31.098Z (over 1 year ago)
- Language: Python
- Size: 399 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Knovleks
Personal Search Engine for different types of resources.
Knovleks can currently index websites, pdf files and text notes.
- [Install](#install)
- [Usage](#usage)
* [Index](#index)
* [Search](#search)
* [Tag filter](#tag-filter)
* [TUI](#tui)
+ [Searchbar focused](#searchbar-focused)
+ [Results focused](#results-focused)
## Install
```
pip install knovleks
```
## Usage
```
Usage: knovleks [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
Commands:
index
search full-text search
tag-filter tag filter
tui terminal user interface (experimental)
```
### Index
```
Usage: knovleks index [OPTIONS] DOCUMENT
Options:
-t, --tag TEXT
--title TEXT
-d, --type, --document-type TEXT
-h, --help Show this message and exit.
```
### Search
```
Usage: knovleks search [OPTIONS] QUERY
full-text search
Options:
-t, --tag TEXT
-st, --show-tags
-l, --limit INTEGER
-dt, --doc-type TEXT
-ft, --full-text display full text
-h, --help Show this message and exit.
```
### Tag filter
```
Usage: knovleks tag-filter [OPTIONS] [TAG]...
tag filter
Options:
-st, --show-tags
-l, --limit INTEGER
-dt, --doc-type TEXT
-h, --help Show this message and exit.
```
### TUI
```
Switch focus: TAB
Next result: ctrl+j
Previous result: ctrl+k
Open result without closing: ctrl+l
```
#### Searchbar focused
```
Exit: ESC
```
#### Results focused
```
Switch focus to searchbar: ESC
Open result: Enter
```