Skip to content

Commit 1d31fc0

Browse files
committed
docs: update docs for v0.12.0 features
Signed-off-by: phernandez <paul@basicmachines.co>
1 parent fa314b5 commit 1d31fc0

3 files changed

Lines changed: 38 additions & 21 deletions

File tree

docs/CLI Reference.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,22 @@ Options:
2929
- `--watch`: Continuously monitor for changes
3030
- `--verbose`: Show detailed output
3131

32+
**Note**:
33+
34+
As of the v0.12.0 release syncing will occur in real time when the mcp process starts.
35+
- The real time sync means that it is no longer necessary to run the `basic-memory sync --watch` process in a a terminal to sync changes to the db (so the AI can see them). This will be done automatically.
36+
37+
This behavior can be changed via the config. The config file for Basic Memory is in the home directory under `.basic-memory/config.json`.
38+
39+
To change the properties, set the following values:
40+
```
41+
~/.basic-memory/config.json
42+
{
43+
"sync_changes": false,
44+
}
45+
```
46+
47+
Thanks for using Basic Memory!
3248
### import
3349

3450
Imports external knowledge sources:

docs/Getting Started with Basic Memory.md

Lines changed: 9 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -89,22 +89,11 @@ Replace `/absolute/path/to/uvx` with the actual path you found in Step 1.
8989

9090
Close and reopen Claude Desktop for the changes to take effect.
9191

92-
### 3. Start the Sync Service
92+
### 3. Sync changes in real time
9393

94-
> Note the sync service is optional. You can run it if you want your local change to be available in Claude Desktop
95-
96-
Start the sync service to monitor your files for changes:
97-
98-
```bash
99-
# One-time sync
100-
basic-memory sync
101-
102-
# For continuous monitoring (recommended)
103-
basic-memory sync --watch
104-
```
105-
106-
The `--watch` flag enables automatic detection of file changes, updating your knowledge in real time.
94+
> **Note**: The service will sync changes from your project directory in real time so they available for the AI assistant.
10795
96+
To disable realtime sync, you can update the config. See [[CLI Reference#sync]].
10897
### 4. Staying Updated
10998

11099
To update Basic Memory when new versions are released:
@@ -145,8 +134,8 @@ If Claude cannot find Basic Memory tools:
145134
1. **Check absolute paths**: Ensure you're using complete absolute paths to uvx in the Claude Desktop configuration
146135
2. **Verify installation**: Run `basic-memory --version` in Terminal to confirm Basic Memory is installed
147136
3. **Restart applications**: Restart both Terminal and Claude Desktop after making configuration changes
148-
4. **Check sync status**: Ensure `basic-memory sync --watch` is running
149-
137+
4. **Check sync status**: You can view the sync status by running `basic-memory status
138+
.
150139
#### Permission Issues
151140

152141
If you encounter permission errors:
@@ -282,15 +271,15 @@ basic-memory import claude conversations
282271
basic-memory import chatgpt
283272
```
284273

285-
After importing, run `basic-memory sync` to index everything.
274+
After importing, the changes will be synced. Initial syncs may take a few moments. You can see info about your project by running `basic-memrory project info`.
286275

287276
## Quick Tips
288277

289-
- Keep `basic-memory sync --watch` running in a terminal window
278+
- Basic Memory will sync changes from your project in real time.
290279
- Use special prompts (Continue Conversation, Recent Activity, Search) to start contextual discussions
291280
- Build connections between notes for a richer knowledge graph
292-
- Use direct memory:// URLs when you need precise context
293-
- Use git to version control your knowledge base
281+
- Use direct `memory://` URLs with a permalink when you need precise context. See [[User Guide#Using memory // URLs]]
282+
- Use git to version control your knowledge base (git integration is on the roadmap)
294283
- Review and edit AI-generated notes for accuracy
295284

296285
## Next Steps

docs/Knowledge Format.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,19 @@ permalink: auth-approaches-2024
144144
---
145145
```
146146

147-
If not specified, one will be generated automatically from the title.
147+
If not specified, one will be generated automatically from the title, if the note has has a frontmatter section.
148+
149+
By default a notes' permalink value will not change if the file is moved. It's a **stable** identifier :). But if you'd rather permalinks are always updated when a file moves, you can set the config setting in the global config.
150+
151+
The config file for Basic Memory is in the home directory under `.basic-memory/config.json`.
152+
153+
To change the behavior, set the following value:
154+
```
155+
~/.basic-memory/config.json
156+
{
157+
"update_permalinks_on_move": true
158+
}
159+
```
148160

149161
### Using memory:// URLs
150162

0 commit comments

Comments
 (0)