khoj/src/interface/emacs at d292bdcc119e1d8a939235ede15eab7331e21eb0 - khoj

klbr/khoj

mirror of https://github.com/khoaliber/khoj.git synced 2026-03-03 21:29:08 +00:00

Files

Debanjum Singh Solanky d292bdcc11 Do not version API. Premature given current state of the codebase

- Reason
  - All clients that currently consume the API are part of Khoj
  - Any breaking API changes will be fixed in clients immediately
  - So decoupling client from API is not required
  - This removes the burden of maintaining muliple versions of the API

2022-10-08 16:32:46 +03:00

khoj.el

Do not version API. Premature given current state of the codebase

2022-10-08 16:32:46 +03:00

README.org

Fix URL for khoj.el quelpa setup instructions

2022-07-29 23:01:04 -04:00

README.org

Emacs Khoj

Emacs Khoj

An Emacs interface for Khoj

Requirements

Install and Run Khoj

Installation

Direct Install
- 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
```
  ;; Khoj Package
  (use-package khoj
    :load-path "~/.emacs.d/lisp/khoj.el"
    :bind ("C-c s" . 'khoj))
```

With straight.el

Add below snippet to your ~/.emacs.d/init.el or .emacs config file and execute it.

  ;; 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))

With Quelpa

Ensure Quelpa, quelpa-use-package are installed

Add below snippet to your ~/.emacs.d/init.el or .emacs config file and execute it.

  ;; Khoj Package
  (use-package khoj
    :after org
    :quelpa (khoj :fetcher url :url "https://raw.githubusercontent.com/debanjum/khoj/master/src/interface/emacs/khoj.el")
    :bind ("C-c s" . 'khoj))

Usage

Open Query Interface on Client
- In Emacs: Call khoj using keybinding C-c s or M-x khoj
- On Web: Open http://localhost:8000/
Query Incrementally in Natural Language e.g "What is the meaning of life?" "What are my life goals?"
Apply filters to narrow down results further Include/Exclude specific words or date range from results by updating query with below query format e.g `What is the meaning of life? -god +none dt:"last week"`