basic-memory 0.10.0__tar.gz → 0.11.0__tar.gz

{basic_memory-0.10.0 → basic_memory-0.11.0}/CHANGELOG.md

@@ -1,6 +1,164 @@
 # CHANGELOG
 
 
+## v0.11.0 (2025-03-29)
+
+### Bug Fixes
+
+- Just delete db for reset db instead of using migrations.
+  ([#65](https://github.com/basicmachines-co/basic-memory/pull/65),
+  [`0743ade`](https://github.com/basicmachines-co/basic-memory/commit/0743ade5fc07440f95ecfd816ba7e4cfd74bca12))
+
+Signed-off-by: phernandez <paul@basicmachines.co>
+
+- Make logs for each process - mcp, sync, cli
+  ([#64](https://github.com/basicmachines-co/basic-memory/pull/64),
+  [`f1c9570`](https://github.com/basicmachines-co/basic-memory/commit/f1c95709cbffb1b88292547b0b8f29fcca22d186))
+
+Signed-off-by: phernandez <paul@basicmachines.co>
+
+### Documentation
+
+- Update broken "Multiple Projects" link in README.md
+  ([#55](https://github.com/basicmachines-co/basic-memory/pull/55),
+  [`3c68b7d`](https://github.com/basicmachines-co/basic-memory/commit/3c68b7d5dd689322205c67637dca7d188111ee6b))
+
+### Features
+
+- Add bm command alias for basic-memory
+  ([#67](https://github.com/basicmachines-co/basic-memory/pull/67),
+  [`069c0a2`](https://github.com/basicmachines-co/basic-memory/commit/069c0a21c630784e1bf47d2b7de5d6d1f6fadd7a))
+
+Signed-off-by: phernandez <paul@basicmachines.co>
+
+- Rename search tool to search_notes
+  ([#66](https://github.com/basicmachines-co/basic-memory/pull/66),
+  [`b278276`](https://github.com/basicmachines-co/basic-memory/commit/b27827671dc010be3e261b8b221aca6b7f836661))
+
+Signed-off-by: phernandez <paul@basicmachines.co>
+
+
+## v0.10.1 (2025-03-25)
+
+### Bug Fixes
+
+- Make set_default_project also activate project for current session to fix #37
+  ([`cbe72be`](https://github.com/basicmachines-co/basic-memory/commit/cbe72be10a646c0b03931bb39aff9285feae47f9))
+
+This change makes the 'basic-memory project default <name>' command both: 1. Set the default project
+  for future invocations (persistent change) 2. Activate the project for the current session
+  (immediate change)
+
+Added tests to verify this behavior, which resolves issue #37 where the project name and path
+  weren't changing properly when the default project was changed.
+
+🤖 Generated with [Claude Code](https://claude.ai/code)
+
+Co-Authored-By: Claude <noreply@anthropic.com>
+
+- Make set_default_project also activate project for current session to fix #37
+  ([`46c4fd2`](https://github.com/basicmachines-co/basic-memory/commit/46c4fd21645b109af59eb2a0201c7bd849b34a49))
+
+This change makes the 'basic-memory project default <name>' command both: 1. Set the default project
+  for future invocations (persistent change) 2. Activate the project for the current session
+  (immediate change)
+
+Added tests to verify this behavior, which resolves issue #37 where the project name and path
+  weren't changing properly when the default project was changed.
+
+🤖 Generated with [Claude Code](https://claude.ai/code)
+
+Co-Authored-By: Claude <noreply@anthropic.com>
+
+Signed-off-by: phernandez <paul@basicmachines.co>
+
+- Move ai_assistant_guide.md into package resources to fix #39
+  ([`390ff9d`](https://github.com/basicmachines-co/basic-memory/commit/390ff9d31ccee85bef732e8140b5eeecd7ee176f))
+
+This change relocates the AI assistant guide from the static directory into the package resources
+  directory, ensuring it gets properly included in the distribution package and is accessible when
+  installed via pip/uv.
+
+🤖 Generated with [Claude Code](https://claude.ai/code)
+
+Co-Authored-By: Claude <noreply@anthropic.com>
+
+- Move ai_assistant_guide.md into package resources to fix #39
+  ([`cc2cae7`](https://github.com/basicmachines-co/basic-memory/commit/cc2cae72c14b380f78ffeb67c2261e4dbee45faf))
+
+This change relocates the AI assistant guide from the static directory into the package resources
+  directory, ensuring it gets properly included in the distribution package and is accessible when
+  installed via pip/uv.
+
+🤖 Generated with [Claude Code](https://claude.ai/code)
+
+Co-Authored-By: Claude <noreply@anthropic.com>
+
+Signed-off-by: phernandez <paul@basicmachines.co>
+
+- Preserve custom frontmatter fields when updating notes
+  ([`78f234b`](https://github.com/basicmachines-co/basic-memory/commit/78f234b1806b578a0a833e8ee4184015b7369a97))
+
+Fixes #36 by modifying entity_service.update_entity() to read existing frontmatter from files before
+  updating them. Custom metadata fields such as Status, Priority, and Version are now preserved when
+  notes are updated through the write_note MCP tool.
+
+Added test case that verifies this behavior by creating a note with custom frontmatter and then
+  updating it.
+
+🤖 Generated with [Claude Code](https://claude.ai/code)
+
+Co-Authored-By: Claude <noreply@anthropic.com>
+
+- Preserve custom frontmatter fields when updating notes
+  ([`e716946`](https://github.com/basicmachines-co/basic-memory/commit/e716946b4408d017eca4be720956d5a210b4e6b1))
+
+Fixes #36 by modifying entity_service.update_entity() to read existing frontmatter from files before
+  updating them. Custom metadata fields such as Status, Priority, and Version are now preserved when
+  notes are updated through the write_note MCP tool.
+
+Added test case that verifies this behavior by creating a note with custom frontmatter and then
+  updating it.
+
+🤖 Generated with [Claude Code](https://claude.ai/code)
+
+Co-Authored-By: Claude <noreply@anthropic.com>
+
+Signed-off-by: phernandez <paul@basicmachines.co>
+
+### Chores
+
+- Remove duplicate code in entity_service.py from bad merge
+  ([`681af5d`](https://github.com/basicmachines-co/basic-memory/commit/681af5d4505dadc40b4086630f739d76bac9201d))
+
+Signed-off-by: phernandez <paul@basicmachines.co>
+
+### Documentation
+
+- Add help docs to mcp cli tools
+  ([`731b502`](https://github.com/basicmachines-co/basic-memory/commit/731b502d36cec253d114403d73b48fab3c47786e))
+
+Signed-off-by: phernandez <paul@basicmachines.co>
+
+- Add mcp badge, update cli reference, llms-install.md
+  ([`b26afa9`](https://github.com/basicmachines-co/basic-memory/commit/b26afa927f98021246cd8b64858e57333595ea90))
+
+Signed-off-by: phernandez <paul@basicmachines.co>
+
+- Update CLAUDE.md ([#33](https://github.com/basicmachines-co/basic-memory/pull/33),
+  [`dfaf0fe`](https://github.com/basicmachines-co/basic-memory/commit/dfaf0fea9cf5b97d169d51a6276ec70162c21a7e))
+
+fix spelling in CLAUDE.md: enviroment -> environment Signed-off-by: Ikko Eltociear Ashimine
+  <eltociear@gmail.com>
+
+### Refactoring
+
+- Move project stats into projct subcommand
+  ([`2a881b1`](https://github.com/basicmachines-co/basic-memory/commit/2a881b1425c73947f037fbe7ac5539c015b62526))
+
+Signed-off-by: phernandez <paul@basicmachines.co>
+
+
 ## v0.10.0 (2025-03-15)
 
 ### Bug Fixes

{basic_memory-0.10.0 → basic_memory-0.11.0}/CLAUDE.md

@@ -37,6 +37,7 @@ See the [README.md](README.md) file for a project overview.
 - API uses FastAPI for endpoints
 - Follow the repository pattern for data access
 - Tools communicate to api routers via the httpx ASGI client (in process)
+- avoid using "private" functions in modules or classes (prepended with _)
 
 ### Codebase Architecture
 
@@ -63,7 +64,7 @@ See the [README.md](README.md) file for a project overview.
 - Testing uses pytest with asyncio support (strict mode)
 - Test database uses in-memory SQLite
 - Avoid creating mocks in tests in most circumstances.
-- Each test runs in a standalone enviroment with in memory SQLite and tmp_file directory
+- Each test runs in a standalone environment with in memory SQLite and tmp_file directory
 
 ## BASIC MEMORY PRODUCT USAGE
 
@@ -106,7 +107,7 @@ See the [README.md](README.md) file for a project overview.
       1d", "1 week")
 
   **Search & Discovery:**
-    - `search(query, page, page_size)` - Full-text search across all content with filtering options
+    - `search_notes(query, page, page_size)` - Full-text search across all content with filtering options
 
   **Visualization:**
     - `canvas(nodes, edges, title, folder)` - Generate Obsidian canvas files for knowledge graph visualization
@@ -114,7 +115,7 @@ See the [README.md](README.md) file for a project overview.
 - MCP Prompts for better AI interaction:
     - `ai_assistant_guide()` - Guidance on effectively using Basic Memory tools for AI assistants
     - `continue_conversation(topic, timeframe)` - Continue previous conversations with relevant historical context
-    - `search(query, after_date)` - Search with detailed, formatted results for better context understanding
+    - `search_notes(query, after_date)` - Search with detailed, formatted results for better context understanding
     - `recent_activity(timeframe)` - View recently changed items with formatted output
     - `json_canvas_spec()` - Full JSON Canvas specification for Obsidian visualization
 
@@ -134,30 +135,32 @@ could achieve independently.
 
 ## GitHub Integration
 
-Basic Memory has taken AI-Human collaboration to the next level by integrating Claude directly into the development workflow through GitHub:
+Basic Memory uses Claude directly into the development workflow through GitHub:
 
 ### GitHub MCP Tools
 
-Using the GitHub Model Context Protocol server, Claude can now:
+Using the GitHub Model Context Protocol server, Claude can:
 
 - **Repository Management**:
-  - View repository files and structure
-  - Read file contents
-  - Create new branches
-  - Create and update files
+    - View repository files and structure
+    - Read file contents
+    - Create new branches
+    - Create and update files
 
 - **Issue Management**:
-  - Create new issues
-  - Comment on existing issues
-  - Close and update issues
-  - Search across issues
+    - Create new issues
+    - Comment on existing issues
+    - Close and update issues
+    - Search across issues
 
 - **Pull Request Workflow**:
-  - Create pull requests
-  - Review code changes
-  - Add comments to PRs
+    - Create pull requests
+    - Review code changes
+    - Add comments to PRs
 
-This integration enables Claude to participate as a full team member in the development process, not just as a code generation tool. Claude's GitHub account ([bm-claudeai](https://github.com/bm-claudeai)) is a member of the Basic Machines organization with direct contributor access to the codebase.
+This integration enables Claude to participate as a full team member in the development process, not just as a code
+generation tool. Claude's GitHub account ([bm-claudeai](https://github.com/bm-claudeai)) is a member of the Basic
+Machines organization with direct contributor access to the codebase.
 
 ### Collaborative Development Process
 
@@ -168,4 +171,5 @@ With GitHub integration, the development workflow includes:
 3. **Branch management** - Claude can create feature branches for implementations
 4. **Documentation maintenance** - Claude can keep documentation updated as the code evolves
 
-This level of integration represents a new paradigm in AI-human collaboration, where the AI assistant becomes a full-fledged team member rather than just a tool for generating code snippets.
+With this integration, the AI assistant is a full-fledged team member rather than just a tool for generating code
+snippets.

{basic_memory-0.10.0 → basic_memory-0.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: basic-memory
-Version: 0.10.0
+Version: 0.11.0
 Summary: Local-first knowledge management combining Zettelkasten with knowledge graphs
 Project-URL: Homepage, https://github.com/basicmachines-co/basic-memory
 Project-URL: Repository, https://github.com/basicmachines-co/basic-memory
@@ -37,6 +37,8 @@ Description-Content-Type: text/markdown
 [![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
 [![Tests](https://github.com/basicmachines-co/basic-memory/workflows/Tests/badge.svg)](https://github.com/basicmachines-co/basic-memory/actions)
 [![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)
+![](https://badge.mcpx.dev?type=server 'MCP Server')
+![](https://badge.mcpx.dev?type=dev 'MCP Dev')
 [![smithery badge](https://smithery.ai/badge/@basicmachines-co/basic-memory)](https://smithery.ai/server/@basicmachines-co/basic-memory)
 
 # Basic Memory
@@ -317,7 +319,8 @@ for OS X):
 }
 ```
 
-If you want to use a specific project (see [Multiple Projects](#multiple-projects) below), update your Claude Desktop
+If you want to use a specific project (see [Multiple Projects](docs/User%20Guide.md#multiple-projects)), update your
+Claude Desktop
 config:
 
 ```json
@@ -352,7 +355,7 @@ basic-memory sync --watch
 write_note(title, content, folder, tags) - Create or update notes
 read_note(identifier, page, page_size) - Read notes by title or permalink
 build_context(url, depth, timeframe) - Navigate knowledge graph via memory:// URLs
-search(query, page, page_size) - Search across your knowledge base
+search_notes(query, page, page_size) - Search across your knowledge base
 recent_activity(type, depth, timeframe) - Find recently updated information
 canvas(nodes, edges, title, folder) - Generate knowledge visualizations
 ```
@@ -383,4 +386,14 @@ AGPL-3.0
 Contributions are welcome. See the [Contributing](CONTRIBUTING.md) guide for info about setting up the project locally
 and submitting PRs.
 
-Built with ♥️ by Basic Machines
+## Star History
+
+<a href="https://www.star-history.com/#basicmachines-co/basic-memory&Date">
+ <picture>
+   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=basicmachines-co/basic-memory&type=Date&theme=dark" />
+   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=basicmachines-co/basic-memory&type=Date" />
+   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=basicmachines-co/basic-memory&type=Date" />
+ </picture>
+</a>
+
+Built with ♥️ by Basic Machines

{basic_memory-0.10.0 → basic_memory-0.11.0}/README.md

@@ -3,6 +3,8 @@
 [![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
 [![Tests](https://github.com/basicmachines-co/basic-memory/workflows/Tests/badge.svg)](https://github.com/basicmachines-co/basic-memory/actions)
 [![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)
+![](https://badge.mcpx.dev?type=server 'MCP Server')
+![](https://badge.mcpx.dev?type=dev 'MCP Dev')
 [![smithery badge](https://smithery.ai/badge/@basicmachines-co/basic-memory)](https://smithery.ai/server/@basicmachines-co/basic-memory)
 
 # Basic Memory
@@ -283,7 +285,8 @@ for OS X):
 }
 ```
 
-If you want to use a specific project (see [Multiple Projects](#multiple-projects) below), update your Claude Desktop
+If you want to use a specific project (see [Multiple Projects](docs/User%20Guide.md#multiple-projects)), update your
+Claude Desktop
 config:
 
 ```json
@@ -318,7 +321,7 @@ basic-memory sync --watch
 write_note(title, content, folder, tags) - Create or update notes
 read_note(identifier, page, page_size) - Read notes by title or permalink
 build_context(url, depth, timeframe) - Navigate knowledge graph via memory:// URLs
-search(query, page, page_size) - Search across your knowledge base
+search_notes(query, page, page_size) - Search across your knowledge base
 recent_activity(type, depth, timeframe) - Find recently updated information
 canvas(nodes, edges, title, folder) - Generate knowledge visualizations
 ```
@@ -349,4 +352,14 @@ AGPL-3.0
 Contributions are welcome. See the [Contributing](CONTRIBUTING.md) guide for info about setting up the project locally
 and submitting PRs.
 
-Built with ♥️ by Basic Machines
+## Star History
+
+<a href="https://www.star-history.com/#basicmachines-co/basic-memory&Date">
+ <picture>
+   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=basicmachines-co/basic-memory&type=Date&theme=dark" />
+   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=basicmachines-co/basic-memory&type=Date" />
+   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=basicmachines-co/basic-memory&type=Date" />
+ </picture>
+</a>
+
+Built with ♥️ by Basic Machines

{basic_memory-0.10.0 → basic_memory-0.11.0}/docs/AI Assistant Guide.md

@@ -4,6 +4,8 @@ type: note
 permalink: docs/ai-assistant-guide
 ---
 > Note: This is an optional document that can be copy/pasted into the project knowledge for an LLM to provide a full description of how it can work with Basic Memory. It is provided as a helpful resource. The tools contain extensive usage description prompts with enable the LLM to understand them. 
+
+You can [download](https://github.com/basicmachines-co/basic-memory/blob/main/docs/AI%20Assistant%20Guide.md) the contents of this file from GitHub
 # AI Assistant Guide for Basic Memory
 
 This guide helps you, the AI assistant, use Basic Memory tools effectively when working with users. It covers reading, writing, and navigating knowledge through the Model Context Protocol (MCP).
@@ -51,7 +53,7 @@ content = await read_note("specs/search-design")       # By path
 content = await read_note("memory://specs/search")     # By memory URL
 
 # Searching for knowledge
-results = await search(
+results = await search_notes(
     query="authentication system",      # Text to search for
     page=1,                             # Optional: Pagination
     page_size=10                        # Optional: Results per page
@@ -152,7 +154,7 @@ Users will interact with Basic Memory in patterns like:
    Human: "What were our decisions about auth?"
    
    You: Let me find that information for you.
-   [Use search() to find relevant notes]
+   [Use search_notes() to find relevant notes]
    [Then build_context() to understand connections]
    ```
 
@@ -249,7 +251,7 @@ When creating relations, you can:
 # Example workflow for creating notes with effective relations
 async def create_note_with_effective_relations():
     # Search for existing entities to reference
-    search_results = await search("travel")
+    search_results = await search_notes("travel")
     existing_entities = [result.title for result in search_results.primary_results]
     
     # Check if specific entities exist
@@ -321,7 +323,7 @@ Common issues to watch for:
        content = await read_note("Document")
    except:
        # Try search instead
-       results = await search("Document")
+       results = await search_notes("Document")
        if results and results.primary_results:
            # Found something similar
            content = await read_note(results.primary_results[0].permalink)
@@ -367,7 +369,7 @@ Common issues to watch for:
    - **Create deliberate relations**: Connect each note to at least 2-3 related entities
    - **Use existing entities**: Before creating a new relation, search for existing entities
    - **Verify wikilinks**: When referencing `[[Entity]]`, use exact titles of existing notes
-   - **Check accuracy**: Use `search()` or `recent_activity()` to confirm entity titles
+   - **Check accuracy**: Use `search_notes()` or `recent_activity()` to confirm entity titles
    - **Use precise relation types**: Choose specific relation types that convey meaning (e.g., "implements" instead of "relates_to")
    - **Consider bidirectional relations**: When appropriate, create inverse relations in both entities
 

{basic_memory-0.10.0 → basic_memory-0.11.0}/docs/CLI Reference.md

@@ -21,14 +21,13 @@ basic-memory sync
 # Watch for changes
 basic-memory sync --watch
 
-# Sync specific folder
-basic-memory sync path/to/folder
+# Show detailed sync information
+basic-memory sync --verbose
 ```
 
 Options:
 - `--watch`: Continuously monitor for changes
 - `--verbose`: Show detailed output
-- `PATH`: Optional path to sync (defaults to ~/basic-memory)
 
 ### import
 
@@ -43,13 +42,13 @@ basic-memory import claude projects
 
 # ChatGPT history
 basic-memory import chatgpt
-```
 
-Options:
-- `--folder PATH`: Target folder for imported content
-- `--overwrite`: Replace existing files
-- `--skip-existing`: Keep existing files
+# ChatGPT history
+basic-memory import memory-json /path/to/memory.json
+
+```
 
+> **Note**: After importing, run `basic-memory sync` to index the new files.
 ### status
 
 Shows system status information:
@@ -242,10 +241,12 @@ You can redirect input from a file:
 basic-memory tool write-note --title "Meeting Notes" --folder "meetings" < meeting_notes.md
 ```
 
-#### Integration with Claude Code
+## Integration with Claude Code
 
 This feature works well with Claude Code in the terminal:
 
+### cli
+
 In a Claude Code session, let Claude know he can use the basic-memory tools, then he can execute them via the cli:
 
 ```
@@ -258,6 +259,32 @@ In a Claude Code session, let Claude know he can use the basic-memory tools, the
 
 ```
 
+### MCP
+
+Claude code can also now use mcp tools, so it can use any of the basic-memory tool natively. To install basic-memory in Claude Code:
+
+Run
+```
+claude mcp add basic-memory basic-memory mcp
+```
+
+For example: 
+
+```
+➜  ~ claude mcp add basic-memory basic-memory mcp
+Added stdio MCP server basic-memory with command: basic-memory mcp to project config
+➜  ~ claude mcp list
+basic-memory: basic-memory mcp
+```
+
+You can then use the `/mcp` command in the REPL:
+
+```
+/mcp
+  ⎿  MCP Server Status
+
+     • basic-memory: connected
+```
 
 ## Troubleshooting Common Issues
 

{basic_memory-0.10.0 → basic_memory-0.11.0}/docs/Getting Started with Basic Memory.md

@@ -14,6 +14,10 @@ It can be used with any service that supports the MCP, but Claude Desktop works
 
 ## Installation
 
+### Prerequisites
+
+The easiest way to install basic memory is via `uv`. See the [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/).
+
 ### 1. Install Basic Memory
 
 ```bash
@@ -26,14 +30,32 @@ 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.
+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:
+Edit your Claude Desktop config, located at `~/Library/Application Support/Claude/claude_desktop_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "basic-memory": {
+      "command": "uvx",
+      "args": [
+        "basic-memory",
+        "mcp"
+      ]
+    }
+  }
+}
+```
+
+**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.
+#### 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
+**Step 1: Find the absolute path to uvx**
 
 Open Terminal and run:
 
@@ -43,9 +65,9 @@ which uvx
 
 This will show you the full path (e.g., `/Users/yourusername/.cargo/bin/uvx`).
 
-#### Step 2: Edit Claude Desktop Configuration
+**Step 2: Edit Claude Desktop Configuration**
 
-Edit the configuration file located at `~/Library/Application Support/Claude/claude_desktop_config.json`:
+Edit the Claude Desktop config:
 
 ```json
 {
@@ -63,14 +85,14 @@ Edit the configuration file located at `~/Library/Application Support/Claude/cla
 
 Replace `/absolute/path/to/uvx` with the actual path you found in Step 1.
 
-> **Note**: Using absolute paths is necessary because Claude Desktop cannot access binaries in your user PATH.
-
-#### Step 3: Restart Claude Desktop
+**Step 3: Restart Claude Desktop**
 
 Close and reopen Claude Desktop for the changes to take effect.
 
 ### 3. Start the Sync Service
 
+> Note the sync service is optional. You can run it if you want your local change to be available in Claude Desktop
+
 Start the sync service to monitor your files for changes:
 
 ```bash
@@ -81,7 +103,7 @@ basic-memory sync
 basic-memory sync --watch
 ```
 
-The `--watch` flag enables automatic detection of file changes, keeping your knowledge base current.
+The `--watch` flag enables automatic detection of file changes, updating your knowledge in real time.
 
 ### 4. Staying Updated
 
@@ -97,6 +119,21 @@ pip install --upgrade basic-memory
 
 > **Note**: After updating, you'll need to restart Claude Desktop and your sync process for changes to take effect.
 
+### 5. Change the default project directory
+
+By default, Basic Memory will create a project in the  `basic-memory` folder in your home directory. You can change this via the `project` [[CLI Reference#project|cli command]]. 
+
+```  
+# Add a new project  
+basic-memory project add work ~/work-basic-memory  
+  
+# Set the default project  
+basic-memory project default work  
+
+# List all configured projects  
+basic-memory project list  
+```
+
 ## Troubleshooting Installation
 
 ### Common Issues
@@ -119,30 +156,24 @@ If you encounter permission errors:
 
 ## Creating Your First Knowledge Note
 
-1. **Start the sync process** in a Terminal window:
-   ```bash
-   basic-memory sync --watch
-   ```
-   Keep this running in the background.
+1. **Open Claude Desktop** and start a new conversation.
 
-2. **Open Claude Desktop** and start a new conversation.
-
-3. **Have a natural conversation** about any topic:
+2. **Have a natural conversation** about any topic:
    ```
    You: "Let's talk about coffee brewing methods I've been experimenting with."
    Claude: "I'd be happy to discuss coffee brewing methods..."
    You: "I've found that pour over gives more flavor clarity than French press..."
    ```
 
-4. **Ask Claude to create a note**:
+3. **Ask Claude to create a note**:
    ```
    You: "Could you create a note summarizing what we've discussed about coffee brewing?"
    ```
 
-5. **Confirm note creation**:
+4. **Confirm note creation**:
    Claude will confirm when the note has been created and where it's stored.
 
-6. **View the created file** in your `~/basic-memory` directory using any text editor or Obsidian.
+5. **View the created file** in your `~/basic-memory` directory using any text editor or Obsidian.
    The file structure will look similar to:
    ```markdown
    ---
@@ -160,6 +191,12 @@ If you encounter permission errors:
    - relates_to [[Other Coffee Topics]]
    ```
 
+5. **Start the sync process** in a Terminal window (optional):
+   ```bash
+   basic-memory sync --watch
+   ```
+   Keep this running in the background.
+
 ## Using Special Prompts
 
 Basic Memory includes special prompts that help you start conversations with context from your knowledge base:

{basic_memory-0.10.0 → basic_memory-0.11.0}/docs/Technical Information.md

@@ -196,7 +196,7 @@ flowchart TD
     end
     
     BMCP <-->|"write_note() read_note()"| KnowledgeFiles
-    BMCP <-->|"search() build_context()"| KnowledgeIndex
+    BMCP <-->|"search_notes() build_context()"| KnowledgeIndex
     KnowledgeFiles <-.->|Sync Process| KnowledgeIndex
     KnowledgeFiles <-->|Direct Editing| Editors((Text Editors & Git))