khoj/docs/README.md
2023-07-21 20:01:19 -07:00

3.3 KiB

Khoj Logo

test dockerize pypi

Khoj

An AI personal assistant for your digital brain

Welcome to the Khoj Docs! This is the best place to get started with Khoj. Check out our Github to explore the code or our Website for an invite up to Khoj cloud.

Khoj gives you lightning fast, offline search on your personal machine and gives you the power to talk to your notes.

Supported Plugins

Khoj on Obsidian Khoj on Emacs

Features

  • Search
    • Local: Your personal data stays local. All search and indexing is done on your machine. Unlike chat which requires access to GPT.
    • 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
  • General
    • Natural: Advanced natural language understanding using Transformer based ML Models
    • Pluggable: Modular architecture makes it easy to plug in new data sources, frontends and ML models
    • Multiple Sources: Index your Org-mode and Markdown notes, PDF files, Github repositories, and Photos
    • Multiple Interfaces: Interact from your Web Browser, Emacs or Obsidian

Install

Click here for full setup instructions.

Supported data sources

  • markdown*
  • org-mode*
  • pdf*
  • images*
  • github
  • notion

* These data sources are offline only.

If you're using Github or Notion, you can get on a waitlist for Khoj Cloud.

Credits