From 9af913da4fba7bb4908caa3f15f2db2aa03777ec Mon Sep 17 00:00:00 2001 From: Paul Hernandez <60959+phernandez@users.noreply.github.com> Date: Thu, 13 Mar 2025 13:24:39 -0500 Subject: [PATCH 1/2] docs: add glama badge. Fix typos in README.md (#28) Signed-off-by: phernandez --- README.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index bce8cafd..a358167c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -# Basic Memory - [![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0) [![PyPI version](https://badge.fury.io/py/basic-memory.svg)](https://badge.fury.io/py/basic-memory) [![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/) @@ -7,6 +5,14 @@ [![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) [![smithery badge](https://smithery.ai/badge/@basicmachines-co/basic-memory)](https://smithery.ai/server/@basicmachines-co/basic-memory) +## Glama.ai + + + basic-memory MCP server + + +# Basic Memory + Basic Memory lets you build persistent knowledge through natural conversations with Large Language Models (LLMs) like Claude, while keeping everything in simple Markdown files on your computer. It uses the Model Context Protocol (MCP) to enable any compatible LLM to read and write to your local knowledge base. @@ -24,7 +30,7 @@ incorporate human edits made directly to knowledge files. ```bash # Install with uv (recommended) -uv install basic-memory +uv tool install basic-memory # Configure Claude Desktop (edit ~/Library/Application Support/Claude/claude_desktop_config.json) # Add this to your config: @@ -50,13 +56,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 @@ -85,7 +93,7 @@ basic-memory project list └────────┴──────────────────────────────────────────────────┴─────────┴────────┘ ``` -Basic Memory will write notes in Markdown format. Open you project directory in your text editor to view project files +Basic Memory will write notes in Markdown format. Open your project directory in your text editor to view project files while you have conversations with an LLM. ## Why Basic Memory? @@ -219,7 +227,7 @@ Following relation 'requires [[Proper Grinding Technique]]': Each related document can lead to more context, building a rich semantic understanding of your knowledge base. All of this context comes from standard Markdown files that both humans and LLMs can read and write. -Every time the LLM writes notes,they are saved in local Markdown files that you can: +Every time the LLM writes notes, they are saved in local Markdown files that you can: - Edit in any text editor - Version via git @@ -260,7 +268,7 @@ permalink: Observations are facts about a topic. They can be added by creating a Markdown list with a special format that can reference a `category`, `tags` using a -"#" charactor, and an optional `context`. +"#" character, and an optional `context`. Observation Markdown format: From 3070ade69a905dab766d7bcf42aac20b5d2874c5 Mon Sep 17 00:00:00 2001 From: Paul Hernandez <60959+phernandez@users.noreply.github.com> Date: Sat, 15 Mar 2025 10:34:53 -0500 Subject: [PATCH 2/2] Create dependabot.yml Signed-off-by: Paul Hernandez <60959+phernandez@users.noreply.github.com> --- .github/dependabot.yml | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000..d698d8d0 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,12 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file + +version: 2 +updates: + - package-ecosystem: "" # See documentation for possible values + directory: "/" # Location of package manifests + schedule: + interval: "weekly" +