mirror of
https://github.com/khoj-ai/khoj.git
synced 2024-12-04 21:03:01 +01:00
54 lines
2.4 KiB
Markdown
54 lines
2.4 KiB
Markdown
<p align="center"><img src="./assets/khoj-logo-sideways-500.png" width="200" alt="Khoj Logo"></p>
|
|
|
|
<div align="center">
|
|
|
|
[](https://github.com/khoj-ai/khoj/actions/workflows/test.yml)
|
|
[](https://github.com/khoj-ai/khoj/pkgs/container/khoj)
|
|
[](https://pypi.org/project/khoj-assistant/)
|
|
|
|
</div>
|
|
|
|
<div align="center">
|
|
<b>An AI personal assistant for your digital brain</b>
|
|
|
|
</div>
|
|
|
|
<div align="center">
|
|
|
|
[📜 Explore Code](https://github.com/khoj-ai/khoj)
|
|
<span> • </span>
|
|
[🌍 Try Khoj Cloud](https://khoj.dev)
|
|
<span> • </span>
|
|
[💬 Get Involved](https://discord.gg/BDgyabRM6e)
|
|
|
|
</div>
|
|
|
|
## Introduction
|
|
Welcome to the Khoj Docs! This is the best place to [get started](./setup.md) with Khoj.
|
|
|
|
- Khoj is a desktop application to [search](./search.md) and [chat](./chat.md) with your notes, documents and images
|
|
- It is an offline-first, open source AI personal assistant accessible from your [Emacs](./emacs.md), [Obsidian](./obsidian.md) or [Web browser](./web.md)
|
|
- It works with jpeg, markdown, [notion](./notion_integration.md) org-mode, pdf files and [github repositories](./github_integration.md)
|
|
- If you have more questions, check out the [FAQ](https://faq.khoj.dev/) - it's a live Khoj instance indexing our Github repository!
|
|
|
|
## Quickstart
|
|
[Click here](./setup.md) for full setup instructions
|
|
|
|
```shell
|
|
pip install khoj-assistant && khoj
|
|
```
|
|
|
|
## Overview
|
|
<img src="https://docs.khoj.dev/assets/khoj_search_on_web.png" width="400px">
|
|
<span> </span>
|
|
<img src="https://docs.khoj.dev/assets/khoj_chat_on_web.png" width="400px">
|
|
|
|
#### [Search](./search.md)
|
|
- **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](./chat.md)
|
|
- **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
|