Skip to content

Commit 6a4bd54

Browse files
phernandezphernandez
authored
chore: Pre beta prep (#20)
fix: drop search_index table on db reindex fix: ai_resource_guide.md path chore: remove logfire Signed-off-by: phernandez <paul@basicmachines.co>
1 parent d2bd75a commit 6a4bd54

71 files changed

Lines changed: 3557 additions & 571 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 40 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@ Basic Memory lets you build persistent knowledge through natural conversations w
2020
Claude, while keeping everything in simple Markdown files on your computer. It uses the Model Context Protocol (MCP) to
2121
enable any compatible LLM to read and write to your local knowledge base.
2222

23+
LLMs can build context from local knowledge bases.
24+
25+
![Example Gif](docs/attachments/Obsidian-CoffeeKnowledgeBase-examples-overlays.gif)
26+
27+
Basic Memory provides persistent contextual awareness across sessions through a structured knowledge graph.
28+
The system enables LLMs to access and reference prior conversations, track semantic relationships between concepts, and
29+
incorporate human edits made directly to knowledge files.
30+
2331
## Quick Start
2432

2533
```bash
@@ -39,18 +47,43 @@ uv install basic-memory
3947
}
4048
}
4149
}
42-
43-
# Start real-time sync
44-
basic-memory sync --watch
45-
4650
# Now in Claude Desktop, you can:
4751
# - Write notes with "Create a note about coffee brewing methods"
4852
# - Read notes with "What do I know about pour over coffee?"
4953
# - Search with "Find information about Ethiopian beans"
5054

51-
# View files shared context via files in ~/basic-memory
5255
```
5356

57+
You can view shared context via files in `~/basic-memory` (default directory location).
58+
59+
You can also install the cli tools to sync files or manage projects.
60+
61+
```bash
62+
uv tool install basic-memory
63+
64+
# create a new project in a different directory
65+
basic-memory project add coffee ./examples/coffee
66+
67+
# you can set the project to the default
68+
basic-memory project default coffee
69+
```
70+
71+
View available projects
72+
73+
```bash
74+
basic-memory project list
75+
Basic Memory Projects
76+
┏━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━┓
77+
┃ Name ┃ Path ┃ Default ┃ Active ┃
78+
┡━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━┩
79+
│ main │ ~/basic-memory │ ✓ │ ✓ │
80+
│ coffee │ ~/dev/basicmachines/basic-memory/examples/coffee │ │ │
81+
└────────┴──────────────────────────────────────────────────┴─────────┴────────┘
82+
```
83+
84+
Basic Memory will write notes in Markdown format. Open you project directory in your text editor to view project files
85+
while you have conversations with an LLM.
86+
5487
## Why Basic Memory?
5588

5689
Most LLM interactions are ephemeral - you ask a question, get an answer, and everything is forgotten. Each conversation
@@ -61,7 +94,8 @@ starts fresh, without the context or knowledge from previous ones. Current worka
6194
- Vector databases require complex setups and often live in the cloud
6295
- Knowledge graphs typically need specialized tools to maintain
6396

64-
Basic Memory solves these problems with a simple approach: structured Markdown files that both humans and LLMs can read
97+
Basic Memory addresses these problems with a simple approach: structured Markdown files that both humans and LLMs can
98+
read
6599
and write to. The key advantages:
66100

67101
- **Local-first:** All knowledge stays in files you control

‎docs/.obsidian/app.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

‎docs/.obsidian/appearance.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

‎docs/.obsidian/core-plugins.json‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"file-explorer": true,
3+
"global-search": true,
4+
"switcher": true,
5+
"graph": true,
6+
"backlink": true,
7+
"canvas": true,
8+
"outgoing-link": true,
9+
"tag-pane": true,
10+
"properties": false,
11+
"page-preview": true,
12+
"daily-notes": true,
13+
"templates": true,
14+
"note-composer": true,
15+
"command-palette": true,
16+
"slash-command": false,
17+
"editor-status": true,
18+
"bookmarks": true,
19+
"markdown-importer": false,
20+
"zk-prefixer": false,
21+
"random-note": false,
22+
"outline": true,
23+
"word-count": true,
24+
"slides": false,
25+
"audio-recorder": false,
26+
"workspaces": false,
27+
"file-recovery": true,
28+
"publish": true,
29+
"sync": true,
30+
"webviewer": false
31+
}

‎docs/.obsidian/publish.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"siteId": "947ee055a8c6f1a57efa4afa09791e62",
3+
"host": "publish-01.obsidian.md",
4+
"included": [],
5+
"excluded": []
6+
}

‎docs/.obsidian/workspace.json‎

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
{
2+
"main": {
3+
"id": "9361625269255fc5",
4+
"type": "split",
5+
"children": [
6+
{
7+
"id": "9220768da355d9a9",
8+
"type": "tabs",
9+
"children": [
10+
{
11+
"id": "cd58e5dfc86465e3",
12+
"type": "leaf",
13+
"state": {
14+
"type": "empty",
15+
"state": {},
16+
"icon": "lucide-file",
17+
"title": "New tab"
18+
}
19+
}
20+
]
21+
}
22+
],
23+
"direction": "vertical"
24+
},
25+
"left": {
26+
"id": "932aa23fccfbb069",
27+
"type": "split",
28+
"children": [
29+
{
30+
"id": "c60acde475f2bc34",
31+
"type": "tabs",
32+
"children": [
33+
{
34+
"id": "a06f3217ff27ae41",
35+
"type": "leaf",
36+
"state": {
37+
"type": "file-explorer",
38+
"state": {
39+
"sortOrder": "alphabetical",
40+
"autoReveal": false
41+
},
42+
"icon": "lucide-folder-closed",
43+
"title": "Files"
44+
}
45+
},
46+
{
47+
"id": "c338fa22e7339c9a",
48+
"type": "leaf",
49+
"state": {
50+
"type": "search",
51+
"state": {
52+
"query": "",
53+
"matchingCase": false,
54+
"explainSearch": false,
55+
"collapseAll": false,
56+
"extraContext": false,
57+
"sortOrder": "alphabetical"
58+
},
59+
"icon": "lucide-search",
60+
"title": "Search"
61+
}
62+
},
63+
{
64+
"id": "56de0827023b2535",
65+
"type": "leaf",
66+
"state": {
67+
"type": "bookmarks",
68+
"state": {},
69+
"icon": "lucide-bookmark",
70+
"title": "Bookmarks"
71+
}
72+
}
73+
]
74+
}
75+
],
76+
"direction": "horizontal",
77+
"width": 300
78+
},
79+
"right": {
80+
"id": "c3389d21c08cd71c",
81+
"type": "split",
82+
"children": [
83+
{
84+
"id": "11a1174f51a1cf86",
85+
"type": "tabs",
86+
"children": [
87+
{
88+
"id": "bf2a1fb608e63866",
89+
"type": "leaf",
90+
"state": {
91+
"type": "backlink",
92+
"state": {
93+
"collapseAll": false,
94+
"extraContext": false,
95+
"sortOrder": "alphabetical",
96+
"showSearch": false,
97+
"searchQuery": "",
98+
"backlinkCollapsed": false,
99+
"unlinkedCollapsed": true
100+
},
101+
"icon": "links-coming-in",
102+
"title": "Backlinks"
103+
}
104+
},
105+
{
106+
"id": "6f08673b57226dc1",
107+
"type": "leaf",
108+
"state": {
109+
"type": "outgoing-link",
110+
"state": {
111+
"linksCollapsed": false,
112+
"unlinkedCollapsed": true
113+
},
114+
"icon": "links-going-out",
115+
"title": "Outgoing links"
116+
}
117+
},
118+
{
119+
"id": "e987a9643ca3ec81",
120+
"type": "leaf",
121+
"state": {
122+
"type": "tag",
123+
"state": {
124+
"sortOrder": "frequency",
125+
"useHierarchy": true,
126+
"showSearch": false,
127+
"searchQuery": ""
128+
},
129+
"icon": "lucide-tags",
130+
"title": "Tags"
131+
}
132+
},
133+
{
134+
"id": "108a72a022d7e501",
135+
"type": "leaf",
136+
"state": {
137+
"type": "outline",
138+
"state": {
139+
"followCursor": false,
140+
"showSearch": false,
141+
"searchQuery": ""
142+
},
143+
"icon": "lucide-list",
144+
"title": "Outline"
145+
}
146+
}
147+
]
148+
}
149+
],
150+
"direction": "horizontal",
151+
"width": 300,
152+
"collapsed": true
153+
},
154+
"left-ribbon": {
155+
"hiddenItems": {
156+
"publish:Publish changes...": false,
157+
"switcher:Open quick switcher": false,
158+
"graph:Open graph view": false,
159+
"canvas:Create new canvas": false,
160+
"daily-notes:Open today's daily note": false,
161+
"templates:Insert template": false,
162+
"command-palette:Open command palette": false
163+
}
164+
},
165+
"active": "a06f3217ff27ae41",
166+
"lastOpenFiles": []
167+
}

0 commit comments

Comments
 (0)