Skip to content

Commit 43cbb7b

Browse files
authored
docs: Add VS Code instructions to README (#76)
1 parent 7930ddb commit 43cbb7b

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,43 @@ Examples of relations:
262262
- documented_in [[Coffee Journal]]
263263
```
264264

265+
## Using with VS Code
266+
For one-click installation, click one of the install buttons below...
267+
268+
[![Install with UV in VS Code](https://img.shields.io/badge/VS_Code-UV-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=basic-memory&config=%7B%22command%22%3A%22uvx%22%2C%22args%22%3A%5B%22basic-memory%22%2C%22mcp%22%5D%7D) [![Install with UV in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-UV-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=basic-memory&config=%7B%22command%22%3A%22uvx%22%2C%22args%22%3A%5B%22basic-memory%22%2C%22mcp%22%5D%7D&quality=insiders)
269+
270+
You can use Basic Memory with VS Code to easily retrieve and store information while coding. Click the installation buttons above for one-click setup, or follow the manual installation instructions below.
271+
272+
### Manual Installation
273+
274+
Add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing `Ctrl + Shift + P` and typing `Preferences: Open User Settings (JSON)`.
275+
276+
```json
277+
{
278+
"mcp": {
279+
"servers": {
280+
"basic-memory": {
281+
"command": "uvx",
282+
"args": ["basic-memory", "mcp"]
283+
}
284+
}
285+
}
286+
}
287+
```
288+
289+
Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace. This will allow you to share the configuration with others.
290+
291+
```json
292+
{
293+
"servers": {
294+
"basic-memory": {
295+
"command": "uvx",
296+
"args": ["basic-memory", "mcp"]
297+
}
298+
}
299+
}
300+
```
301+
265302
## Using with Claude Desktop
266303

267304
Basic Memory is built using the MCP (Model Context Protocol) and works with the Claude desktop app (https://claude.ai/):

0 commit comments

Comments
 (0)