Skip to content

Commit b26afa9

Browse files
committed
docs: add mcp badge, update cli reference, llms-install.md
Signed-off-by: phernandez <paul@basicmachines.co>
1 parent 3806943 commit b26afa9

3 files changed

Lines changed: 137 additions & 8 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
44
[![Tests](https://github.com/basicmachines-co/basic-memory/workflows/Tests/badge.svg)](https://github.com/basicmachines-co/basic-memory/actions)
55
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
6+
![](https://badge.mcpx.dev?type=server 'MCP Server')
7+
![](https://badge.mcpx.dev?type=dev 'MCP Dev')
68
[![smithery badge](https://smithery.ai/badge/@basicmachines-co/basic-memory)](https://smithery.ai/server/@basicmachines-co/basic-memory)
79

810
# Basic Memory

docs/CLI Reference.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,13 @@ basic-memory sync
2121
# Watch for changes
2222
basic-memory sync --watch
2323

24-
# Sync specific folder
25-
basic-memory sync path/to/folder
24+
# Show detailed sync information
25+
basic-memory sync --verbose
2626
```
2727

2828
Options:
2929
- `--watch`: Continuously monitor for changes
3030
- `--verbose`: Show detailed output
31-
- `PATH`: Optional path to sync (defaults to ~/basic-memory)
3231

3332
### import
3433

@@ -43,13 +42,13 @@ basic-memory import claude projects
4342

4443
# ChatGPT history
4544
basic-memory import chatgpt
46-
```
4745

48-
Options:
49-
- `--folder PATH`: Target folder for imported content
50-
- `--overwrite`: Replace existing files
51-
- `--skip-existing`: Keep existing files
46+
# ChatGPT history
47+
basic-memory import memory-json /path/to/memory.json
48+
49+
```
5250

51+
> **Note**: After importing, run `basic-memory sync` to index the new files.
5352
### status
5453

5554
Shows system status information:

llms-install.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Basic Memory Installation Guide for LLMs
2+
3+
This guide is specifically designed to help AI assistants like Cline install and configure Basic Memory. Follow these
4+
steps in order.
5+
6+
## Installation Steps
7+
8+
### 1. Install Basic Memory Package
9+
10+
Use one of the following package managers to install:
11+
12+
```bash
13+
# Install with uv (recommended)
14+
uv tool install basic-memory
15+
16+
# Or with pip
17+
pip install basic-memory
18+
```
19+
20+
### 2. Configure MCP Server
21+
22+
Add the following to your config:
23+
24+
```json
25+
{
26+
"mcpServers": {
27+
"basic-memory": {
28+
"command": "uvx",
29+
"args": [
30+
"basic-memory",
31+
"mcp"
32+
]
33+
}
34+
}
35+
}
36+
```
37+
38+
For Claude Desktop, this file is located at:
39+
40+
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
41+
Windows: %APPDATA%\Claude\claude_desktop_config.json
42+
43+
### 3. Start Synchronization (optional)
44+
45+
To synchronize files in real-time, run:
46+
47+
```bash
48+
basic-memory sync --watch
49+
```
50+
51+
Or for a one-time sync:
52+
53+
```bash
54+
basic-memory sync
55+
```
56+
57+
## Configuration Options
58+
59+
### Custom Directory
60+
61+
To use a directory other than the default `~/basic-memory`:
62+
63+
```bash
64+
basic-memory project add custom-project /path/to/your/directory
65+
basic-memory project default custom-project
66+
```
67+
68+
### Multiple Projects
69+
70+
To manage multiple knowledge bases:
71+
72+
```bash
73+
# List all projects
74+
basic-memory project list
75+
76+
# Add a new project
77+
basic-memory project add work ~/work-basic-memory
78+
79+
# Set default project
80+
basic-memory project default work
81+
```
82+
83+
## Importing Existing Data
84+
85+
### From Claude.ai
86+
87+
```bash
88+
basic-memory import claude conversations path/to/conversations.json
89+
basic-memory import claude projects path/to/projects.json
90+
```
91+
92+
### From ChatGPT
93+
94+
```bash
95+
basic-memory import chatgpt path/to/conversations.json
96+
```
97+
98+
### From MCP Memory Server
99+
100+
```bash
101+
basic-memory import memory-json path/to/memory.json
102+
```
103+
104+
## Troubleshooting
105+
106+
If you encounter issues:
107+
108+
1. Check that Basic Memory is properly installed:
109+
```bash
110+
basic-memory --version
111+
```
112+
113+
2. Verify the sync process is running:
114+
```bash
115+
ps aux | grep basic-memory
116+
```
117+
118+
3. Check sync output for errors:
119+
```bash
120+
basic-memory sync --verbose
121+
```
122+
123+
4. Check log output:
124+
```bash
125+
cat ~/.basic-memory/basic-memory.log
126+
```
127+
128+
For more detailed information, refer to the [full documentation](https://memory.basicmachines.co/).

0 commit comments

Comments
 (0)