You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-18Lines changed: 25 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -14,67 +14,74 @@ Private & local AI personal knowledge management app.</h4>
14
14
</p>
15
15
16
16
> ### 📢 Announcement
17
+
>
17
18
> We are now on [Discord](https://discord.gg/b7zanGCTUY)! Our team is shipping very quickly right now so sharing ❤️feedback❤️ with us will really help shape the product 🚀
18
19
19
-
20
-
21
20
## About
22
-
**Reor** is an AI-powered desktop note-taking app: it automatically links related notes, answers questions on your notes, provides semantic search and can generate AI flashcards. Everything is stored locally and you can edit your notes with an Obsidian-like markdown editor.
23
-
24
-
The hypothesis of the project is that AI tools for thought should run models locally *by default*. Reor stands on the shoulders of the giants [Ollama](https://github.com/ollama/ollama), [Transformers.js](https://github.com/xenova/transformers.js) & [LanceDB](https://github.com/lancedb/lancedb) to enable both LLMs and embedding models to run locally:
25
-
26
-
1. Every note you write is chunked and embedded into an internal vector database.
27
-
2. Related notes are connected automatically via vector similarity.
28
-
3. LLM-powered Q&A does RAG on your corpus of notes.
29
-
4. Everything can be searched semantically.
30
21
22
+
**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.
31
23
24
+
The hypothesis of the project is that AI tools for thought should run models locally *by default*. Reor stands on the shoulders of the giants [Ollama](https://github.com/ollama/ollama), [Transformers.js](https://github.com/xenova/transformers.js) & [LanceDB](https://github.com/lancedb/lancedb) to enable both LLMs and embedding models to run locally:
32
25
26
+
1. Every note you write is chunked and embedded into an internal vector database.
27
+
2. Related notes are connected automatically via vector similarity.
28
+
3. LLM-powered Q&A does RAG on your corpus of notes.
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.
37
34
38
-
39
35
### Getting Started
36
+
40
37
1. Download from [reorproject.org](https://reorproject.org) or [releases](https://github.com/reorproject/reor/releases). Mac, Linux & Windows are all supported.
41
38
2. Install like a normal App.
42
39
43
-
44
40
### Running local models
41
+
45
42
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 models [here](https://ollama.com/library).
46
43
47
44
You can also [connect to an OpenAI-compatible API](https://www.reorproject.org/docs/documentation/openai-like-api) like Oobabooga, Ollama or OpenAI itself!
48
45
49
46
### Importing notes from other apps
47
+
50
48
Reor works within a single directory in the filesystem. You choose the directory on first boot.
51
49
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!
52
50
53
-
54
51
### Building from source
55
52
56
53
Make sure you have [nodejs](https://nodejs.org/en/download) installed.
57
-
#### Clone repo:
54
+
55
+
#### Clone repo
56
+
58
57
```
59
58
git clone https://github.com/reorproject/reor.git
60
59
```
61
-
#### Install dependencies:
60
+
61
+
#### Install dependencies
62
+
62
63
```
63
64
npm install
64
65
```
65
-
#### Run for dev:
66
+
67
+
#### Run for dev
68
+
66
69
```
67
70
npm run dev
68
71
```
69
-
#### Build:
72
+
73
+
#### Build
74
+
70
75
```
71
76
npm run build
72
77
```
73
78
74
79
### Interested in contributing?
80
+
75
81
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 the [contributing guide](https://www.reorproject.org/docs/documentation/contributing) to get started.
0 commit comments