mirror of
https://github.com/khoaliber/khoj.git
synced 2026-03-02 05:29:12 +00:00
a4ab498aec
- Improve overall flow of the contribute section of Readme - Fix where to look for good first issues. The contributors board is outdated. Easier to maintain and view good-first-issue with issue tags directly. Co-authored-by: Debanjum <debanjum@gmail.com>
109 lines
4.7 KiB
Markdown
109 lines
4.7 KiB
Markdown
<p align="center"><img src="https://assets.khoj.dev/khoj-logo-sideways-1200x540.png" width="230" 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/)
|
||
[](https://discord.gg/BDgyabRM6e)
|
||
|
||
</div>
|
||
|
||
<div align="center">
|
||
<b>Your AI second brain</b>
|
||
</div>
|
||
|
||
<br />
|
||
|
||
<div align="center">
|
||
|
||
[📑 Docs](https://docs.khoj.dev)
|
||
<span> • </span>
|
||
[🌐 Web](https://khoj.dev)
|
||
<span> • </span>
|
||
[🔥 App](https://app.khoj.dev)
|
||
<span> • </span>
|
||
[💬 Discord](https://discord.gg/BDgyabRM6e)
|
||
<span> • </span>
|
||
[✍🏽 Blog](https://blog.khoj.dev)
|
||
|
||
<a href="https://trendshift.io/repositories/10318" target="_blank"><img src="https://trendshift.io/api/badge/repositories/10318" alt="khoj-ai%2Fkhoj | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
|
||
|
||
</div>
|
||
|
||
***
|
||
|
||
### 🎁 New
|
||
* Start any message with `/research` to try out the experimental research mode with Khoj.
|
||
* Anyone can now [create custom agents](https://blog.khoj.dev/posts/create-agents-on-khoj/) with tunable personality, tools and knowledge bases.
|
||
* [Read](https://blog.khoj.dev/posts/evaluate-khoj-quality/) about Khoj's excellent performance on modern retrieval and reasoning benchmarks.
|
||
|
||
***
|
||
|
||
## Overview
|
||
|
||
[Khoj](https://khoj.dev) is a personal AI app to extend your capabilities. It smoothly scales up from an on-device personal AI to a cloud-scale enterprise AI.
|
||
|
||
- Chat with any local or online LLM (e.g llama3, qwen, gemma, mistral, gpt, claude, gemini, deepseek).
|
||
- Get answers from the internet and your docs (including image, pdf, markdown, org-mode, word, notion files).
|
||
- Access it from your Browser, Obsidian, Emacs, Desktop, Phone or Whatsapp.
|
||
- Create agents with custom knowledge, persona, chat model and tools to take on any role.
|
||
- Automate away repetitive research. Get personal newsletters and smart notifications delivered to your inbox.
|
||
- Find relevant docs quickly and easily using our advanced semantic search.
|
||
- Generate images, talk out loud, play your messages.
|
||
- Khoj is open-source, self-hostable. Always.
|
||
- Run it privately on [your computer](https://docs.khoj.dev/get-started/setup) or try it on our [cloud app](https://app.khoj.dev).
|
||
|
||
***
|
||
|
||
## See it in action
|
||
|
||
|
||
|
||
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).
|
||
|
||
## Enterprise
|
||
|
||
Khoj is available as a cloud service, on-premises, or as a hybrid solution. To learn more about Khoj Enterprise, [visit our website](https://khoj.dev/teams).
|
||
|
||
## Frequently Asked Questions (FAQ)
|
||
|
||
Q: Can I use Khoj without self-hosting?
|
||
|
||
Yes! You can use Khoj right away at [https://app.khoj.dev](https://app.khoj.dev) — no setup required.
|
||
|
||
Q: What kinds of documents can Khoj read?
|
||
|
||
Khoj supports a wide variety: PDFs, Markdown, Notion, Word docs, org-mode files, and more.
|
||
|
||
Q: How can I make my own agent?
|
||
|
||
Check out [this blog post](https://blog.khoj.dev/posts/create-agents-on-khoj/) for a step-by-step guide to custom agents.
|
||
For more questions, head over to our [Discord](https://discord.gg/BDgyabRM6e)!
|
||
|
||
|
||
## 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?
|
||
Khoj is open source. It is sustained by the community and we’d love for you to join it! Whether you’re a coder, designer, writer, or enthusiast, there’s a place for you.
|
||
|
||
Why Contribute?
|
||
- Make an Impact: Help build, test and improve a tool used by thousands to boost productivity.
|
||
- Learn & Grow: Work on cutting-edge AI, LLMs, and semantic search technologies.
|
||
|
||
You can help us build new features, improve the project documentation, report issues and fix bugs. If you're a developer, please see our [Contributing Guidelines](https://docs.khoj.dev/contributing/development) and check out [good first issues](https://github.com/khoj-ai/khoj/contribute) to work on.
|