Skip to content

Commit 4cbda7a

Browse files
committed
update docs
Signed-off-by: phernandez <paul@basicmachines.co>
1 parent 7b7bec9 commit 4cbda7a

8 files changed

Lines changed: 25 additions & 10 deletions

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,5 @@ ENV/
4646

4747
# obsidian docs:
4848
/docs/.obsidian/
49-
/examples/.obsidian/
49+
/examples/.obsidian/
50+
/examples/.basic-memory/

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ enable any compatible LLM to read and write to your local knowledge base.
1414
- Website: http://basicmachines.co
1515
- Documentation: http://memory.basicmachines.co
1616

17-
![Example Gif](docs/attachments/Obsidian-CoffeeKnowledgeBase-examples-overlays.gif)
17+
![Deno](docs/attachments/Claude-Obsidian-Demo.mp4)
1818

1919
Basic Memory provides persistent contextual awareness across sessions through a structured knowledge graph.
2020
The system enables LLMs to access and reference prior conversations, track semantic relationships between concepts, and
@@ -50,13 +50,15 @@ You can view shared context via files in `~/basic-memory` (default directory loc
5050

5151
### Alternative Installation via Smithery
5252

53-
You can use [Smithery](https://smithery.ai/server/@basicmachines-co/basic-memory) to automatically configure Basic Memory for Claude Desktop:
53+
You can use [Smithery](https://smithery.ai/server/@basicmachines-co/basic-memory) to automatically configure Basic
54+
Memory for Claude Desktop:
5455

5556
```bash
5657
npx -y @smithery/cli install @basicmachines-co/basic-memory --client claude
5758
```
5859

59-
This installs and configures Basic Memory without requiring manual edits to the Claude Desktop configuration file. The Smithery server hosts the MCP server component, while your data remains stored locally as Markdown files.
60+
This installs and configures Basic Memory without requiring manual edits to the Claude Desktop configuration file. The
61+
Smithery server hosts the MCP server component, while your data remains stored locally as Markdown files.
6062

6163
### CLI Tools
6264

docs/Getting Started with Basic Memory.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,32 +9,38 @@ permalink: docs/getting-started
99
This guide will help you install Basic Memory, configure it with Claude Desktop, and create your first knowledge notes
1010
through conversations.
1111

12-
Basic Memory uses the [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP) to connect with LLMs. It can be used with any service that supports the MCP, but Claude Desktop works especially well.
12+
Basic Memory uses the [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP) to connect with LLMs.
13+
It can be used with any service that supports the MCP, but Claude Desktop works especially well.
1314

1415
## Installation
1516

1617
### 1. Install Basic Memory
1718

1819
```bash
19-
# Install with uv (recommended)
20-
uv install basic-memory
20+
# Install with uv (recommended).
21+
uv tool install basic-memory
2122

2223
# Or with pip
2324
pip install basic-memory
2425
```
2526

2627
> **Important**: You need to install Basic Memory using one of the commands above to use the command line tools.
2728
29+
Using `uv tool install` will install the basic-memory package in a standalone virtual environment.
30+
See the [UV docs](https://docs.astral.sh/uv/concepts/tools/) for more info.
31+
2832
### 2. Configure Claude Desktop
2933

3034
Claude Desktop often has trouble finding executables in your user path. Follow these steps for a reliable setup:
3135

3236
#### Step 1: Find the absolute path to uvx
3337

3438
Open Terminal and run:
39+
3540
```bash
3641
which uvx
3742
```
43+
3844
This will show you the full path (e.g., `/Users/yourusername/.cargo/bin/uvx`).
3945

4046
#### Step 2: Edit Claude Desktop Configuration
@@ -107,6 +113,7 @@ If Claude cannot find Basic Memory tools:
107113
#### Permission Issues
108114

109115
If you encounter permission errors:
116+
110117
1. Check that Basic Memory has access to create files in your home directory
111118
2. Ensure Claude Desktop has permission to execute the uvx command
112119

docs/Welcome to Basic memory.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,15 @@ Basic Memory connects you and AI assistants through shared knowledge:
2121
3. **Enables knowledge reuse** across different conversations and sessions
2222
4. **Maintains persistence** through local files you control completely
2323

24-
Both you and AI assistants like Claude can read from and write to the same knowledge base, creating a continuous
25-
learning environment where each conversation builds upon previous ones.
24+
Both you and AI assistants like Claude can read from and write to the same knowledge base, creating a continuous learning environment where each conversation builds upon previous ones.
2625

27-
![[Obsidian-CoffeeKnowledgeBase-examples-overlays.gif]]
26+
## Pick up your conversation right where you left off
27+
28+
![[Claude-Obsidian-Demo.mp4]]
29+
30+
- AI assistants can load context from local files in a new conversation
31+
- Notes are saved locally as Markdown files in real time
32+
- No project knowledge or special prompting required
2833

2934
Basic Memory uses:
3035

21.4 MB
Binary file not shown.
Binary file not shown.
-2.24 MB
Binary file not shown.

examples/.basic-memory/memory.db

-2.25 MB
Binary file not shown.

0 commit comments

Comments
 (0)