Getting Started
Install Basic Memory, configure it with your AI assistant, and create your first knowledge notes
Basic Memory works through the Model Context Protocol (MCP) to connect with AI assistants like Claude. Here’s how to set it up.
Basic Memory uses the Model Context Protocol (MCP) to connect with LLMs. It can be used with any service that supports the MCP, but Claude Desktop works especially well.
Installation
Prerequisites
The easiest way to install basic memory is via uv
. See the uv installation guide.
uv
must be installed and available in your system PATH. Claude Desktop runs in its own isolated environment and needsuv
to manage dependencies.- On macOS, it is recommended to install
uv
globally with Homebrew so that Claude Desktop will detect it:brew install uv
. Installinguv
with other methods may not make it accessible to Claude Desktop.
Configure Claude Desktop
Edit your Claude Desktop config, located at:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json
- Windows:
%APPDATA%\Claude\claude_desktop_config.json
Restart Claude Desktop. You should see Basic Memory tools available in the “tools” menu in Claude Desktop (the little hammer icon in the bottom-right corner of the chat interface). Click it to view available tools.
Install Basic Memory (Optional)
Important: You need to install Basic Memory using one of the commands above to use the command line tools, like import.
Using uv tool install
will install the basic-memory package in a standalone virtual environment. See the UV docs for more info.
Sync changes in real time
The service will sync changes from your project directory in real time so they available for the AI assistant.
To disable realtime sync, you can update the config. See CLI Reference - sync.
Multi-Project Setup
By default, Basic Memory creates a project in ~/basic-memory
. You can switch between projects using tools via the LLM.
Will create a note in the “work notes” project, while leaving the current project active.
Switch to a project and make it active.
Set the default project used at startup.
Creating Your First Knowledge Note
-
Open Claude Desktop and start a new conversation.
-
Have a natural conversation about any topic:
-
Ask Claude to create a note:
-
Confirm note creation: Claude will confirm when the note has been created and where it’s stored.
-
View the created file in your
~/basic-memory
directory using any text editor or Obsidian. The file structure will look similar to:
Using Special Prompts
Basic Memory includes special prompts that help you start conversations with context from your knowledge base:
Continue Conversation
To resume a previous topic:
This prompt triggers Claude to:
- Search your knowledge base for relevant content about coffee brewing
- Build context from these documents
- Resume the conversation with full awareness of previous discussions
Recent Activity
To see what you’ve been working on:
This prompt causes Claude to:
- Retrieve documents modified in the recent past
- Summarize the topics and main points
- Offer to continue any of those discussions
Search
To find specific information:
Claude will:
- Search your knowledge base for relevant documents
- Summarize the key findings
- Offer to explore specific documents in more detail
See User Guide - Using Special Prompts for further information.
Using Your Knowledge Base
Referencing Knowledge
In future conversations, reference your existing knowledge:
Or directly reference notes using memory:// URLs:
Building On Previous Knowledg
Basic Memory enables continuous knowledge building:
- Reference previous discussions in new conversations
- Edit notes incrementally without rewriting entire documents
- Move and organize notes as your knowledge base grows
- Switch between projects instantly during conversations
- Search by tags to find related content quickly
- Create connections between related topics
- Follow relationships to build comprehensive context
Workflow Examples
Incremental Editing:
File Organization:
Project Switching:
Importing Existing Conversations
Import your existing AI conversations using the cli commands:
After importing, changes sync automatically in real-time. You can see project statistics by running basic-memory project info
.
Quick Tips
General Usage
- Basic Memory syncs changes in real-time (no manual sync needed)
- Use special prompts (Continue Conversation, Recent Activity, Search) to start contextual discussions
- Build connections between notes for a richer knowledge graph
- Use direct
memory://
URLs with permalinks for precise context - Review and edit AI-generated notes for accuracy
Next Steps
After getting started, explore these areas:
User Guide
Comprehensive usage instructions
Knowledge Format
Learn how knowledge is structured
Obsidian Integration
Visual knowledge navigation
Canvas Visualizations
Map concepts visually
CLI Reference
Command line tools
OAuth Authentication
Secure remote access (v0.13.0)
Staying Updated
To update Basic Memory when new versions are released:
Fluid project switching
Switch between projects during conversations
Advanced note editing
Edit notes incrementally without rewriting
Smart file management
Move and organize notes with database consistency
Enhanced search
Search with frontmatter tag support
After updating, restart Claude Desktop for changes to take effect. No sync restart needed in v0.13.0.
Troubleshooting Installation
Fix Path to uv
If you get an error that says ENOENT
, this most likely means Claude Desktop could not find your uv
installation. Make sure that you have uv
installed per the instructions above, then:
Step 1: Find the absolute path to uvx
Open Terminal and run:
This will show you the full path (e.g., /Users/yourusername/.cargo/bin/uvx
).
Step 2: Edit Claude Desktop Configuration
Edit the Claude Desktop config:
Replace /absolute/path/to/uvx
with the actual path you found in Step 1.
Step 3: Restart Claude Desktop
Close and reopen Claude Desktop for the changes to take effect.
Claude Says “No Basic Memory Tools Available”
If Claude cannot find Basic Memory tools:
- Check absolute paths: Ensure you’re using complete absolute paths to uvx in the Claude Desktop configuration
- Verify installation: Run
basic-memory --version
in Terminal to confirm Basic Memory is installed - Restart applications: Restart both Terminal and Claude Desktop after making configuration changes
- Check sync status: You can view the sync status by running
basic-memory status
Permission Issues
If you encounter permission errors:
- Check that Basic Memory has access to create files in your home directory
- Ensure Claude Desktop has permission to execute the uvx command