diff --git a/.gitignore b/.gitignore index 30de771a..fd5d0ed9 100644 --- a/.gitignore +++ b/.gitignore @@ -46,4 +46,5 @@ ENV/ # obsidian docs: /docs/.obsidian/ -/examples/.obsidian/ \ No newline at end of file +/examples/.obsidian/ +/examples/.basic-memory/ \ No newline at end of file diff --git a/README.md b/README.md index bce8cafd..216deab7 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ enable any compatible LLM to read and write to your local knowledge base. - Website: http://basicmachines.co - Documentation: http://memory.basicmachines.co -![Example Gif](docs/attachments/Obsidian-CoffeeKnowledgeBase-examples-overlays.gif) +![Deno](docs/attachments/Claude-Obsidian-Demo.mp4) Basic Memory provides persistent contextual awareness across sessions through a structured knowledge graph. 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 ### Alternative Installation via Smithery -You can use [Smithery](https://smithery.ai/server/@basicmachines-co/basic-memory) to automatically configure Basic Memory for Claude Desktop: +You can use [Smithery](https://smithery.ai/server/@basicmachines-co/basic-memory) to automatically configure Basic +Memory for Claude Desktop: ```bash npx -y @smithery/cli install @basicmachines-co/basic-memory --client claude ``` -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. +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. ### CLI Tools diff --git a/docs/Getting Started with Basic Memory.md b/docs/Getting Started with Basic Memory.md index ecfb0350..867daa4b 100644 --- a/docs/Getting Started with Basic Memory.md +++ b/docs/Getting Started with Basic Memory.md @@ -9,15 +9,16 @@ permalink: docs/getting-started This guide will help you install Basic Memory, configure it with Claude Desktop, and create your first knowledge notes through conversations. -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. +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. ## Installation ### 1. Install Basic Memory ```bash -# Install with uv (recommended) -uv install basic-memory +# Install with uv (recommended). +uv tool install basic-memory # Or with pip pip install basic-memory @@ -25,6 +26,9 @@ pip install basic-memory > **Important**: You need to install Basic Memory using one of the commands above to use the command line tools. +Using `uv tool install` will install the basic-memory package in a standalone virtual environment. +See the [UV docs](https://docs.astral.sh/uv/concepts/tools/) for more info. + ### 2. Configure Claude Desktop Claude Desktop often has trouble finding executables in your user path. Follow these steps for a reliable setup: @@ -32,9 +36,11 @@ Claude Desktop often has trouble finding executables in your user path. Follow t #### Step 1: Find the absolute path to uvx Open Terminal and run: + ```bash which uvx ``` + This will show you the full path (e.g., `/Users/yourusername/.cargo/bin/uvx`). #### Step 2: Edit Claude Desktop Configuration @@ -107,6 +113,7 @@ If Claude cannot find Basic Memory tools: #### Permission Issues If you encounter permission errors: + 1. Check that Basic Memory has access to create files in your home directory 2. Ensure Claude Desktop has permission to execute the uvx command diff --git a/docs/Welcome to Basic memory.md b/docs/Welcome to Basic memory.md index afb2f072..a2bfe6d5 100644 --- a/docs/Welcome to Basic memory.md +++ b/docs/Welcome to Basic memory.md @@ -21,10 +21,15 @@ Basic Memory connects you and AI assistants through shared knowledge: 3. **Enables knowledge reuse** across different conversations and sessions 4. **Maintains persistence** through local files you control completely -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. +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. -![[Obsidian-CoffeeKnowledgeBase-examples-overlays.gif]] +## Pick up your conversation right where you left off + +![[Claude-Obsidian-Demo.mp4]] + +- AI assistants can load context from local files in a new conversation +- Notes are saved locally as Markdown files in real time +- No project knowledge or special prompting required Basic Memory uses: diff --git a/docs/attachments/Claude-Obsidian-Demo.mp4 b/docs/attachments/Claude-Obsidian-Demo.mp4 new file mode 100644 index 00000000..8fe66ceb Binary files /dev/null and b/docs/attachments/Claude-Obsidian-Demo.mp4 differ diff --git a/docs/attachments/Obsidian-CoffeeKnowledgeBase-examples-overlays.gif b/docs/attachments/Obsidian-CoffeeKnowledgeBase-examples-overlays.gif deleted file mode 100644 index 2d67f98b..00000000 Binary files a/docs/attachments/Obsidian-CoffeeKnowledgeBase-examples-overlays.gif and /dev/null differ diff --git a/docs/attachments/Obsidian-CoffeeKnowledgeBase-examples.gif b/docs/attachments/Obsidian-CoffeeKnowledgeBase-examples.gif deleted file mode 100644 index a18617e6..00000000 Binary files a/docs/attachments/Obsidian-CoffeeKnowledgeBase-examples.gif and /dev/null differ diff --git a/examples/.basic-memory/memory.db b/examples/.basic-memory/memory.db deleted file mode 100644 index f956b79a..00000000 Binary files a/examples/.basic-memory/memory.db and /dev/null differ