khoj/tests/data/org/interface_emacs_readme.org

* Emacs Khoj
  /An Emacs interface for [[https://github.com/khoj-ai/khoj][khoj]]/

** Requirements
   - Install and Run [[https://github.com/khoj-ai/khoj][khoj]]

** Install
*** Direct
     - Put ~khoj.el~ in your Emacs load path. For e.g ~/.emacs.d/lisp
     - Load via ~use-package~ in your ~/.emacs.d/init.el or .emacs file by adding below snippet
       #+begin_src elisp
         ;; Khoj Package
         (use-package khoj
           :load-path "~/.emacs.d/lisp/khoj.el"
           :bind ("C-c s" . 'khoj))
       #+end_src

*** Using [[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
         ;; Khoj Package
         (use-package khoj
           :quelpa (khoj :fetcher url :url "https://raw.githubusercontent.com/khoj-ai/khoj/master/interface/emacs/khoj.el")
           :bind ("C-c s" . 'khoj))
       #+end_src

** Usage
   1. Call ~khoj~ using keybinding ~C-c s~ or ~M-x khoj~
   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"
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`
Rename project links across repo from debanjum/khoj to khoj-ai/khoj 2023-06-21 07:13:21 +00:00			`/An Emacs interface for [[https://github.com/khoj-ai/khoj][khoj]]/`
Create a few basic tests 2021-08-17 10:27:16 +00:00
			`** Requirements`
Rename project links across repo from debanjum/khoj to khoj-ai/khoj 2023-06-21 07:13:21 +00:00			`- Install and Run [[https://github.com/khoj-ai/khoj][khoj]]`
Create a few basic tests 2021-08-17 10:27:16 +00:00
Update text search test since indexing ancestor hierarchy added 2023-11-17 22:49:39 +00:00			`** Install`
Test search uses ancestor headings as context for improved results - Update test data to add deeper outline hierarchy for testing hierarchy as context - Update collateral tests that need count of entries updated, deleted asserts to be updated 2023-11-16 10:47:58 +00:00			`*** Direct`
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`
Create a few basic tests 2021-08-17 10:27:16 +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))`
Create a few basic tests 2021-08-17 10:27:16 +00:00			`#+end_src`

Test search uses ancestor headings as context for improved results - Update test data to add deeper outline hierarchy for testing hierarchy as context - Update collateral tests that need count of entries updated, deleted asserts to be updated 2023-11-16 10:47:58 +00:00			`*** Using [[https://github.com/quelpa/quelpa#installation][Quelpa]]`
Create a few basic tests 2021-08-17 10:27:16 +00:00			`- 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`
Rename project links across repo from debanjum/khoj to khoj-ai/khoj 2023-06-21 07:13:21 +00:00			`:quelpa (khoj :fetcher url :url "https://raw.githubusercontent.com/khoj-ai/khoj/master/interface/emacs/khoj.el")`
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			`:bind ("C-c s" . 'khoj))`
Create a few basic tests 2021-08-17 10:27:16 +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~`
Create a few basic tests 2021-08-17 10:27:16 +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"`