klbr/khoj
1
0
Fork 0
mirror of https://github.com/khoaliber/khoj.git synced 2026-03-09 05:39:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation. Simplify, reflect current capabilities

Browse Source
This commit is contained in:
Debanjum Singh Solanky
2022-07-21 21:18:25 +04:00
parent d4d7dbaca6
commit 4c24202e42
2 changed files with 22 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.org
View File

@@ -3,7 +3,7 @@
* Khoj * Khoj
/Allow natural language search on user content like notes, images, transactions using transformer ML models/ /Allow natural language search on user content like notes, images, transactions using transformer ML models/
User can interface with Khoj via the API or [[./src/interface/emacs/khoj.el][Emacs]]. All search is done locally[[https://github.com/debanjum/khoj#miscellaneous][*]] User can interface with Khoj via [[./src/interface/web/index.html][Web]], [[./src/interface/emacs/khoj.el][Emacs]] or the API. All search is done locally[[https://github.com/debanjum/khoj#miscellaneous][*]]
** Demo ** Demo
https://user-images.githubusercontent.com/6413477/168417719-8a8bc4e5-8404-42b2-89a7-4493e3d2582c.mp4 https://user-images.githubusercontent.com/6413477/168417719-8a8bc4e5-8404-42b2-89a7-4493e3d2582c.mp4

30
src/interface/emacs/README.org
View File

@@ -16,29 +16,41 @@
:bind ("C-c s" . 'khoj)) :bind ("C-c s" . 'khoj))
#+end_src #+end_src
- Use [[https://github.com/quelpa/quelpa#installation][Quelpa]] - With [[https://github.com/raxod502/straight.el][straight.el]]
- Add below snippet to your ~/.emacs.d/init.el or .emacs config file and execute it.
#+begin_src elisp
;; Khoj Package for Semantic Search
(use-package khoj
:after org
:straight (khoj :type git :host github :repo "debanjum/khoj" :files (:defaults "src/interface/emacs/khoj.el"))
:bind ("C-c s" . 'khoj))
#+end_src
- With [[https://github.com/quelpa/quelpa#installation][Quelpa]]
- Ensure [[https://github.com/quelpa/quelpa#installation][Quelpa]], [[https://github.com/quelpa/quelpa-use-package#installation][quelpa-use-package]] are installed - Ensure [[https://github.com/quelpa/quelpa#installation][Quelpa]], [[https://github.com/quelpa/quelpa-use-package#installation][quelpa-use-package]] are installed
- Add below snippet to your ~/.emacs.d/init.el or .emacs config file and execute it. - Add below snippet to your ~/.emacs.d/init.el or .emacs config file and execute it.
#+begin_src elisp #+begin_src elisp
;; Khoj Package ;; Khoj Package
(use-package khoj (use-package khoj
:after org
:quelpa (khoj :fetcher url :url "https://raw.githubusercontent.com/debanjum/khoj/master/interface/emacs/khoj.el") :quelpa (khoj :fetcher url :url "https://raw.githubusercontent.com/debanjum/khoj/master/interface/emacs/khoj.el")
:bind ("C-c s" . 'khoj)) :bind ("C-c s" . 'khoj))
#+end_src #+end_src
** Usage ** Usage
1. Call ~khoj~ using keybinding ~C-c s~ or ~M-x khoj~ 1. Open Query Interface on Client
2. Enter Query in Natural Language - In Emacs: Call ~khoj~ using keybinding ~C-c s~ or ~M-x khoj~
- On Web: Open http://localhost:8000/
2. Query in Natural Language
e.g "What is the meaning of life?" "What are my life goals?" e.g "What is the meaning of life?" "What are my life goals?"
3. Wait for results *Note: It takes about 4s on a Mac M1 and a >100K line corpus of notes*
*Note: It takes about 15s on a Mac M1 and a ~100K lines corpus of org-mode files* 3. (Optional) Narrow down results further
4. (Optional) Narrow down results further Include/Exclude specific words or date range from results by updating query with below query format
Include/Exclude specific words from results by adding to query e.g `What is the meaning of life? -god +none dt:"last week"`
e.g "What is the meaning of life? -god +none"