Skip to content

Commit b6f5d8a

Browse files
committed
update getting started docs
Signed-off-by: phernandez <paul@basicmachines.co>
1 parent addeeb1 commit b6f5d8a

1 file changed

Lines changed: 77 additions & 19 deletions

File tree

docs/Getting Started with Basic Memory.md

Lines changed: 77 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ 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 Protol](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. It can be used with any service that supports the MCP, but Claude Desktop works especially well.
1313

1414
## Installation
1515

@@ -23,19 +23,29 @@ uv install basic-memory
2323
pip install basic-memory
2424
```
2525

26-
> **Important**: You need to install Basic Memory using one of the commands above to use the command line tools. The
27-
`uvx` command mentioned in the Claude Desktop configuration is only for enabling Claude to access Basic Memory.
26+
> **Important**: You need to install Basic Memory using one of the commands above to use the command line tools.
2827
2928
### 2. Configure Claude Desktop
3029

31-
To enable Claude to read and write to your knowledge base, edit the Claude Desktop configuration file (usually at
32-
`~/Library/Application Support/Claude/claude_desktop_config.json`):
30+
Claude Desktop often has trouble finding executables in your user path. Follow these steps for a reliable setup:
31+
32+
#### Step 1: Find the absolute path to uvx
33+
34+
Open Terminal and run:
35+
```bash
36+
which uvx
37+
```
38+
This will show you the full path (e.g., `/Users/yourusername/.cargo/bin/uvx`).
39+
40+
#### Step 2: Edit Claude Desktop Configuration
41+
42+
Edit the configuration file located at `~/Library/Application Support/Claude/claude_desktop_config.json`:
3343

3444
```json
3545
{
3646
"mcpServers": {
3747
"basic-memory": {
38-
"command": "uvx",
48+
"command": "/absolute/path/to/uvx",
3949
"args": [
4050
"basic-memory",
4151
"mcp"
@@ -45,7 +55,13 @@ To enable Claude to read and write to your knowledge base, edit the Claude Deskt
4555
}
4656
```
4757

48-
> **Note**: This configuration uses `uvx` to execute Basic Memory without requiring a full installation in the system python environment.
58+
Replace `/absolute/path/to/uvx` with the actual path you found in Step 1.
59+
60+
> **Note**: Using absolute paths is necessary because Claude Desktop cannot access binaries in your user PATH.
61+
62+
#### Step 3: Restart Claude Desktop
63+
64+
Close and reopen Claude Desktop for the changes to take effect.
4965

5066
### 3. Start the Sync Service
5167

@@ -61,39 +77,81 @@ basic-memory sync --watch
6177

6278
The `--watch` flag enables automatic detection of file changes, keeping your knowledge base current.
6379

64-
### ### Staying Updated
80+
### 4. Staying Updated
6581

6682
To update Basic Memory when new versions are released:
6783

6884
```bash
69-
# Update with uv
85+
# Update with uv (recommended)
7086
uv tool upgrade basic-memory
7187

7288
# Or with pip
73-
pip install --upgrade basic-memory`
89+
pip install --upgrade basic-memory
7490
```
7591

76-
We recommend checking for updates periodically, especially after announcements of new releases.
92+
> **Note**: After updating, you'll need to restart Claude Desktop and your sync process for changes to take effect.
93+
94+
## Troubleshooting Installation
95+
96+
### Common Issues
7797

78-
> **Note**: After updating, you'll need to restart Claude Desktop for it to use the updated version.
98+
#### Claude Says "No Basic Memory Tools Available"
99+
100+
If Claude cannot find Basic Memory tools:
101+
102+
1. **Check absolute paths**: Ensure you're using complete absolute paths to uvx in the Claude Desktop configuration
103+
2. **Verify installation**: Run `basic-memory --version` in Terminal to confirm Basic Memory is installed
104+
3. **Restart applications**: Restart both Terminal and Claude Desktop after making configuration changes
105+
4. **Check sync status**: Ensure `basic-memory sync --watch` is running
106+
107+
#### Permission Issues
108+
109+
If you encounter permission errors:
110+
1. Check that Basic Memory has access to create files in your home directory
111+
2. Ensure Claude Desktop has permission to execute the uvx command
79112

80113
## Creating Your First Knowledge Note
81114

82-
1. **Start a conversation in Claude Desktop** about any topic:
115+
1. **Start the sync process** in a Terminal window:
116+
```bash
117+
basic-memory sync --watch
118+
```
119+
Keep this running in the background.
120+
121+
2. **Open Claude Desktop** and start a new conversation.
122+
123+
3. **Have a natural conversation** about any topic:
83124
```
84125
You: "Let's talk about coffee brewing methods I've been experimenting with."
126+
Claude: "I'd be happy to discuss coffee brewing methods..."
127+
You: "I've found that pour over gives more flavor clarity than French press..."
85128
```
86129

87-
2. **Have a natural conversation** about the topic
88-
89-
3. **Ask Claude to create a note**:
130+
4. **Ask Claude to create a note**:
90131
```
91132
You: "Could you create a note summarizing what we've discussed about coffee brewing?"
92133
```
93134

94-
4. **Claude creates a Markdown file** in your `~/basic-memory` directory
95-
96-
5. **View and edit the file** with any text editor or Obsidian
135+
5. **Confirm note creation**:
136+
Claude will confirm when the note has been created and where it's stored.
137+
138+
6. **View the created file** in your `~/basic-memory` directory using any text editor or Obsidian.
139+
The file structure will look similar to:
140+
```markdown
141+
---
142+
title: Coffee Brewing Methods
143+
permalink: coffee-brewing-methods
144+
---
145+
146+
# Coffee Brewing Methods
147+
148+
## Observations
149+
- [method] Pour over provides more clarity...
150+
- [technique] Water temperature at 205°F...
151+
152+
## Relations
153+
- relates_to [[Other Coffee Topics]]
154+
```
97155

98156
## Using Special Prompts
99157

0 commit comments

Comments
 (0)