khoj/src/interface/emacs
2021-09-29 13:30:15 -07:00
..
README.org Move application files under src directory. Update Readmes 2021-08-17 04:11:03 -07:00
semantic-search.el Set query as heading of notes search results in Emacs Org buffer 2021-09-29 13:30:15 -07:00

Emacs Semantic Search

An Emacs interface for semantic-search

Requirements

Installation

  • Direct Install

    • Put semantic-search.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

        ;; Org-Semantic Search Library
        (use-package semantic-search
          :load-path "~/.emacs.d/lisp/semantic-search.el"
          :bind ("C-c s" . 'semantic-search))
  • Use Quelpa

    • Ensure Quelpa, quelpa-use-package are installed
    • Add below snippet to your ~/.emacs.d/init.el or .emacs config file and execute it.

        ;; Org-Semantic Search Library
        (use-package semantic-search
          :quelpa (semantic-search :fetcher url :url "https://raw.githubusercontent.com/debanjum/semantic-search/master/interface/emacs/semantic-search.el")
          :bind ("C-c s" . 'semantic-search))

Usage

  1. Call semantic-search using keybinding C-c s or M-x semantic-search
  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"