mirror of
https://github.com/khoj-ai/khoj.git
synced 2024-11-23 15:38:55 +01:00
Fix TOC links, Add how to auto start Khoj server to Readme
Rename tools directory to more standard scripts directory
This commit is contained in:
parent
61b6ee2857
commit
fada617faa
2 changed files with 17 additions and 10 deletions
27
README.md
27
README.md
|
@ -20,8 +20,8 @@
|
||||||
- [Architecture](#Architecture)
|
- [Architecture](#Architecture)
|
||||||
- [Setup](#Setup)
|
- [Setup](#Setup)
|
||||||
- [Install](#1-Install)
|
- [Install](#1-Install)
|
||||||
- [Configure](#2-Configure)
|
- [Run](#2-Run)
|
||||||
- [Run](#3-Run)
|
- [Configure](#3-Configure)
|
||||||
- [Use](#Use)
|
- [Use](#Use)
|
||||||
- [Interfaces](#Interfaces-1)
|
- [Interfaces](#Interfaces-1)
|
||||||
- [Query Filters](#Query-filters)
|
- [Query Filters](#Query-filters)
|
||||||
|
@ -29,7 +29,7 @@
|
||||||
- [Khoj Server](#upgrade-khoj-server)
|
- [Khoj Server](#upgrade-khoj-server)
|
||||||
- [Khoj.el](#upgrade-khoj-on-emacs)
|
- [Khoj.el](#upgrade-khoj-on-emacs)
|
||||||
- [Khoj Obsidian](#upgrade-khoj-on-obsidian)
|
- [Khoj Obsidian](#upgrade-khoj-on-obsidian)
|
||||||
- [Uninstall Khoj](#uninstall-khoj)
|
- [Uninstall](#uninstall)
|
||||||
- [Troubleshoot](#Troubleshoot)
|
- [Troubleshoot](#Troubleshoot)
|
||||||
- [Advanced Usage](#advanced-usage)
|
- [Advanced Usage](#advanced-usage)
|
||||||
- [Access Khoj on Mobile](#access-khoj-on-mobile)
|
- [Access Khoj on Mobile](#access-khoj-on-mobile)
|
||||||
|
@ -117,12 +117,14 @@ These are the general setup instructions for Khoj.
|
||||||
pip install khoj-assistant
|
pip install khoj-assistant
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Start App
|
### 2. Run
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
khoj
|
khoj
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Note: To start Khoj automatically in the background use [Task scheduler](https://www.windowscentral.com/how-create-automated-task-using-task-scheduler-windows-10) on Windows or [Cron](https://en.wikipedia.org/wiki/Cron) on Mac, Linux (e.g with `@reboot khoj`)
|
||||||
|
|
||||||
### 3. Configure
|
### 3. Configure
|
||||||
|
|
||||||
1. Enable content types and point to files to search in the First Run Screen that pops up on app start
|
1. Enable content types and point to files to search in the First Run Screen that pops up on app start
|
||||||
|
@ -167,11 +169,11 @@ Use structured query syntax to filter the natural language search results
|
||||||
pip install --upgrade khoj-assistant
|
pip install --upgrade khoj-assistant
|
||||||
```
|
```
|
||||||
|
|
||||||
- Note: To upgrade to the latest pre-release version of the khoj server run below command
|
*Note: To upgrade to the latest pre-release version of the khoj server run below command*
|
||||||
```shell
|
```shell
|
||||||
# Maps to the latest commit on the master branch
|
# Maps to the latest commit on the master branch
|
||||||
pip install --upgrade --pre khoj-assistant
|
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
|
||||||
|
@ -181,7 +183,7 @@ pip install --upgrade khoj-assistant
|
||||||
- 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/debanjum/khoj/tree/master/src/interface/obsidian#2-Setup-Plugin) for details
|
||||||
|
|
||||||
## Uninstall Khoj
|
## 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
|
||||||
2. Delete the khoj directory in your home folder (i.e `~/.khoj` on Linux, Mac or `C:\Users\<your-username>\.khoj` on Windows)
|
2. Delete the khoj directory in your home folder (i.e `~/.khoj` on Linux, Mac or `C:\Users\<your-username>\.khoj` on Windows)
|
||||||
3. Uninstall the khoj server with `pip uninstall khoj-assistant`
|
3. Uninstall the khoj server with `pip uninstall khoj-assistant`
|
||||||
|
@ -332,8 +334,13 @@ Add your OpenAI API to Khoj by using either of the two options below:
|
||||||
##### 1. Install
|
##### 1. Install
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
|
# Get Khoj Code
|
||||||
git clone https://github.com/debanjum/khoj && cd khoj
|
git clone https://github.com/debanjum/khoj && cd khoj
|
||||||
|
|
||||||
|
# Create, Activate Virtual Environment
|
||||||
python3 -m venv .venv && source .venv/bin/activate
|
python3 -m venv .venv && source .venv/bin/activate
|
||||||
|
|
||||||
|
# Install Khoj for Development
|
||||||
pip install -e .[dev]
|
pip install -e .[dev]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue