mirror of
https://github.com/khoj-ai/khoj.git
synced 2025-02-17 08:04:21 +00:00
- By default assume the audience of this website is people looking to understand the featuer offering of Khoj, and then people who are looking to self-host |
||
---|---|---|
.. | ||
assets | ||
.nojekyll | ||
_coverpage.md | ||
_sidebar.md | ||
advanced.md | ||
chat.md | ||
CNAME | ||
credits.md | ||
demos.md | ||
desktop_installation.md | ||
development.md | ||
emacs.md | ||
features.md | ||
github_integration.md | ||
index.html | ||
notion_integration.md | ||
obsidian.md | ||
performance.md | ||
README.md | ||
search.md | ||
setup.md | ||
telemetry.md | ||
web.md | ||
windows_install.md |
An AI personal assistant for your digital brain
Introduction
Welcome to the Khoj Docs! This is the best place to get started with Khoj. We have instructions on self-hosting, using Khoj with Emacs, Obsidian, and the Web, and more. We also include setup instructions for users on the hosted instance at app.khoj.dev.
- 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. If you're self-hosting, your family, friends, or team can have a shared assistance server. You'll the the suite of server admin settings at
/server/admin
.
Quickstart
Click here for full setup instructions
pip install khoj-assistant && khoj
Overview
![](https://docs.khoj.dev/assets/khoj_search_on_web.png)
![](https://docs.khoj.dev/assets/khoj_chat_on_web.png)
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