qmd

QMD to lokalny silnik wyszukiwania dla baz wiedzy w markdown. Łączy trzy metody: wyszukiwanie słów kluczowych BM25, wyszukiwanie semantyczne przez wektory oraz ponowne rankowanie przez LLM. Użyj go, gdy chcesz znaleźć notatki, dokumenty, informacje z bazy wiedzy, transkrypcje spotkań lub dokumentację. Działa bez połączenia z internetem, przechowując wszystko lokalnie na Twoim komputerze.

1. Zainstaluj QMD globalnie za pomocą npm: npm install -g @tobilu/qmd. Upewnij się, że masz zainstalowany Node.js i npm na swoim systemie.

2. Przygotuj swoją bazę wiedzy — umieść pliki markdown w katalogu, który będziesz przeszukiwać. QMD obsługuje notatki, dokumenty, transkrypcje spotkań i wszelką dokumentację w formacie markdown.

3. Wybierz typ wyszukiwania w zależności od tego, co wiesz. Użyj wyszukiwania słów kluczowych (lex), jeśli znasz dokładne terminy — wpisz 2-5 słów bez słów wypełniających, np. "connection pool" lub "handleError async". Użyj wyszukiwania semantycznego (vec), jeśli chcesz zadać pytanie naturalnym językiem — sformułuj pełne pytanie, np. "jak limitator szybkości obsługuje nagłe wzrosty ruchu".

4. Sformułuj zapytanie w zależności od wybranego typu. Dla wyszukiwania słów kluczowych podaj konkretne terminy lub nazwy. Dla wyszukiwania semantycznego zadaj pytanie z kontekstem, np. "w serwisie płatności, jak przetwarzane są zwroty".

5. Jeśli nie jesteś pewny, jak sformułować zapytanie, użyj funkcji auto-expand — wpisz jedno pytanie, a lokalny LLM automatycznie wygeneruje warianty wyszukiwania słów kluczowych i semantycznego.

6. Przejrzyj wyniki — QMD zwraca dokumenty posortowane według trafności, biorąc pod uwagę zarówno dopasowanie słów kluczowych, jak i znaczenie semantyczne. Możesz ograniczyć liczbę wyników, ustawiając limit w zapytaniu.