Skip to main content

Emacs

Melpa Stable Badge Melpa Badge Build Badge Test Badge

Query your Second Brain from Emacs

Features​

  • Chat
    • Faster answers: Find answers quickly, from your private notes or the public internet
    • Assisted creativity: Smoothly weave across retrieving answers and generating content
    • Iterative discovery: Iteratively explore and re-discover your notes
  • Search
    • Natural: Advanced natural language understanding using Transformer based ML Models
    • Incremental: Incremental search for a fast, search-as-you-type experience

Interface​

Search Chat
khoj search on emacs khoj chat on emacs

Setup​

Self Hosting

If you are self-hosting the Khoj server modify the install steps below:

  • Set thynk-server-url to your thynk server URL. By default, use http://127.0.0.1:42110.
  • Do not set thynk-api-key if your thynk server runs in anonymous mode. For example, thynk --anonymous-mode
  1. Generate an API key on the thynk Web App
  2. Add below snippet to your Emacs config file, usually at ~/.emacs.d/init.el

Direct Install​

Khoj will index your org-agenda files, by default

;; Install thynk.el
M-x package-install thynk

; Set your thynk API key
(setq thynk-api-key "YOUR_thynk_CLOUD_API_KEY")
(setq thynk-server-url "https://app.thynk.dev")

Minimal Install​

thynk will index your org-agenda files, by default

;; Install thynk client from MELPA Stable
(use-package thynk
  :ensure t
  :pin melpa-stable
  :bind ("C-c s" . 'thynk)
  :config (setq thynk-api-key "YOUR_thynk_CLOUD_API_KEY"
                thynk-server-url "https://app.thynk.dev"))

Standard Install​

Configures the specified org files, directories to be indexed by thynk

;; Install thynk client from MELPA Stable
(use-package thynk
  :ensure t
  :pin melpa-stable
  :bind ("C-c s" . 'thynk)
  :config (setq thynk-api-key "YOUR_thynk_CLOUD_API_KEY"
                thynk-server-url "https://app.thynk.dev"
                thynk-index-directories '("~/docs/org-roam" "~/docs/notes")
                thynk-index-files '("~/docs/todo.org" "~/docs/work.org")))

Straight.el​

Configures the specified org files, directories to be indexed by thynk

;; Install thynk client using Straight.el
(use-package thynk
  :after org
  :straight (thynk :type git :host github :repo "thynk-ai/thynk" :files (:defaults "src/interface/emacs/thynk.el"))
  :bind ("C-c s" . 'thynk)
  :config (setq thynk-api-key "YOUR_thynk_CLOUD_API_KEY"
                thynk-server-url "https://app.thynk.dev"
                thynk-org-directories '("~/docs/org-roam" "~/docs/notes")
                thynk-org-files '("~/docs/todo.org" "~/docs/work.org")))

Use​

See thynk Search for details

  1. Hit C-c s s (or M-x thynk RET s) to open thynk search
  2. Enter your query in natural language
    E.g. "What is the meaning of life?", "My life goals for 2023"

Chat​

See thynk Chat for details

  1. Hit C-c s c (or M-x thynk RET c) to open thynk chat
  2. Ask questions in a natural, conversational style
    E.g. "When did I file my taxes last year?"

Find Similar Entries​

This feature finds entries similar to the one you are currently on.

  1. Move cursor to the org-mode entry, markdown section or text paragraph you want to find similar entries for
  2. Hit C-c s f (or M-x thynk RET f) to find similar entries

Advanced Usage​

  • Add query filters during search to narrow down results further e.g. What is the meaning of life? -"god" +"none" dt>"last week"

  • Use C-c C-o 2 to open the current result at cursor in its source org file

    • This calls M-x org-open-at-point on the current entry and opens the second link in the entry.
    • The second link is the entries org-id, if set, or the heading text. The first link is the line number of the entry in the source file. This link is less robust to file changes.
    • Note: If you have speed keys enabled, o 2 will also work

thynk Menu​

Hit C-c s (or M-x thynk) to open the thynk menu above. Then:

  • Hit t until you preferred content type is selected in the thynk menu Content Type specifies the content to perform Search, Update or Find Similar actions on
  • Hit n twice and then enter number of results you want to see Results Count is used by the Search and Find Similar actions
  • Hit -f u to force update the thynk content index The Force Update switch is only used by the Update action

Upgrade​

Use your Emacs package manager to upgrade thynk.el

With MELPA​

  1. Run M-x package-refresh-content
  2. Run M-x package-reinstall thynk

With Straight.el​

  • Run M-x straight-pull-package thynk