sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2024-11-28 01:45:07 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
khoj/docs/README.md
sabaimran 7688228b9c Update docs to reflect new setup processes and instructions based on rearchitecture 
- Most important updates include the depedency requirement to setup Postgres when running/setting Khoj up locally
- Add instructiosn for Docker
- Shift to recommend desktop client and update instructions for how to configure Khoj for user
2023-11-16 12:56:42 -08:00

2.7 KiB
Raw Blame History

Khoj Logo

test dockerize pypi

An AI personal assistant for your digital brain

Introduction

Welcome to the Khoj Docs! This is the best place to get started with Khoj. Unless otherwise mentioned, the docs only pertain to self-hosted Khoj instances.

  • Khoj is an application to dynamically engage with your notes, documents and images. We support APIs for semantic search and chat.
  • It can be easily self-hosted and run on your consumer hardware or private cloud.
  • It provides an open source, AI personal assistant accessible from your Emacs, Obsidian or Web browser, or our desktop app.
  • It works with plaintext, markdown, notion org-mode, pdf files and github repositories
  • It can support use with multiple users, so you and your family, friends, or team can have a shared assistance server. As the admin, you can configure the server settings at /server/admin.

Quickstart

Click here for full setup instructions

pip install khoj-assistant && khoj

Overview

  

Search

  • Local: Your personal data stays local. All search and indexing is done on your machine.
  • Incremental: Incremental search for a fast, search-as-you-type experience

Chat

  • Faster answers: Find answers faster, smoother than search. No need to manually scan through your notes to find answers.
  • Iterative discovery: Iteratively explore and (re-)discover your notes
  • Assisted creativity: Smoothly weave across answers retrieval and content generation
  • Online or Offline: Choose online or offline chat depending on your requirements