sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2024-11-24 07:55:07 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 33
khoj/src/interface/emacs
History
Debanjum abd035e2fa
Merge PR #112 to fix quote usage in khoj.el docstring from suliveevil/master 
Fix usage warning for unescaped single quote in `khoj.el' docstring. 
Converts usage of '<text>' into `<text>' to use the correct quote forms in generated docs
2023-01-05 13:24:11 -03:00
..
khoj.el Merge PR #112 to fix quote usage in khoj.el docstring from suliveevil/master 2023-01-05 13:24:11 -03:00
README.org Add Upgrade instructions for Khoj.el Readme. Fix version of khoj.el 2023-01-04 20:06:39 -03:00

README.org

Emacs Khoj

The Emacs interface for Khoj

Prerequisites

  • Install and Run Khoj

Installation

Using MELPA 
 M-x package-install khoj

Add below snippet to your Emacs config file

;; Install Khoj Package from MELPA Stable
(use-package khoj
   :ensure t
   :pin melpa-stable
   :bind ("C-c s" . 'khoj))

Note: Install khoj.el from MELPA (instead of MELPA Stable) if you installed the pre-release version of khoj

  • That is, use :pin melpa to install khoj.el in above snippet if khoj was installed with pip install --pre khoj-assistant
  • Else use :pin melpa-stable to install khoj.el in above snippet if khoj was installed with pip install khoj-assistant
  • This ensures both khoj.el and khoj app are from the same version (tagged or latest)
Using Straight.el

Add below snippet to your Emacs config file

  ;; Install Khoj Package using Straight.el
  (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))

Usage

  1. Open Query Interface on Client

  2. Query Incrementally in Natural Language e.g "What is the meaning of life?" "What are my life goals?"
  3. 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"`

Upgrade

Use your Emacs package manager to upgrade `khoj.el`

  • For `khoj.el` from MELPA

    • Method 1

      • Run `M-x package-list-packages` to list all packages
      • Press `U` on `khoj` to mark it for upgrade
      • Press `x` to execute the marked actions

    • Method 2

      • Run `M-x package-refresh-content`
      • Run `M-x package-reinstall khoj`

  • For `khoj.el` from Straight

    • Run `M-x straight-pull-package khoj`