khoj/README.md
2024-09-11 20:03:48 -07:00

78 lines
2.7 KiB
Markdown

<p align="center"><img src="src/khoj/interface/web/assets/icons/khoj-logo-sideways-500.png" width="230" alt="Khoj Logo"></p>
<div align="center">
[![test](https://github.com/khoj-ai/khoj/actions/workflows/test.yml/badge.svg)](https://github.com/khoj-ai/khoj/actions/workflows/test.yml)
[![dockerize](https://github.com/khoj-ai/khoj/actions/workflows/dockerize.yml/badge.svg)](https://github.com/khoj-ai/khoj/pkgs/container/khoj)
[![pypi](https://github.com/khoj-ai/khoj/actions/workflows/pypi.yml/badge.svg)](https://pypi.org/project/khoj/)
![Discord](https://img.shields.io/discord/1112065956647284756?style=plastic&label=discord)
</div>
<div align="center">
<b>The open-source, personal AI for your digital brain</b>
</div>
<br />
<div align="center">
[📑 Docs](https://docs.khoj.dev)
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
[🏮 App](https://khoj.dev)
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
[💬 Discord](https://discord.gg/BDgyabRM6e)
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
[📚 Blog](https://blog.khoj.dev)
</div>
<div align="left">
***
[Khoj](https://khoj.dev) is a personal, open-source AI application for you to extend your capabilities.
- Share your documents to extend your digital brain.
- Access the internet, getting fresh information.
- You can share pdf, markdown, org-mode, notion files and github repositories.
- Fast, accurate semantic search on top of your docs.
- Create images, talk out loud, play your messages.
- Available Desktop, Emacs, Obsidian, Web and Whatsapp.
- Khoj is open-source, self-hostable. Always.
***
</div>
## See it in action
![demo_chat](https://assets.khoj.dev/quadratic_equation_khoj_web.gif)
Go to https://app.khoj.dev to see Khoj live.
## Full feature list
You can see the full feature list [here](https://docs.khoj.dev/category/features).
## Self-Host
To get started with self-hosting Khoj, [read the docs](https://docs.khoj.dev/get-started/setup).
## Contributors
Cheers to our awesome contributors! 🎉
<a href="https://github.com/khoj-ai/khoj/graphs/contributors">
<img src="https://contrib.rocks/image?repo=khoj-ai/khoj" />
</a>
Made with [contrib.rocks](https://contrib.rocks).
### Interested in Contributing?
We are always looking for contributors to help us build new features, improve the project documentation, or fix bugs. If you're interested, please see our [Contributing Guidelines](https://docs.khoj.dev/contributing/development) and check out our [Contributors Project Board](https://github.com/orgs/khoj-ai/projects/4).
## [Sponsors](https://github.com/sponsors/khoj-ai)
Shout out to our brilliant sponsors! 🌈
<a href="http://github.com/beekeeb">
<img src="https://raw.githubusercontent.com/beekeeb/piantor/main/docs/beekeeb.png" width=250/>
</a>