mirror of
https://github.com/khoj-ai/khoj.git
synced 2024-11-23 15:38:55 +01:00
Rename project links across repo from debanjum/khoj to khoj-ai/khoj
This commit is contained in:
parent
f6a7aa6c96
commit
69d4fa6525
13 changed files with 67 additions and 67 deletions
2
.github/workflows/build_khoj_el.yml
vendored
2
.github/workflows/build_khoj_el.yml
vendored
|
@ -33,7 +33,7 @@ jobs:
|
||||||
- name: 🌡️ Validate Khoj.el
|
- name: 🌡️ Validate Khoj.el
|
||||||
env:
|
env:
|
||||||
# Khoj recipe from https://github.com/melpa/melpa/pull/8321/files
|
# Khoj recipe from https://github.com/melpa/melpa/pull/8321/files
|
||||||
RECIPE: (khoj :fetcher github :repo "debanjum/khoj" :files ("src/interface/emacs/*.el"))
|
RECIPE: (khoj :fetcher github :repo "khoj-ai/khoj" :files ("src/interface/emacs/*.el"))
|
||||||
EXIST_OK: true
|
EXIST_OK: true
|
||||||
LOCAL_REPO: ${{ github.workspace }}
|
LOCAL_REPO: ${{ github.workspace }}
|
||||||
run: echo $GITHUB_REF && make -C ~/melpazoid
|
run: echo $GITHUB_REF && make -C ~/melpazoid
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# syntax=docker/dockerfile:1
|
# syntax=docker/dockerfile:1
|
||||||
FROM ubuntu:kinetic
|
FROM ubuntu:kinetic
|
||||||
LABEL org.opencontainers.image.source https://github.com/debanjum/khoj
|
LABEL org.opencontainers.image.source https://github.com/khoj-ai/khoj
|
||||||
|
|
||||||
# Install System Dependencies
|
# Install System Dependencies
|
||||||
RUN apt update -y && \
|
RUN apt update -y && \
|
||||||
|
|
46
README.md
46
README.md
|
@ -1,14 +1,14 @@
|
||||||
# Khoj 🦅
|
# Khoj 🦅
|
||||||
[![test](https://github.com/debanjum/khoj/actions/workflows/test.yml/badge.svg)](https://github.com/debanjum/khoj/actions/workflows/test.yml)
|
[![test](https://github.com/khoj-ai/khoj/actions/workflows/test.yml/badge.svg)](https://github.com/khoj-ai/khoj/actions/workflows/test.yml)
|
||||||
[![dockerize](https://github.com/debanjum/khoj/actions/workflows/dockerize.yml/badge.svg)](https://github.com/debanjum/khoj/pkgs/container/khoj)
|
[![dockerize](https://github.com/khoj-ai/khoj/actions/workflows/dockerize.yml/badge.svg)](https://github.com/khoj-ai/khoj/pkgs/container/khoj)
|
||||||
[![pypi](https://github.com/debanjum/khoj/actions/workflows/pypi.yml/badge.svg)](https://pypi.org/project/khoj-assistant/)
|
[![pypi](https://github.com/khoj-ai/khoj/actions/workflows/pypi.yml/badge.svg)](https://pypi.org/project/khoj-assistant/)
|
||||||
|
|
||||||
*An AI personal assistant for your digital brain*
|
*An AI personal assistant for your digital brain*
|
||||||
|
|
||||||
**Supported Plugins**
|
**Supported Plugins**
|
||||||
|
|
||||||
[![Khoj on Obsidian](https://img.shields.io/badge/Obsidian-%23483699.svg?style=for-the-badge&logo=obsidian&logoColor=white)](https://github.com/debanjum/khoj/tree/master/src/interface/obsidian#readme)
|
[![Khoj on Obsidian](https://img.shields.io/badge/Obsidian-%23483699.svg?style=for-the-badge&logo=obsidian&logoColor=white)](https://github.com/khoj-ai/khoj/tree/master/src/interface/obsidian#readme)
|
||||||
[![Khoj on Emacs](https://img.shields.io/badge/Emacs-%237F5AB6.svg?&style=for-the-badge&logo=gnu-emacs&logoColor=white)](https://github.com/debanjum/khoj/tree/master/src/interface/emacs#readme)
|
[![Khoj on Emacs](https://img.shields.io/badge/Emacs-%237F5AB6.svg?&style=for-the-badge&logo=gnu-emacs&logoColor=white)](https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#readme)
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
|
@ -68,7 +68,7 @@
|
||||||
|
|
||||||
## Demos
|
## Demos
|
||||||
### Khoj in Obsidian
|
### Khoj in Obsidian
|
||||||
https://github.com/debanjum/khoj/assets/6413477/3e33d8ea-25bb-46c8-a3bf-c92f78d0f56b
|
https://github.com/khoj-ai/khoj/assets/6413477/3e33d8ea-25bb-46c8-a3bf-c92f78d0f56b
|
||||||
|
|
||||||
<details><summary>Description</summary>
|
<details><summary>Description</summary>
|
||||||
|
|
||||||
|
@ -88,9 +88,9 @@ https://user-images.githubusercontent.com/6413477/184735169-92c78bf1-d827-4663-9
|
||||||
|
|
||||||
- Install Khoj via pip
|
- Install Khoj via pip
|
||||||
- Start Khoj app
|
- Start Khoj app
|
||||||
- Add this readme and [khoj.el readme](https://github.com/debanjum/khoj/tree/master/src/interface/emacs) as org-mode for Khoj to index
|
- Add this readme and [khoj.el readme](https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs) as org-mode for Khoj to index
|
||||||
- Search \"*Setup editor*\" on the Web and Emacs. Re-rank the results for better accuracy
|
- Search \"*Setup editor*\" on the Web and Emacs. Re-rank the results for better accuracy
|
||||||
- Top result is what we are looking for, the [section to Install Khoj.el on Emacs](https://github.com/debanjum/khoj/tree/master/src/interface/emacs#2-Install-Khojel)
|
- Top result is what we are looking for, the [section to Install Khoj.el on Emacs](https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#2-Install-Khojel)
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details><summary>Analysis</summary>
|
<details><summary>Analysis</summary>
|
||||||
|
@ -103,19 +103,19 @@ https://user-images.githubusercontent.com/6413477/184735169-92c78bf1-d827-4663-9
|
||||||
|
|
||||||
### Interfaces
|
### Interfaces
|
||||||
|
|
||||||
![](https://github.com/debanjum/khoj/blob/master/docs/interfaces.png?)
|
![](https://github.com/khoj-ai/khoj/blob/master/docs/interfaces.png?)
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
![](https://github.com/debanjum/khoj/blob/master/docs/khoj_architecture.png?)
|
![](https://github.com/khoj-ai/khoj/blob/master/docs/khoj_architecture.png?)
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
These are the general setup instructions for Khoj.
|
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
|
- 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<br />
|
- Check the [Khoj.el Readme](https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Setup) to setup Khoj with Emacs<br />
|
||||||
Its simpler as it can skip the server *install*, *run* and *configure* step below.
|
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<br />
|
- Check the [Khoj Obsidian Readme](https://github.com/khoj-ai/khoj/tree/master/src/interface/obsidian#Setup) to setup Khoj with Obsidian<br />
|
||||||
Its simpler as it can skip the *configure* step below.
|
Its simpler as it can skip the *configure* step below.
|
||||||
|
|
||||||
### 1. Install
|
### 1. Install
|
||||||
|
@ -147,10 +147,10 @@ Khoj exposes a web interface by default.<br />
|
||||||
The optional steps below allow using Khoj from within an existing application like Obsidian or Emacs.
|
The optional steps below allow using Khoj from within an existing application like Obsidian or Emacs.
|
||||||
|
|
||||||
- **Khoj Obsidian**:<br />
|
- **Khoj Obsidian**:<br />
|
||||||
[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**:<br />
|
- **Khoj Emacs**:<br />
|
||||||
[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
|
## Use
|
||||||
### Khoj Search
|
### 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
|
2. Type your queries and see response by Khoj from your notes
|
||||||
|
|
||||||
#### Demo
|
#### Demo
|
||||||
![](https://github.com/debanjum/khoj/blob/master/docs/khoj_chat_web_interface.png?)
|
![](https://github.com/khoj-ai/khoj/blob/master/docs/khoj_chat_web_interface.png?)
|
||||||
|
|
||||||
### Details
|
### Details
|
||||||
1. Your query is used to retrieve the most relevant notes, if any, using Khoj search
|
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
|
### Upgrade Khoj on Emacs
|
||||||
- Use your Emacs Package Manager to Upgrade
|
- 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 Khoj on Obsidian
|
||||||
- Upgrade via the Community plugins tab on the settings pane in the Obsidian app
|
- 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
|
## Uninstall
|
||||||
1. (Optional) Hit `Ctrl-C` in the terminal running the khoj server to stop it
|
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
|
rustup-init
|
||||||
source ~/.cargo/env
|
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
|
#### 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
|
- **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
|
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!
|
5. Enjoy exploring your notes, transactions and images from your phone!
|
||||||
|
|
||||||
![](https://github.com/debanjum/khoj/blob/master/docs/khoj_pwa_android.png?)
|
![](https://github.com/khoj-ai/khoj/blob/master/docs/khoj_pwa_android.png?)
|
||||||
|
|
||||||
### Use OpenAI Models for Search
|
### Use OpenAI Models for Search
|
||||||
#### Setup
|
#### 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)*
|
*[Interactive Visualization](https://mango-dune-07a8b7110.1.azurestaticapps.net/?repo=debanjum%2Fkhoj)*
|
||||||
|
|
||||||
![](https://github.com/debanjum/khoj/blob/master/docs/khoj_codebase_visualization_0.2.1.png?)
|
![](https://github.com/khoj-ai/khoj/blob/master/docs/khoj_codebase_visualization_0.2.1.png?)
|
||||||
|
|
||||||
### Setup
|
### Setup
|
||||||
#### Using Pip
|
#### Using Pip
|
||||||
|
@ -367,7 +367,7 @@ Note that this plugin is currently *only* indexing Markdown files. It will ignor
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
# Get Khoj Code
|
# 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
|
# Create, Activate Virtual Environment
|
||||||
python3 -m venv .venv && source .venv/bin/activate
|
python3 -m venv .venv && source .venv/bin/activate
|
||||||
|
@ -396,7 +396,7 @@ pip install -e .[dev]
|
||||||
##### 1. Clone
|
##### 1. Clone
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
git clone https://github.com/debanjum/khoj && cd khoj
|
git clone https://github.com/khoj-ai/khoj && cd khoj
|
||||||
```
|
```
|
||||||
|
|
||||||
##### 2. Configure
|
##### 2. Configure
|
||||||
|
@ -424,7 +424,7 @@ docker-compose build --pull
|
||||||
|
|
||||||
##### 2. Install Khoj
|
##### 2. Install Khoj
|
||||||
```shell
|
```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 env create -f config/environment.yml
|
||||||
conda activate khoj
|
conda activate khoj
|
||||||
python3 -m pip install pyqt6 # As conda does not support pyqt6 yet
|
python3 -m pip install pyqt6 # As conda does not support pyqt6 yet
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
version: "3.9"
|
version: "3.9"
|
||||||
services:
|
services:
|
||||||
server:
|
server:
|
||||||
image: ghcr.io/debanjum/khoj:latest
|
image: ghcr.io/khoj-ai/khoj:latest
|
||||||
ports:
|
ports:
|
||||||
# If changing the local port (left hand side), no other changes required.
|
# If changing the local port (left hand side), no other changes required.
|
||||||
# If changing the remote port (right hand side),
|
# If changing the remote port (right hand side),
|
||||||
|
|
|
@ -61,10 +61,10 @@ dependencies = [
|
||||||
dynamic = ["version"]
|
dynamic = ["version"]
|
||||||
|
|
||||||
[project.urls]
|
[project.urls]
|
||||||
Homepage = "https://github.com/debanjum/khoj#readme"
|
Homepage = "https://github.com/khoj-ai/khoj#readme"
|
||||||
Issues = "https://github.com/debanjum/khoj/issues"
|
Issues = "https://github.com/khoj-ai/khoj/issues"
|
||||||
Discussions = "https://github.com/debanjum/khoj/discussions"
|
Discussions = "https://github.com/khoj-ai/khoj/discussions"
|
||||||
Releases = "https://github.com/debanjum/khoj/releases"
|
Releases = "https://github.com/khoj-ai/khoj/releases"
|
||||||
|
|
||||||
[project.scripts]
|
[project.scripts]
|
||||||
khoj = "khoj.main:run"
|
khoj = "khoj.main:run"
|
||||||
|
|
|
@ -1,25 +1,25 @@
|
||||||
* Khoj Emacs 🦅
|
* 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/
|
/An AI personal assistant for your digital brain/
|
||||||
|
|
||||||
** Table of Contents
|
** Table of Contents
|
||||||
- [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#features][Features]]
|
- [[https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#features][Features]]
|
||||||
- [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Interface][Interface]]
|
- [[https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Interface][Interface]]
|
||||||
- [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Setup][Setup]]
|
- [[https://github.com/khoj-ai/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/khoj-ai/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/khoj-ai/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/khoj-ai/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/khoj-ai/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/khoj-ai/khoj/tree/master/src/interface/emacs#Use][Use]]
|
||||||
- [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Search][Search]]
|
- [[https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Search][Search]]
|
||||||
- [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Chat][Chat]]
|
- [[https://github.com/khoj-ai/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/khoj-ai/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/khoj-ai/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/khoj-ai/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/khoj-ai/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/khoj-ai/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#Upgrade-Khojel][Upgrade Khoj.el]]
|
||||||
|
|
||||||
** Features
|
** Features
|
||||||
- *Search*
|
- *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/
|
- /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./
|
- /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
|
*** Direct Install
|
||||||
#+begin_src elisp
|
#+begin_src elisp
|
||||||
|
@ -89,7 +89,7 @@
|
||||||
;; Install Khoj Package using Straight.el
|
;; Install Khoj Package using Straight.el
|
||||||
(use-package khoj
|
(use-package khoj
|
||||||
:after org
|
: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)
|
:bind ("C-c s" . 'khoj)
|
||||||
:config (setq khoj-org-directories '("~/docs/org-roam" "~/docs/notes")
|
:config (setq khoj-org-directories '("~/docs/org-roam" "~/docs/notes")
|
||||||
khoj-org-files '("~/docs/todo.org" "~/docs/work.org")
|
khoj-org-files '("~/docs/todo.org" "~/docs/work.org")
|
||||||
|
@ -111,7 +111,7 @@
|
||||||
|
|
||||||
E.g "When did I file my taxes last year?"
|
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
|
*** Find Similar Entries
|
||||||
This feature finds entries similar to the one you are currently on.
|
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
|
2. Hit ~C-c s f~ (or ~M-x khoj RET f~) to find similar entries
|
||||||
|
|
||||||
*** Advanced Usage
|
*** 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"`
|
e.g `What is the meaning of life? -"god" +"none" dt>"last week"`
|
||||||
|
|
||||||
|
|
|
@ -7,7 +7,7 @@
|
||||||
;; Keywords: search, chat, org-mode, outlines, markdown, pdf, beancount, image
|
;; Keywords: search, chat, org-mode, outlines, markdown, pdf, beancount, image
|
||||||
;; Version: 0.6.2
|
;; Version: 0.6.2
|
||||||
;; Package-Requires: ((emacs "27.1") (transient "0.3.0") (dash "2.19.1"))
|
;; 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.
|
;; This file is NOT part of GNU Emacs.
|
||||||
|
|
||||||
|
|
|
@ -5,7 +5,7 @@
|
||||||
;; Author: Debanjum Singh Solanky <debanjum@gmail.com>
|
;; Author: Debanjum Singh Solanky <debanjum@gmail.com>
|
||||||
;; Version: 0.0.0
|
;; Version: 0.0.0
|
||||||
;; Package-Requires: ((emacs "27.1") (transient "0.3.0") (dash "2.19.1") (org "9.0.0"))
|
;; Package-Requires: ((emacs "27.1") (transient "0.3.0") (dash "2.19.1") (org "9.0.0"))
|
||||||
;; URL: https://github.com/debanjum/khoj/tree/master/src/interface/emacs
|
;; URL: https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs
|
||||||
|
|
||||||
;;; License:
|
;;; License:
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
# Khoj Obsidian 🦅
|
# Khoj Obsidian 🦅
|
||||||
> Natural language search for your Obsidian notes using [Khoj](https://github.com/debanjum/khoj)
|
> Natural language search for your Obsidian notes using [Khoj](https://github.com/khoj-ai/khoj)
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
|
@ -35,7 +35,7 @@
|
||||||
|
|
||||||
## Demo
|
## Demo
|
||||||
### Search Demo
|
### Search Demo
|
||||||
https://github.com/debanjum/khoj/assets/6413477/3e33d8ea-25bb-46c8-a3bf-c92f78d0f56b
|
https://github.com/khoj-ai/khoj/assets/6413477/3e33d8ea-25bb-46c8-a3bf-c92f78d0f56b
|
||||||
|
|
||||||
<details><summary>Description</summary>
|
<details><summary>Description</summary>
|
||||||
|
|
||||||
|
@ -51,10 +51,10 @@ https://github.com/debanjum/khoj/assets/6413477/3e33d8ea-25bb-46c8-a3bf-c92f78d0
|
||||||
|
|
||||||
## Interfaces
|
## Interfaces
|
||||||
### Search Modal
|
### Search Modal
|
||||||
![](https://github.com/debanjum/khoj/blob/master/src/interface/obsidian/docs/khoj_on_obsidian_0.2.5.png?)
|
![](https://github.com/khoj-ai/khoj/blob/master/src/interface/obsidian/docs/khoj_on_obsidian_0.2.5.png?)
|
||||||
|
|
||||||
### Chat Modal
|
### Chat Modal
|
||||||
![](https://github.com/debanjum/khoj/blob/master/src/interface/obsidian/docs/khoj_chat_on_obsidian_0.6.0.png?)
|
![](https://github.com/khoj-ai/khoj/blob/master/src/interface/obsidian/docs/khoj_chat_on_obsidian_0.6.0.png?)
|
||||||
|
|
||||||
## Setup
|
## 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*
|
- *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.*
|
- *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.*
|
- *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
|
||||||
|
|
||||||
![](https://github.com/debanjum/khoj/blob/master/src/interface/obsidian/docs/khoj_chat_on_obsidian_0.6.0.png?)
|
![](https://github.com/khoj-ai/khoj/blob/master/src/interface/obsidian/docs/khoj_chat_on_obsidian_0.6.0.png?)
|
||||||
|
|
||||||
### Search
|
### 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)
|
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
|
So notes across multiple vaults **cannot** be searched at the same time
|
||||||
|
|
||||||
## Visualize Codebase
|
## Visualize Codebase
|
||||||
<img src="https://github.com/debanjum/khoj/blob/master/src/interface/obsidian/docs/khoj_obsidian_codebase_visualization_0.2.1.png" width="700" />
|
<img src="https://github.com/khoj-ai/khoj/blob/master/src/interface/obsidian/docs/khoj_obsidian_codebase_visualization_0.2.1.png" width="700" />
|
||||||
|
|
||||||
## Implementation
|
## Implementation
|
||||||
The plugin implements the following functionality to search your notes with Khoj:
|
The plugin implements the following functionality to search your notes with Khoj:
|
||||||
|
|
|
@ -9,7 +9,7 @@
|
||||||
<header>
|
<header>
|
||||||
<div>
|
<div>
|
||||||
<h1>Khoj Settings</h1>
|
<h1>Khoj Settings</h1>
|
||||||
<p>Check out our <a href="https://github.com/debanjum/khoj">source code on Github</a></p>
|
<p>Check out our <a href="https://github.com/khoj-ai/khoj">source code on Github</a></p>
|
||||||
</div>
|
</div>
|
||||||
<div>
|
<div>
|
||||||
<h2>Ready?</h2>
|
<h2>Ready?</h2>
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Get Base Image
|
# Get Base Image
|
||||||
FROM tiangolo/uvicorn-gunicorn:python3.11-slim
|
FROM tiangolo/uvicorn-gunicorn:python3.11-slim
|
||||||
LABEL org.opencontainers.image.source https://github.com/debanjum/khoj
|
LABEL org.opencontainers.image.source https://github.com/khoj-ai/khoj
|
||||||
|
|
||||||
# Install Telemetry Server Dependencies
|
# Install Telemetry Server Dependencies
|
||||||
COPY requirements.txt /tmp/requirements.txt
|
COPY requirements.txt /tmp/requirements.txt
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
* Emacs Khoj
|
* Emacs Khoj
|
||||||
/An Emacs interface for [[https://github.com/debanjum/khoj][khoj]]/
|
/An Emacs interface for [[https://github.com/khoj-ai/khoj][khoj]]/
|
||||||
|
|
||||||
** Requirements
|
** Requirements
|
||||||
- Install and Run [[https://github.com/debanjum/khoj][khoj]]
|
- Install and Run [[https://github.com/khoj-ai/khoj][khoj]]
|
||||||
|
|
||||||
** Installation
|
** Installation
|
||||||
- Direct Install
|
- Direct Install
|
||||||
|
@ -22,7 +22,7 @@
|
||||||
#+begin_src elisp
|
#+begin_src elisp
|
||||||
;; Khoj Package
|
;; Khoj Package
|
||||||
(use-package khoj
|
(use-package khoj
|
||||||
:quelpa (khoj :fetcher url :url "https://raw.githubusercontent.com/debanjum/khoj/master/interface/emacs/khoj.el")
|
:quelpa (khoj :fetcher url :url "https://raw.githubusercontent.com/khoj-ai/khoj/master/interface/emacs/khoj.el")
|
||||||
:bind ("C-c s" . 'khoj))
|
:bind ("C-c s" . 'khoj))
|
||||||
#+end_src
|
#+end_src
|
||||||
|
|
||||||
|
|
|
@ -9,7 +9,7 @@
|
||||||
|
|
||||||
** Install
|
** Install
|
||||||
#+begin_src shell
|
#+begin_src shell
|
||||||
git clone https://github.com/debanjum/khoj && cd khoj
|
git clone https://github.com/khoj-ai/khoj && cd khoj
|
||||||
conda env create -f environment.yml
|
conda env create -f environment.yml
|
||||||
conda activate khoj
|
conda activate khoj
|
||||||
#+end_src
|
#+end_src
|
||||||
|
@ -23,7 +23,7 @@
|
||||||
|
|
||||||
** Use
|
** Use
|
||||||
- *Khoj via Emacs*
|
- *Khoj via Emacs*
|
||||||
- [[https://github.com/debanjum/khoj/tree/master/interface/emacs#installation][Install]] [[./interface/emacs/khoj.el][khoj.el]]
|
- [[https://github.com/khoj-ai/khoj/tree/master/interface/emacs#installation][Install]] [[./interface/emacs/khoj.el][khoj.el]]
|
||||||
- Run ~M-x khoj <user-query>~ or Call ~C-c C-s~
|
- Run ~M-x khoj <user-query>~ or Call ~C-c C-s~
|
||||||
|
|
||||||
- *Khoj via API*
|
- *Khoj via API*
|
||||||
|
|
Loading…
Reference in a new issue