abanoubha/docseng

local search engine for offline docs

docseng (docse)

Local search engine for oflline docs. It is called docseng and also known as docse.

se is short for (s)earch (e)ngine.

docseng is short for (doc)umentation (se)arch (eng)ine.

docse is short for (doc)umentation (s)earch (e)ngine.

Note

This project is abandoned because you can do better than that with local LLMs.

Resources & References

• google/codesearch
• tsoding/seroost: local SE for docs
• realTristan/hermes: Full-Text-Search Algorithm and Caching System
• quickwit-oss/tantivy: full-text search engine library
• apache/lucene: open-source search software
• helix-editor/nucleo: fuzzy matcher library
• YouTube | the algorithm behind spell checkers

How to use ? (Commands)

# run the app
$ go run .

# build the app from source
$ go build -o docs .

# get dependencies, build binary/executable, run
go mod tidy && go build -o docse . && ./docse

# detect race conditions & memory leaks
go run -race .

source code

source code of docseng project is available at:

• GitHub : https://github.com/abanoubha/docseng.git
• GitLab : https://gitlab.com/abanoubha/docseng.git
• CodeBerg : https://codeberg.org/abanoubha/docseng.git

Tasks

• indexing
• searching