Repository files navigation

📢 Announcement

We are now onDiscord! Our team is shipping very quickly right now so sharing ❤️feedback❤️ with us will really help shape the product 🚀

Reor is an AI-powered desktop note-taking app: it automatically links related notes, answers questions on your notes and provides semantic search. Everything is stored locally and you can edit your notes with an Obsidian-like markdown editor.

The hypothesis of the project is that AI tools for thought should run models locallyby default. Reor stands on the shoulders of the giantsOllama,Transformers.js &LanceDB to enable both LLMs and embedding models to run locally:

1. Every note you write is chunked and embedded into an internal vector database.
2. Related notes are connected automatically via vector similarity.
3. LLM-powered Q&A does RAG on your corpus of notes.
4. Everything can be searched semantically.

One way to think about Reor is as a RAG app with two generators: the LLM and the human. In Q&A mode, the LLM is fed retrieved context from the corpus to help answer a query. Similarly, in editor mode, the human can toggle the sidebar to reveal related notes "retrieved" from the corpus. This is quite a powerful way of "augmenting" your thoughts by cross-referencing ideas in a current note against related ideas from your corpus.

1. Download fromreorproject.org orreleases. Mac, Linux & Windows are all supported.
2. Install like a normal App.

Reor interacts directly with Ollama which means you can download and run models locally right from inside Reor. Head to Settings->Add New Local LLM then enter the name of the model you want Reor to download. You can find available modelshere.

You can alsoconnect to an OpenAI-compatible API like Oobabooga, Ollama or OpenAI itself!

Reor works within a single directory in the filesystem. You choose the directory on first boot.To import notes/files from another app, you'll need to populate that directory manually with markdown files. Note that if you have frontmatter in your markdown files it may not parse correctly. Integrations with other apps are hopefully coming soon!

Make sure you havenodejs installed.

git clone https://github.com/reorproject/reor.git

npm install

npm run dev

npm run build

We are always on the lookout for contributors keen on building the future of knowledge management. Have a feature idea? Want to squash a bug? Want to improve some styling? We'd love to hear it. Check out our issues page and thecontributing guide to get started.

AGPL-3.0 license. SeeLICENSE for details.

Reor means "to think" in Latin.