basic-memory 0.10.0__tar.gz → 0.10.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of basic-memory might be problematic. Click here for more details.
- {basic_memory-0.10.0 → basic_memory-0.10.1}/CHANGELOG.md +121 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/CLAUDE.md +20 -16
- {basic_memory-0.10.0 → basic_memory-0.10.1}/PKG-INFO +13 -1
- {basic_memory-0.10.0 → basic_memory-0.10.1}/README.md +12 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/docs/AI Assistant Guide.md +2 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/docs/CLI Reference.md +36 -9
- {basic_memory-0.10.0 → basic_memory-0.10.1}/docs/Getting Started with Basic Memory.md +58 -21
- basic_memory-0.10.1/docs/attachments/disk-ai-logo-400x400.png +0 -0
- basic_memory-0.10.1/llms-install.md +128 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/pyproject.toml +1 -1
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/__init__.py +1 -1
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/cli/commands/__init__.py +1 -2
- basic_memory-0.10.0/src/basic_memory/cli/commands/project_info.py → basic_memory-0.10.1/src/basic_memory/cli/commands/project.py +126 -8
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/cli/commands/tool.py +5 -1
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/markdown/entity_parser.py +13 -10
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/markdown/schemas.py +1 -1
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/prompts/ai_assistant_guide.py +1 -3
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/tools/search.py +2 -2
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/tools/write_note.py +17 -7
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/services/entity_service.py +11 -1
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/sync/watch_service.py +1 -1
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/utils.py +27 -1
- basic_memory-0.10.1/static/ai_assistant_guide.md +413 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/cli/test_project_commands.py +52 -2
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/cli/test_project_info.py +2 -2
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/mcp/test_tool_notes.py +92 -1
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/services/test_entity_service.py +1 -1
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/sync/test_tmp_files.py +53 -50
- basic_memory-0.10.1/tests/utils/test_utf8_handling.py +195 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/uv.lock +218 -189
- basic_memory-0.10.0/src/basic_memory/cli/commands/project.py +0 -119
- {basic_memory-0.10.0 → basic_memory-0.10.1}/.github/ISSUE_TEMPLATE/bug_report.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/.github/ISSUE_TEMPLATE/config.yml +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/.github/ISSUE_TEMPLATE/documentation.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/.github/ISSUE_TEMPLATE/feature_request.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/.github/dependabot.yml +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/.github/workflows/pr-title.yml +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/.github/workflows/release.yml +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/.github/workflows/test.yml +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/.gitignore +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/.python-version +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/CITATION.cff +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/CLA.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/CODE_OF_CONDUCT.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/CONTRIBUTING.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/Dockerfile +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/LICENSE +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/Makefile +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/SECURITY.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/basic-memory.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/docs/Canvas.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/docs/Knowledge Format.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/docs/Obsidian Integration.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/docs/Technical Information.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/docs/User Guide.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/docs/Welcome to Basic memory.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/docs/attachments/Canvas.png +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/docs/attachments/Claude-Obsidian-Demo.mp4 +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/docs/attachments/Prompt.png +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/docs/attachments/disk-ai-logo.png +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/docs/attachments/prompt 1.png +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/docs/attachments/prompt2.png +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/docs/attachments/prompt3.png +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/docs/attachments/prompt4.png +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/docs/publish.js +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/examples/Coffee Notes/Brewing Equipment.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/examples/Coffee Notes/Coffee Bean Origins.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/examples/Coffee Notes/Coffee Brewing Methods.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/examples/Coffee Notes/Coffee Flavor Map.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/examples/Coffee Notes/Coffee Knowledge Base.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/examples/Coffee Notes/Flavor Extraction.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/examples/Coffee Notes/Perfect Pour Over Coffee Method.canvas +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/examples/Coffee Notes/Tasting Notes.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/installer/Basic.icns +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/installer/README.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/installer/icon.svg +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/installer/installer.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/installer/make_icons.sh +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/installer/setup.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/memory.json +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/scripts/install.sh +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/smithery.yaml +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/alembic/alembic.ini +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/alembic/env.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/alembic/migrations.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/alembic/script.py.mako +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/alembic/versions/3dae7c7b1564_initial_schema.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/alembic/versions/502b60eaa905_remove_required_from_entity_permalink.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/alembic/versions/b3c3938bacdb_relation_to_name_unique_index.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/alembic/versions/cc7172b46608_update_search_index_schema.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/api/__init__.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/api/app.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/api/routers/__init__.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/api/routers/knowledge_router.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/api/routers/memory_router.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/api/routers/project_info_router.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/api/routers/resource_router.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/api/routers/search_router.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/cli/__init__.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/cli/app.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/cli/commands/db.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/cli/commands/import_chatgpt.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/cli/commands/import_claude_conversations.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/cli/commands/import_claude_projects.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/cli/commands/import_memory_json.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/cli/commands/mcp.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/cli/commands/status.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/cli/commands/sync.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/cli/main.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/config.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/db.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/deps.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/file_utils.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/markdown/__init__.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/markdown/markdown_processor.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/markdown/plugins.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/markdown/utils.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/__init__.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/async_client.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/main.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/prompts/__init__.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/prompts/continue_conversation.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/prompts/recent_activity.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/prompts/search.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/prompts/utils.py +0 -0
- {basic_memory-0.10.0/static → basic_memory-0.10.1/src/basic_memory/mcp/resources}/ai_assistant_guide.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/server.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/tools/__init__.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/tools/build_context.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/tools/canvas.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/tools/delete_note.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/tools/project_info.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/tools/read_content.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/tools/read_note.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/tools/recent_activity.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/mcp/tools/utils.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/models/__init__.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/models/base.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/models/knowledge.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/models/search.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/repository/__init__.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/repository/entity_repository.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/repository/observation_repository.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/repository/project_info_repository.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/repository/relation_repository.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/repository/repository.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/repository/search_repository.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/schemas/__init__.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/schemas/base.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/schemas/delete.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/schemas/memory.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/schemas/project_info.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/schemas/request.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/schemas/response.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/schemas/search.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/services/__init__.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/services/context_service.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/services/exceptions.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/services/file_service.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/services/link_resolver.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/services/search_service.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/services/service.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/sync/__init__.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/src/basic_memory/sync/sync_service.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/static/json_canvas_spec_1_0.md +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/Non-MarkdownFileSupport.pdf +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/Screenshot.png +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/__init__.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/api/conftest.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/api/test_knowledge_router.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/api/test_memory_router.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/api/test_project_info_router.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/api/test_resource_router.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/api/test_search_router.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/cli/conftest.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/cli/test_cli_tools.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/cli/test_import_chatgpt.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/cli/test_import_claude_conversations.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/cli/test_import_claude_projects.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/cli/test_import_memory_json.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/cli/test_status.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/cli/test_sync.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/cli/test_version.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/conftest.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/edit_file_test.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/markdown/__init__.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/markdown/test_entity_parser.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/markdown/test_markdown_plugins.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/markdown/test_markdown_processor.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/markdown/test_observation_edge_cases.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/markdown/test_parser_edge_cases.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/markdown/test_relation_edge_cases.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/markdown/test_task_detection.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/mcp/conftest.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/mcp/test_prompts.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/mcp/test_resources.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/mcp/test_tool_canvas.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/mcp/test_tool_memory.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/mcp/test_tool_project_info.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/mcp/test_tool_read_note.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/mcp/test_tool_resource.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/mcp/test_tool_search.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/mcp/test_tool_utils.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/repository/test_entity_repository.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/repository/test_observation_repository.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/repository/test_relation_repository.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/repository/test_repository.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/schemas/test_memory_url.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/schemas/test_schemas.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/schemas/test_search.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/services/test_context_service.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/services/test_file_service.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/services/test_link_resolver.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/services/test_search_service.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/sync/test_sync_service.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/sync/test_watch_service.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/sync/test_watch_service_edge_cases.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/test_basic_memory.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/test_config.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/utils/test_file_utils.py +0 -0
- {basic_memory-0.10.0 → basic_memory-0.10.1}/tests/utils/test_permalink_formatting.py +0 -0
|
@@ -1,6 +1,127 @@
|
|
|
1
1
|
# CHANGELOG
|
|
2
2
|
|
|
3
3
|
|
|
4
|
+
## v0.10.1 (2025-03-25)
|
|
5
|
+
|
|
6
|
+
### Bug Fixes
|
|
7
|
+
|
|
8
|
+
- Make set_default_project also activate project for current session to fix #37
|
|
9
|
+
([`cbe72be`](https://github.com/basicmachines-co/basic-memory/commit/cbe72be10a646c0b03931bb39aff9285feae47f9))
|
|
10
|
+
|
|
11
|
+
This change makes the 'basic-memory project default <name>' command both: 1. Set the default project
|
|
12
|
+
for future invocations (persistent change) 2. Activate the project for the current session
|
|
13
|
+
(immediate change)
|
|
14
|
+
|
|
15
|
+
Added tests to verify this behavior, which resolves issue #37 where the project name and path
|
|
16
|
+
weren't changing properly when the default project was changed.
|
|
17
|
+
|
|
18
|
+
🤖 Generated with [Claude Code](https://claude.ai/code)
|
|
19
|
+
|
|
20
|
+
Co-Authored-By: Claude <noreply@anthropic.com>
|
|
21
|
+
|
|
22
|
+
- Make set_default_project also activate project for current session to fix #37
|
|
23
|
+
([`46c4fd2`](https://github.com/basicmachines-co/basic-memory/commit/46c4fd21645b109af59eb2a0201c7bd849b34a49))
|
|
24
|
+
|
|
25
|
+
This change makes the 'basic-memory project default <name>' command both: 1. Set the default project
|
|
26
|
+
for future invocations (persistent change) 2. Activate the project for the current session
|
|
27
|
+
(immediate change)
|
|
28
|
+
|
|
29
|
+
Added tests to verify this behavior, which resolves issue #37 where the project name and path
|
|
30
|
+
weren't changing properly when the default project was changed.
|
|
31
|
+
|
|
32
|
+
🤖 Generated with [Claude Code](https://claude.ai/code)
|
|
33
|
+
|
|
34
|
+
Co-Authored-By: Claude <noreply@anthropic.com>
|
|
35
|
+
|
|
36
|
+
Signed-off-by: phernandez <paul@basicmachines.co>
|
|
37
|
+
|
|
38
|
+
- Move ai_assistant_guide.md into package resources to fix #39
|
|
39
|
+
([`390ff9d`](https://github.com/basicmachines-co/basic-memory/commit/390ff9d31ccee85bef732e8140b5eeecd7ee176f))
|
|
40
|
+
|
|
41
|
+
This change relocates the AI assistant guide from the static directory into the package resources
|
|
42
|
+
directory, ensuring it gets properly included in the distribution package and is accessible when
|
|
43
|
+
installed via pip/uv.
|
|
44
|
+
|
|
45
|
+
🤖 Generated with [Claude Code](https://claude.ai/code)
|
|
46
|
+
|
|
47
|
+
Co-Authored-By: Claude <noreply@anthropic.com>
|
|
48
|
+
|
|
49
|
+
- Move ai_assistant_guide.md into package resources to fix #39
|
|
50
|
+
([`cc2cae7`](https://github.com/basicmachines-co/basic-memory/commit/cc2cae72c14b380f78ffeb67c2261e4dbee45faf))
|
|
51
|
+
|
|
52
|
+
This change relocates the AI assistant guide from the static directory into the package resources
|
|
53
|
+
directory, ensuring it gets properly included in the distribution package and is accessible when
|
|
54
|
+
installed via pip/uv.
|
|
55
|
+
|
|
56
|
+
🤖 Generated with [Claude Code](https://claude.ai/code)
|
|
57
|
+
|
|
58
|
+
Co-Authored-By: Claude <noreply@anthropic.com>
|
|
59
|
+
|
|
60
|
+
Signed-off-by: phernandez <paul@basicmachines.co>
|
|
61
|
+
|
|
62
|
+
- Preserve custom frontmatter fields when updating notes
|
|
63
|
+
([`78f234b`](https://github.com/basicmachines-co/basic-memory/commit/78f234b1806b578a0a833e8ee4184015b7369a97))
|
|
64
|
+
|
|
65
|
+
Fixes #36 by modifying entity_service.update_entity() to read existing frontmatter from files before
|
|
66
|
+
updating them. Custom metadata fields such as Status, Priority, and Version are now preserved when
|
|
67
|
+
notes are updated through the write_note MCP tool.
|
|
68
|
+
|
|
69
|
+
Added test case that verifies this behavior by creating a note with custom frontmatter and then
|
|
70
|
+
updating it.
|
|
71
|
+
|
|
72
|
+
🤖 Generated with [Claude Code](https://claude.ai/code)
|
|
73
|
+
|
|
74
|
+
Co-Authored-By: Claude <noreply@anthropic.com>
|
|
75
|
+
|
|
76
|
+
- Preserve custom frontmatter fields when updating notes
|
|
77
|
+
([`e716946`](https://github.com/basicmachines-co/basic-memory/commit/e716946b4408d017eca4be720956d5a210b4e6b1))
|
|
78
|
+
|
|
79
|
+
Fixes #36 by modifying entity_service.update_entity() to read existing frontmatter from files before
|
|
80
|
+
updating them. Custom metadata fields such as Status, Priority, and Version are now preserved when
|
|
81
|
+
notes are updated through the write_note MCP tool.
|
|
82
|
+
|
|
83
|
+
Added test case that verifies this behavior by creating a note with custom frontmatter and then
|
|
84
|
+
updating it.
|
|
85
|
+
|
|
86
|
+
🤖 Generated with [Claude Code](https://claude.ai/code)
|
|
87
|
+
|
|
88
|
+
Co-Authored-By: Claude <noreply@anthropic.com>
|
|
89
|
+
|
|
90
|
+
Signed-off-by: phernandez <paul@basicmachines.co>
|
|
91
|
+
|
|
92
|
+
### Chores
|
|
93
|
+
|
|
94
|
+
- Remove duplicate code in entity_service.py from bad merge
|
|
95
|
+
([`681af5d`](https://github.com/basicmachines-co/basic-memory/commit/681af5d4505dadc40b4086630f739d76bac9201d))
|
|
96
|
+
|
|
97
|
+
Signed-off-by: phernandez <paul@basicmachines.co>
|
|
98
|
+
|
|
99
|
+
### Documentation
|
|
100
|
+
|
|
101
|
+
- Add help docs to mcp cli tools
|
|
102
|
+
([`731b502`](https://github.com/basicmachines-co/basic-memory/commit/731b502d36cec253d114403d73b48fab3c47786e))
|
|
103
|
+
|
|
104
|
+
Signed-off-by: phernandez <paul@basicmachines.co>
|
|
105
|
+
|
|
106
|
+
- Add mcp badge, update cli reference, llms-install.md
|
|
107
|
+
([`b26afa9`](https://github.com/basicmachines-co/basic-memory/commit/b26afa927f98021246cd8b64858e57333595ea90))
|
|
108
|
+
|
|
109
|
+
Signed-off-by: phernandez <paul@basicmachines.co>
|
|
110
|
+
|
|
111
|
+
- Update CLAUDE.md ([#33](https://github.com/basicmachines-co/basic-memory/pull/33),
|
|
112
|
+
[`dfaf0fe`](https://github.com/basicmachines-co/basic-memory/commit/dfaf0fea9cf5b97d169d51a6276ec70162c21a7e))
|
|
113
|
+
|
|
114
|
+
fix spelling in CLAUDE.md: enviroment -> environment Signed-off-by: Ikko Eltociear Ashimine
|
|
115
|
+
<eltociear@gmail.com>
|
|
116
|
+
|
|
117
|
+
### Refactoring
|
|
118
|
+
|
|
119
|
+
- Move project stats into projct subcommand
|
|
120
|
+
([`2a881b1`](https://github.com/basicmachines-co/basic-memory/commit/2a881b1425c73947f037fbe7ac5539c015b62526))
|
|
121
|
+
|
|
122
|
+
Signed-off-by: phernandez <paul@basicmachines.co>
|
|
123
|
+
|
|
124
|
+
|
|
4
125
|
## v0.10.0 (2025-03-15)
|
|
5
126
|
|
|
6
127
|
### Bug Fixes
|
|
@@ -37,6 +37,7 @@ See the [README.md](README.md) file for a project overview.
|
|
|
37
37
|
- API uses FastAPI for endpoints
|
|
38
38
|
- Follow the repository pattern for data access
|
|
39
39
|
- Tools communicate to api routers via the httpx ASGI client (in process)
|
|
40
|
+
- avoid using "private" functions in modules or classes (prepended with _)
|
|
40
41
|
|
|
41
42
|
### Codebase Architecture
|
|
42
43
|
|
|
@@ -63,7 +64,7 @@ See the [README.md](README.md) file for a project overview.
|
|
|
63
64
|
- Testing uses pytest with asyncio support (strict mode)
|
|
64
65
|
- Test database uses in-memory SQLite
|
|
65
66
|
- Avoid creating mocks in tests in most circumstances.
|
|
66
|
-
- Each test runs in a standalone
|
|
67
|
+
- Each test runs in a standalone environment with in memory SQLite and tmp_file directory
|
|
67
68
|
|
|
68
69
|
## BASIC MEMORY PRODUCT USAGE
|
|
69
70
|
|
|
@@ -134,30 +135,32 @@ could achieve independently.
|
|
|
134
135
|
|
|
135
136
|
## GitHub Integration
|
|
136
137
|
|
|
137
|
-
Basic Memory
|
|
138
|
+
Basic Memory uses Claude directly into the development workflow through GitHub:
|
|
138
139
|
|
|
139
140
|
### GitHub MCP Tools
|
|
140
141
|
|
|
141
|
-
Using the GitHub Model Context Protocol server, Claude can
|
|
142
|
+
Using the GitHub Model Context Protocol server, Claude can:
|
|
142
143
|
|
|
143
144
|
- **Repository Management**:
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
145
|
+
- View repository files and structure
|
|
146
|
+
- Read file contents
|
|
147
|
+
- Create new branches
|
|
148
|
+
- Create and update files
|
|
148
149
|
|
|
149
150
|
- **Issue Management**:
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
151
|
+
- Create new issues
|
|
152
|
+
- Comment on existing issues
|
|
153
|
+
- Close and update issues
|
|
154
|
+
- Search across issues
|
|
154
155
|
|
|
155
156
|
- **Pull Request Workflow**:
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
157
|
+
- Create pull requests
|
|
158
|
+
- Review code changes
|
|
159
|
+
- Add comments to PRs
|
|
159
160
|
|
|
160
|
-
This integration enables Claude to participate as a full team member in the development process, not just as a code
|
|
161
|
+
This integration enables Claude to participate as a full team member in the development process, not just as a code
|
|
162
|
+
generation tool. Claude's GitHub account ([bm-claudeai](https://github.com/bm-claudeai)) is a member of the Basic
|
|
163
|
+
Machines organization with direct contributor access to the codebase.
|
|
161
164
|
|
|
162
165
|
### Collaborative Development Process
|
|
163
166
|
|
|
@@ -168,4 +171,5 @@ With GitHub integration, the development workflow includes:
|
|
|
168
171
|
3. **Branch management** - Claude can create feature branches for implementations
|
|
169
172
|
4. **Documentation maintenance** - Claude can keep documentation updated as the code evolves
|
|
170
173
|
|
|
171
|
-
|
|
174
|
+
With this integration, the AI assistant is a full-fledged team member rather than just a tool for generating code
|
|
175
|
+
snippets.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: basic-memory
|
|
3
|
-
Version: 0.10.
|
|
3
|
+
Version: 0.10.1
|
|
4
4
|
Summary: Local-first knowledge management combining Zettelkasten with knowledge graphs
|
|
5
5
|
Project-URL: Homepage, https://github.com/basicmachines-co/basic-memory
|
|
6
6
|
Project-URL: Repository, https://github.com/basicmachines-co/basic-memory
|
|
@@ -37,6 +37,8 @@ Description-Content-Type: text/markdown
|
|
|
37
37
|
[](https://www.python.org/downloads/)
|
|
38
38
|
[](https://github.com/basicmachines-co/basic-memory/actions)
|
|
39
39
|
[](https://github.com/astral-sh/ruff)
|
|
40
|
+

|
|
41
|
+

|
|
40
42
|
[](https://smithery.ai/server/@basicmachines-co/basic-memory)
|
|
41
43
|
|
|
42
44
|
# Basic Memory
|
|
@@ -383,4 +385,14 @@ AGPL-3.0
|
|
|
383
385
|
Contributions are welcome. See the [Contributing](CONTRIBUTING.md) guide for info about setting up the project locally
|
|
384
386
|
and submitting PRs.
|
|
385
387
|
|
|
388
|
+
## Star History
|
|
389
|
+
|
|
390
|
+
<a href="https://www.star-history.com/#basicmachines-co/basic-memory&Date">
|
|
391
|
+
<picture>
|
|
392
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=basicmachines-co/basic-memory&type=Date&theme=dark" />
|
|
393
|
+
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=basicmachines-co/basic-memory&type=Date" />
|
|
394
|
+
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=basicmachines-co/basic-memory&type=Date" />
|
|
395
|
+
</picture>
|
|
396
|
+
</a>
|
|
397
|
+
|
|
386
398
|
Built with ♥️ by Basic Machines
|
|
@@ -3,6 +3,8 @@
|
|
|
3
3
|
[](https://www.python.org/downloads/)
|
|
4
4
|
[](https://github.com/basicmachines-co/basic-memory/actions)
|
|
5
5
|
[](https://github.com/astral-sh/ruff)
|
|
6
|
+

|
|
7
|
+

|
|
6
8
|
[](https://smithery.ai/server/@basicmachines-co/basic-memory)
|
|
7
9
|
|
|
8
10
|
# Basic Memory
|
|
@@ -349,4 +351,14 @@ AGPL-3.0
|
|
|
349
351
|
Contributions are welcome. See the [Contributing](CONTRIBUTING.md) guide for info about setting up the project locally
|
|
350
352
|
and submitting PRs.
|
|
351
353
|
|
|
354
|
+
## Star History
|
|
355
|
+
|
|
356
|
+
<a href="https://www.star-history.com/#basicmachines-co/basic-memory&Date">
|
|
357
|
+
<picture>
|
|
358
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=basicmachines-co/basic-memory&type=Date&theme=dark" />
|
|
359
|
+
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=basicmachines-co/basic-memory&type=Date" />
|
|
360
|
+
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=basicmachines-co/basic-memory&type=Date" />
|
|
361
|
+
</picture>
|
|
362
|
+
</a>
|
|
363
|
+
|
|
352
364
|
Built with ♥️ by Basic Machines
|
|
@@ -4,6 +4,8 @@ type: note
|
|
|
4
4
|
permalink: docs/ai-assistant-guide
|
|
5
5
|
---
|
|
6
6
|
> 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.
|
|
7
|
+
|
|
8
|
+
You can [download](https://github.com/basicmachines-co/basic-memory/blob/main/docs/AI%20Assistant%20Guide.md) the contents of this file from GitHub
|
|
7
9
|
# AI Assistant Guide for Basic Memory
|
|
8
10
|
|
|
9
11
|
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).
|
|
@@ -21,14 +21,13 @@ basic-memory sync
|
|
|
21
21
|
# Watch for changes
|
|
22
22
|
basic-memory sync --watch
|
|
23
23
|
|
|
24
|
-
#
|
|
25
|
-
basic-memory sync
|
|
24
|
+
# Show detailed sync information
|
|
25
|
+
basic-memory sync --verbose
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
Options:
|
|
29
29
|
- `--watch`: Continuously monitor for changes
|
|
30
30
|
- `--verbose`: Show detailed output
|
|
31
|
-
- `PATH`: Optional path to sync (defaults to ~/basic-memory)
|
|
32
31
|
|
|
33
32
|
### import
|
|
34
33
|
|
|
@@ -43,13 +42,13 @@ basic-memory import claude projects
|
|
|
43
42
|
|
|
44
43
|
# ChatGPT history
|
|
45
44
|
basic-memory import chatgpt
|
|
46
|
-
```
|
|
47
45
|
|
|
48
|
-
|
|
49
|
-
-
|
|
50
|
-
|
|
51
|
-
|
|
46
|
+
# ChatGPT history
|
|
47
|
+
basic-memory import memory-json /path/to/memory.json
|
|
48
|
+
|
|
49
|
+
```
|
|
52
50
|
|
|
51
|
+
> **Note**: After importing, run `basic-memory sync` to index the new files.
|
|
53
52
|
### status
|
|
54
53
|
|
|
55
54
|
Shows system status information:
|
|
@@ -242,10 +241,12 @@ You can redirect input from a file:
|
|
|
242
241
|
basic-memory tool write-note --title "Meeting Notes" --folder "meetings" < meeting_notes.md
|
|
243
242
|
```
|
|
244
243
|
|
|
245
|
-
|
|
244
|
+
## Integration with Claude Code
|
|
246
245
|
|
|
247
246
|
This feature works well with Claude Code in the terminal:
|
|
248
247
|
|
|
248
|
+
### cli
|
|
249
|
+
|
|
249
250
|
In a Claude Code session, let Claude know he can use the basic-memory tools, then he can execute them via the cli:
|
|
250
251
|
|
|
251
252
|
```
|
|
@@ -258,6 +259,32 @@ In a Claude Code session, let Claude know he can use the basic-memory tools, the
|
|
|
258
259
|
|
|
259
260
|
```
|
|
260
261
|
|
|
262
|
+
### MCP
|
|
263
|
+
|
|
264
|
+
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:
|
|
265
|
+
|
|
266
|
+
Run
|
|
267
|
+
```
|
|
268
|
+
claude mcp add basic-memory basic-memory mcp
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
For example:
|
|
272
|
+
|
|
273
|
+
```
|
|
274
|
+
➜ ~ claude mcp add basic-memory basic-memory mcp
|
|
275
|
+
Added stdio MCP server basic-memory with command: basic-memory mcp to project config
|
|
276
|
+
➜ ~ claude mcp list
|
|
277
|
+
basic-memory: basic-memory mcp
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
You can then use the `/mcp` command in the REPL:
|
|
281
|
+
|
|
282
|
+
```
|
|
283
|
+
/mcp
|
|
284
|
+
⎿ MCP Server Status
|
|
285
|
+
|
|
286
|
+
• basic-memory: connected
|
|
287
|
+
```
|
|
261
288
|
|
|
262
289
|
## Troubleshooting Common Issues
|
|
263
290
|
|
|
@@ -14,6 +14,10 @@ It can be used with any service that supports the MCP, but Claude Desktop works
|
|
|
14
14
|
|
|
15
15
|
## Installation
|
|
16
16
|
|
|
17
|
+
### Prerequisites
|
|
18
|
+
|
|
19
|
+
The easiest way to install basic memory is via `uv`. See the [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/).
|
|
20
|
+
|
|
17
21
|
### 1. Install Basic Memory
|
|
18
22
|
|
|
19
23
|
```bash
|
|
@@ -26,14 +30,32 @@ pip install basic-memory
|
|
|
26
30
|
|
|
27
31
|
> **Important**: You need to install Basic Memory using one of the commands above to use the command line tools.
|
|
28
32
|
|
|
29
|
-
Using `uv tool install` will install the basic-memory package in a standalone virtual environment.
|
|
30
|
-
See the [UV docs](https://docs.astral.sh/uv/concepts/tools/) for more info.
|
|
33
|
+
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.
|
|
31
34
|
|
|
32
35
|
### 2. Configure Claude Desktop
|
|
33
36
|
|
|
34
|
-
Claude Desktop
|
|
37
|
+
Edit your Claude Desktop config, located at `~/Library/Application Support/Claude/claude_desktop_config.json`:
|
|
38
|
+
|
|
39
|
+
```json
|
|
40
|
+
{
|
|
41
|
+
"mcpServers": {
|
|
42
|
+
"basic-memory": {
|
|
43
|
+
"command": "uvx",
|
|
44
|
+
"args": [
|
|
45
|
+
"basic-memory",
|
|
46
|
+
"mcp"
|
|
47
|
+
]
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
**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.
|
|
54
|
+
#### Fix Path to uv
|
|
55
|
+
|
|
56
|
+
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:
|
|
35
57
|
|
|
36
|
-
|
|
58
|
+
**Step 1: Find the absolute path to uvx**
|
|
37
59
|
|
|
38
60
|
Open Terminal and run:
|
|
39
61
|
|
|
@@ -43,9 +65,9 @@ which uvx
|
|
|
43
65
|
|
|
44
66
|
This will show you the full path (e.g., `/Users/yourusername/.cargo/bin/uvx`).
|
|
45
67
|
|
|
46
|
-
|
|
68
|
+
**Step 2: Edit Claude Desktop Configuration**
|
|
47
69
|
|
|
48
|
-
Edit the
|
|
70
|
+
Edit the Claude Desktop config:
|
|
49
71
|
|
|
50
72
|
```json
|
|
51
73
|
{
|
|
@@ -63,14 +85,14 @@ Edit the configuration file located at `~/Library/Application Support/Claude/cla
|
|
|
63
85
|
|
|
64
86
|
Replace `/absolute/path/to/uvx` with the actual path you found in Step 1.
|
|
65
87
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
#### Step 3: Restart Claude Desktop
|
|
88
|
+
**Step 3: Restart Claude Desktop**
|
|
69
89
|
|
|
70
90
|
Close and reopen Claude Desktop for the changes to take effect.
|
|
71
91
|
|
|
72
92
|
### 3. Start the Sync Service
|
|
73
93
|
|
|
94
|
+
> Note the sync service is optional. You can run it if you want your local change to be available in Claude Desktop
|
|
95
|
+
|
|
74
96
|
Start the sync service to monitor your files for changes:
|
|
75
97
|
|
|
76
98
|
```bash
|
|
@@ -81,7 +103,7 @@ basic-memory sync
|
|
|
81
103
|
basic-memory sync --watch
|
|
82
104
|
```
|
|
83
105
|
|
|
84
|
-
The `--watch` flag enables automatic detection of file changes,
|
|
106
|
+
The `--watch` flag enables automatic detection of file changes, updating your knowledge in real time.
|
|
85
107
|
|
|
86
108
|
### 4. Staying Updated
|
|
87
109
|
|
|
@@ -97,6 +119,21 @@ pip install --upgrade basic-memory
|
|
|
97
119
|
|
|
98
120
|
> **Note**: After updating, you'll need to restart Claude Desktop and your sync process for changes to take effect.
|
|
99
121
|
|
|
122
|
+
### 5. Change the default project directory
|
|
123
|
+
|
|
124
|
+
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]].
|
|
125
|
+
|
|
126
|
+
```
|
|
127
|
+
# Add a new project
|
|
128
|
+
basic-memory project add work ~/work-basic-memory
|
|
129
|
+
|
|
130
|
+
# Set the default project
|
|
131
|
+
basic-memory project default work
|
|
132
|
+
|
|
133
|
+
# List all configured projects
|
|
134
|
+
basic-memory project list
|
|
135
|
+
```
|
|
136
|
+
|
|
100
137
|
## Troubleshooting Installation
|
|
101
138
|
|
|
102
139
|
### Common Issues
|
|
@@ -119,30 +156,24 @@ If you encounter permission errors:
|
|
|
119
156
|
|
|
120
157
|
## Creating Your First Knowledge Note
|
|
121
158
|
|
|
122
|
-
1. **
|
|
123
|
-
```bash
|
|
124
|
-
basic-memory sync --watch
|
|
125
|
-
```
|
|
126
|
-
Keep this running in the background.
|
|
159
|
+
1. **Open Claude Desktop** and start a new conversation.
|
|
127
160
|
|
|
128
|
-
2. **
|
|
129
|
-
|
|
130
|
-
3. **Have a natural conversation** about any topic:
|
|
161
|
+
2. **Have a natural conversation** about any topic:
|
|
131
162
|
```
|
|
132
163
|
You: "Let's talk about coffee brewing methods I've been experimenting with."
|
|
133
164
|
Claude: "I'd be happy to discuss coffee brewing methods..."
|
|
134
165
|
You: "I've found that pour over gives more flavor clarity than French press..."
|
|
135
166
|
```
|
|
136
167
|
|
|
137
|
-
|
|
168
|
+
3. **Ask Claude to create a note**:
|
|
138
169
|
```
|
|
139
170
|
You: "Could you create a note summarizing what we've discussed about coffee brewing?"
|
|
140
171
|
```
|
|
141
172
|
|
|
142
|
-
|
|
173
|
+
4. **Confirm note creation**:
|
|
143
174
|
Claude will confirm when the note has been created and where it's stored.
|
|
144
175
|
|
|
145
|
-
|
|
176
|
+
5. **View the created file** in your `~/basic-memory` directory using any text editor or Obsidian.
|
|
146
177
|
The file structure will look similar to:
|
|
147
178
|
```markdown
|
|
148
179
|
---
|
|
@@ -160,6 +191,12 @@ If you encounter permission errors:
|
|
|
160
191
|
- relates_to [[Other Coffee Topics]]
|
|
161
192
|
```
|
|
162
193
|
|
|
194
|
+
5. **Start the sync process** in a Terminal window (optional):
|
|
195
|
+
```bash
|
|
196
|
+
basic-memory sync --watch
|
|
197
|
+
```
|
|
198
|
+
Keep this running in the background.
|
|
199
|
+
|
|
163
200
|
## Using Special Prompts
|
|
164
201
|
|
|
165
202
|
Basic Memory includes special prompts that help you start conversations with context from your knowledge base:
|
|
Binary file
|
|
@@ -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/).
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"""CLI commands for basic-memory."""
|
|
2
2
|
|
|
3
3
|
from . import status, sync, db, import_memory_json, mcp, import_claude_conversations
|
|
4
|
-
from . import import_claude_projects, import_chatgpt, tool, project
|
|
4
|
+
from . import import_claude_projects, import_chatgpt, tool, project
|
|
5
5
|
|
|
6
6
|
__all__ = [
|
|
7
7
|
"status",
|
|
@@ -14,5 +14,4 @@ __all__ = [
|
|
|
14
14
|
"import_chatgpt",
|
|
15
15
|
"tool",
|
|
16
16
|
"project",
|
|
17
|
-
"project_info",
|
|
18
17
|
]
|