khoj/docs/README.md
sabaimran 064b2fbc4a
Add a link to the FAQ in our docs (#438)
* Add a link to faq.khoj.dev in the docs
2023-08-14 15:05:08 -07:00

2.4 KiB

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.

  • Khoj is a desktop application to search and chat with your notes, documents and images
  • It is an offline-first, open source AI personal assistant accessible from your Emacs, Obsidian or Web browser
  • It works with jpeg, markdown, notion org-mode, pdf files and github repositories
  • If you have more questions, check out the FAQ - it's a live Khoj instance indexing our Github repository!

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