Analysis
@@ -103,19 +103,19 @@ https://user-images.githubusercontent.com/6413477/184735169-92c78bf1-d827-4663-9 ### Interfaces - + ## Architecture - + ## Setup These are the general setup instructions for Khoj. - Make sure [python](https://realpython.com/installing-python/) (version 3.10 or lower) and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your machine -- Check the [Khoj.el Readme](https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Setup) to setup Khoj with Emacs+- Check the [Khoj.el Readme](https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Setup) to setup Khoj with Emacs
Its simpler as it can skip the server *install*, *run* and *configure* step below. -- Check the [Khoj Obsidian Readme](https://github.com/debanjum/khoj/tree/master/src/interface/obsidian#Setup) to setup Khoj with Obsidian
+- Check the [Khoj Obsidian Readme](https://github.com/khoj-ai/khoj/tree/master/src/interface/obsidian#Setup) to setup Khoj with Obsidian
Its simpler as it can skip the *configure* step below. ### 1. Install @@ -147,10 +147,10 @@ Khoj exposes a web interface by default.
The optional steps below allow using Khoj from within an existing application like Obsidian or Emacs. - **Khoj Obsidian**:
-[Install](https://github.com/debanjum/khoj/tree/master/src/interface/obsidian#2-Setup-Plugin) the Khoj Obsidian plugin +[Install](https://github.com/khoj-ai/khoj/tree/master/src/interface/obsidian#2-Setup-Plugin) the Khoj Obsidian plugin - **Khoj Emacs**:
-[Install](https://github.com/debanjum/khoj/tree/master/src/interface/emacs#2-Install-Khojel) khoj.el +[Install](https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#2-Install-Khojel) khoj.el ## Use ### Khoj Search @@ -201,7 +201,7 @@ Use structured query syntax to filter the natural language search results 2. Type your queries and see response by Khoj from your notes #### Demo - + ### Details 1. Your query is used to retrieve the most relevant notes, if any, using Khoj search @@ -221,11 +221,11 @@ pip install --upgrade --pre khoj-assistant ### Upgrade Khoj on Emacs - Use your Emacs Package Manager to Upgrade -- See [khoj.el readme](https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Upgrade) for details +- See [khoj.el readme](https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Upgrade) for details ### Upgrade Khoj on Obsidian - Upgrade via the Community plugins tab on the settings pane in the Obsidian app -- See the [khoj plugin readme](https://github.com/debanjum/khoj/tree/master/src/interface/obsidian#2-Setup-Plugin) for details +- See the [khoj plugin readme](https://github.com/khoj-ai/khoj/tree/master/src/interface/obsidian#2-Setup-Plugin) for details ## Uninstall 1. (Optional) Hit `Ctrl-C` in the terminal running the khoj server to stop it @@ -243,7 +243,7 @@ pip install --upgrade --pre khoj-assistant rustup-init source ~/.cargo/env ``` -- **Refer**: [Issue with Fix](https://github.com/debanjum/khoj/issues/82#issuecomment-1241890946) for more details +- **Refer**: [Issue with Fix](https://github.com/khoj-ai/khoj/issues/82#issuecomment-1241890946) for more details #### Search starts giving wonky results - **Fix**: Open [/api/update?force=true](http://localhost:8000/api/update?force=true)[^2] in browser to regenerate index from scratch @@ -264,7 +264,7 @@ pip install --upgrade --pre khoj-assistant 4. Click the [Add to Homescreen](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Add_to_home_screen) button 5. Enjoy exploring your notes, transactions and images from your phone! - + ### Use OpenAI Models for Search #### Setup @@ -359,7 +359,7 @@ Note that this plugin is currently *only* indexing Markdown files. It will ignor *[Interactive Visualization](https://mango-dune-07a8b7110.1.azurestaticapps.net/?repo=debanjum%2Fkhoj)* - + ### Setup #### Using Pip @@ -367,7 +367,7 @@ Note that this plugin is currently *only* indexing Markdown files. It will ignor ```shell # Get Khoj Code -git clone https://github.com/debanjum/khoj && cd khoj +git clone https://github.com/khoj-ai/khoj && cd khoj # Create, Activate Virtual Environment python3 -m venv .venv && source .venv/bin/activate @@ -396,7 +396,7 @@ pip install -e .[dev] ##### 1. Clone ```shell -git clone https://github.com/debanjum/khoj && cd khoj +git clone https://github.com/khoj-ai/khoj && cd khoj ``` ##### 2. Configure @@ -424,7 +424,7 @@ docker-compose build --pull ##### 2. Install Khoj ```shell -git clone https://github.com/debanjum/khoj && cd khoj +git clone https://github.com/khoj-ai/khoj && cd khoj conda env create -f config/environment.yml conda activate khoj python3 -m pip install pyqt6 # As conda does not support pyqt6 yet diff --git a/docker-compose.yml b/docker-compose.yml index 0529b150a..03b74444f 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,7 +1,7 @@ version: "3.9" services: server: - image: ghcr.io/debanjum/khoj:latest + image: ghcr.io/khoj-ai/khoj:latest ports: # If changing the local port (left hand side), no other changes required. # If changing the remote port (right hand side), diff --git a/pyproject.toml b/pyproject.toml index f44849ceb..c0a6c2d14 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -61,10 +61,10 @@ dependencies = [ dynamic = ["version"] [project.urls] -Homepage = "https://github.com/debanjum/khoj#readme" -Issues = "https://github.com/debanjum/khoj/issues" -Discussions = "https://github.com/debanjum/khoj/discussions" -Releases = "https://github.com/debanjum/khoj/releases" +Homepage = "https://github.com/khoj-ai/khoj#readme" +Issues = "https://github.com/khoj-ai/khoj/issues" +Discussions = "https://github.com/khoj-ai/khoj/discussions" +Releases = "https://github.com/khoj-ai/khoj/releases" [project.scripts] khoj = "khoj.main:run" diff --git a/src/interface/emacs/README.org b/src/interface/emacs/README.org index f202fb0b8..0026b70e7 100644 --- a/src/interface/emacs/README.org +++ b/src/interface/emacs/README.org @@ -1,25 +1,25 @@ * Khoj Emacs 🦅 - [[https://stable.melpa.org/#/khoj][file:https://stable.melpa.org/packages/khoj-badge.svg]] [[https://melpa.org/#/khoj][file:https://melpa.org/packages/khoj-badge.svg]] [[https://github.com/debanjum/khoj/actions/workflows/build_khoj_el.yml][https://github.com/debanjum/khoj/actions/workflows/build_khoj_el.yml/badge.svg?]] [[https://github.com/debanjum/khoj/actions/workflows/test_khoj_el.yml][https://github.com/debanjum/khoj/actions/workflows/test_khoj_el.yml/badge.svg?]] + [[https://stable.melpa.org/#/khoj][file:https://stable.melpa.org/packages/khoj-badge.svg]] [[https://melpa.org/#/khoj][file:https://melpa.org/packages/khoj-badge.svg]] [[https://github.com/khoj-ai/khoj/actions/workflows/build_khoj_el.yml][https://github.com/khoj-ai/khoj/actions/workflows/build_khoj_el.yml/badge.svg?]] [[https://github.com/khoj-ai/khoj/actions/workflows/test_khoj_el.yml][https://github.com/khoj-ai/khoj/actions/workflows/test_khoj_el.yml/badge.svg?]] /An AI personal assistant for your digital brain/ ** Table of Contents - - [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#features][Features]] - - [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Interface][Interface]] - - [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Setup][Setup]] - - [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Direct-Install][Direct Install]] - - [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Minimal-Install][Minimal Install]] - - [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Standard-Install][Standard Install]] - - [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#With-Straight.el][With Straight.el]] - - [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Use][Use]] - - [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Search][Search]] - - [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Chat][Chat]] - - [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Find-similar-entries][Find Similar Entries]] - - [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Advanced-usage][Advanced Usage]] - - [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Khoj-menu][Khoj Menu]] - - [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Upgrade][Upgrade]] - - [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Upgrade-Khoj-Backend][Upgrade Backend]] - - [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Upgrade-Khojel][Upgrade Khoj.el]] + - [[https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#features][Features]] + - [[https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Interface][Interface]] + - [[https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Setup][Setup]] + - [[https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Direct-Install][Direct Install]] + - [[https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Minimal-Install][Minimal Install]] + - [[https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Standard-Install][Standard Install]] + - [[https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#With-Straight.el][With Straight.el]] + - [[https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Use][Use]] + - [[https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Search][Search]] + - [[https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Chat][Chat]] + - [[https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Find-similar-entries][Find Similar Entries]] + - [[https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Advanced-usage][Advanced Usage]] + - [[https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Khoj-menu][Khoj Menu]] + - [[https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Upgrade][Upgrade]] + - [[https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Upgrade-Khoj-Backend][Upgrade Backend]] + - [[https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Upgrade-Khojel][Upgrade Khoj.el]] ** Features - *Search* @@ -42,7 +42,7 @@ - /Make sure [[https://realpython.com/installing-python/][python]] (version 3.10 or lower) and [[https://pip.pypa.io/en/stable/installation/][pip]] are installed on your machine/ - /khoj.el attempts to automatically install, start and configure the khoj server./ - If this fails, follow [[https://github.com/debanjum/khoj/tree/master/#Setup][these instructions]] to manually setup the khoj server. + If this fails, follow [[https://github.com/khoj-ai/khoj/tree/master/#Setup][these instructions]] to manually setup the khoj server. *** Direct Install #+begin_src elisp @@ -89,7 +89,7 @@ ;; 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")) + :straight (khoj :type git :host github :repo "khoj-ai/khoj" :files (:defaults "src/interface/emacs/khoj.el")) :bind ("C-c s" . 'khoj) :config (setq khoj-org-directories '("~/docs/org-roam" "~/docs/notes") khoj-org-files '("~/docs/todo.org" "~/docs/work.org") @@ -111,7 +111,7 @@ E.g "When did I file my taxes last year?" - See [[https://github.com/debanjum/khoj/tree/master/#Khoj-Chat][Khoj Chat]] for more details + See [[https://github.com/khoj-ai/khoj/tree/master/#Khoj-Chat][Khoj Chat]] for more details *** Find Similar Entries This feature finds entries similar to the one you are currently on. @@ -119,7 +119,7 @@ 2. Hit ~C-c s f~ (or ~M-x khoj RET f~) to find similar entries *** Advanced Usage - - Add [[https://github.com/debanjum/khoj/#query-filters][query filters]] during search to narrow down results further + - Add [[https://github.com/khoj-ai/khoj/#query-filters][query filters]] during search to narrow down results further e.g `What is the meaning of life? -"god" +"none" dt>"last week"` diff --git a/src/interface/emacs/khoj.el b/src/interface/emacs/khoj.el index a397d460f..268875406 100644 --- a/src/interface/emacs/khoj.el +++ b/src/interface/emacs/khoj.el @@ -7,7 +7,7 @@ ;; Keywords: search, chat, org-mode, outlines, markdown, pdf, beancount, image ;; Version: 0.6.2 ;; Package-Requires: ((emacs "27.1") (transient "0.3.0") (dash "2.19.1")) -;; URL: https://github.com/debanjum/khoj/tree/master/src/interface/emacs +;; URL: https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs ;; This file is NOT part of GNU Emacs. diff --git a/src/interface/emacs/tests/khoj-tests.el b/src/interface/emacs/tests/khoj-tests.el index 83985b673..4e2791140 100644 --- a/src/interface/emacs/tests/khoj-tests.el +++ b/src/interface/emacs/tests/khoj-tests.el @@ -5,7 +5,7 @@ ;; Author: Debanjum Singh Solanky
Description
@@ -51,10 +51,10 @@ https://github.com/debanjum/khoj/assets/6413477/3e33d8ea-25bb-46c8-a3bf-c92f78d0 ## Interfaces ### Search Modal - + ### Chat Modal - + ## Setup - *Make sure [python](https://realpython.com/installing-python/) (version 3.10 or lower) and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your machine* @@ -88,9 +88,9 @@ Notes: - *Using Khoj Chat will result in query relevant notes being shared with OpenAI for ChatGPT to respond.* - *To use Khoj Chat, ensure you've set your [OpenAI API key](https://platform.openai.com/account/api-keys) in the Khoj plugin settings.* -See [Khoj Chat](https://github.com/debanjum/khoj/tree/master/#Khoj-Chat) for more details +See [Khoj Chat](https://github.com/khoj-ai/khoj/tree/master/#Khoj-Chat) for more details - + ### Search Click the *Khoj search* icon 🔎 on the [Ribbon](https://help.obsidian.md/User+interface/Workspace/Ribbon) or run *Khoj: Search* from the [Command Palette](https://help.obsidian.md/Plugins/Command+palette) @@ -144,7 +144,7 @@ To see other notes similar to the current one, run *Khoj: Find Similar Notes* fr So notes across multiple vaults **cannot** be searched at the same time ## Visualize Codebase -
+
## Implementation
The plugin implements the following functionality to search your notes with Khoj:
diff --git a/src/khoj/interface/web/base_config.html b/src/khoj/interface/web/base_config.html
index d5d8107cb..654dc323c 100644
--- a/src/khoj/interface/web/base_config.html
+++ b/src/khoj/interface/web/base_config.html
@@ -9,7 +9,7 @@