sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2024-12-21 03:47:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
khoj/src/interface/emacs/README.org

45 lines
1.5 KiB
Org Mode
Raw Normal View History

Give the project a short, less generic name. Rename it to Khoj - Semantic Search was just a placeholder used to test the idea out Didn't want to get into naming at that point of time
2022-07-19 14:26:16 +00:00
* Emacs Khoj
/An Emacs interface for [[https://github.com/debanjum/khoj][Khoj]]/
Add Emacs interface to semantic-search directly to main repository Too much overhead to maintain multiple repositories, especially when the Emacs library for semantic-search is a single file. Import Readme from the emacs-semantic-search repository too
2021-08-16 08:27:46 +00:00
** Requirements
Give the project a short, less generic name. Rename it to Khoj - Semantic Search was just a placeholder used to test the idea out Didn't want to get into naming at that point of time
2022-07-19 14:26:16 +00:00
- Install and Run [[https://github.com/debanjum/khoj][Khoj]]
Add Emacs interface to semantic-search directly to main repository Too much overhead to maintain multiple repositories, especially when the Emacs library for semantic-search is a single file. Import Readme from the emacs-semantic-search repository too
2021-08-16 08:27:46 +00:00
** Installation
- Direct Install
Give the project a short, less generic name. Rename it to Khoj - Semantic Search was just a placeholder used to test the idea out Didn't want to get into naming at that point of time
2022-07-19 14:26:16 +00:00
- Put ~khoj.el~ in your Emacs load path. For e.g ~/.emacs.d/lisp
Add Emacs interface to semantic-search directly to main repository Too much overhead to maintain multiple repositories, especially when the Emacs library for semantic-search is a single file. Import Readme from the emacs-semantic-search repository too
2021-08-16 08:27:46 +00:00
- Load via ~use-package~ in your ~/.emacs.d/init.el or .emacs file by adding below snippet
#+begin_src elisp
Give the project a short, less generic name. Rename it to Khoj - Semantic Search was just a placeholder used to test the idea out Didn't want to get into naming at that point of time
2022-07-19 14:26:16 +00:00
;; Khoj Package
(use-package khoj
:load-path "~/.emacs.d/lisp/khoj.el"
:bind ("C-c s" . 'khoj))
Add Emacs interface to semantic-search directly to main repository Too much overhead to maintain multiple repositories, especially when the Emacs library for semantic-search is a single file. Import Readme from the emacs-semantic-search repository too
2021-08-16 08:27:46 +00:00
#+end_src
- Use [[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
- Add below snippet to your ~/.emacs.d/init.el or .emacs config file and execute it.
#+begin_src elisp
Give the project a short, less generic name. Rename it to Khoj - Semantic Search was just a placeholder used to test the idea out Didn't want to get into naming at that point of time
2022-07-19 14:26:16 +00:00
;; Khoj Package
(use-package khoj
:quelpa (khoj :fetcher url :url "https://raw.githubusercontent.com/debanjum/khoj/master/interface/emacs/khoj.el")
:bind ("C-c s" . 'khoj))
Add Emacs interface to semantic-search directly to main repository Too much overhead to maintain multiple repositories, especially when the Emacs library for semantic-search is a single file. Import Readme from the emacs-semantic-search repository too
2021-08-16 08:27:46 +00:00
#+end_src
** Usage
Give the project a short, less generic name. Rename it to Khoj - Semantic Search was just a placeholder used to test the idea out Didn't want to get into naming at that point of time
2022-07-19 14:26:16 +00:00
1. Call ~khoj~ using keybinding ~C-c s~ or ~M-x khoj~
Add Emacs interface to semantic-search directly to main repository Too much overhead to maintain multiple repositories, especially when the Emacs library for semantic-search is a single file. Import Readme from the emacs-semantic-search repository too
2021-08-16 08:27:46 +00:00
2. Enter Query in Natural Language
e.g "What is the meaning of life?" "What are my life goals?"
3. Wait for results
*Note: It takes about 15s on a Mac M1 and a ~100K lines corpus of org-mode files*
4. (Optional) Narrow down results further
Include/Exclude specific words from results by adding to query
e.g "What is the meaning of life? -god +none"
Reference in a new issue Copy permalink