From b26afa927f98021246cd8b64858e57333595ea90 Mon Sep 17 00:00:00 2001
From: phernandez <paul@basicmachines.co>
Date: Sun, 16 Mar 2025 14:09:08 -0500
Subject: [PATCH] docs: add mcp badge, update cli reference, llms-install.md

Signed-off-by: phernandez <paul@basicmachines.co>
---
 README.md             |   2 +
 docs/CLI Reference.md |  15 +++--
 llms-install.md       | 128 ++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 137 insertions(+), 8 deletions(-)
 create mode 100644 llms-install.md

diff --git a/README.md b/README.md
index 4cf686b9..e2b890d8 100644
--- a/README.md
+++ b/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
diff --git a/docs/CLI Reference.md b/docs/CLI Reference.md
index 9b1be9c3..3cc977e5 100644
--- a/docs/CLI Reference.md	
+++ b/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
+
+# ChatGPT history
+basic-memory import memory-json /path/to/memory.json
+
 ```
 
-Options:
-- `--folder PATH`: Target folder for imported content
-- `--overwrite`: Replace existing files
-- `--skip-existing`: Keep existing files
-
+> **Note**: After importing, run `basic-memory sync` to index the new files.
 ### status
 
 Shows system status information:
diff --git a/llms-install.md b/llms-install.md
new file mode 100644
index 00000000..029c3236
--- /dev/null
+++ b/llms-install.md
@@ -0,0 +1,128 @@
+# Basic Memory Installation Guide for LLMs
+
+This guide is specifically designed to help AI assistants like Cline install and configure Basic Memory. Follow these
+steps in order.
+
+## Installation Steps
+
+### 1. Install Basic Memory Package
+
+Use one of the following package managers to install:
+
+```bash
+# Install with uv (recommended)
+uv tool install basic-memory
+
+# Or with pip
+pip install basic-memory
+```
+
+### 2. Configure MCP Server
+
+Add the following to your config:
+
+```json
+{
+  "mcpServers": {
+    "basic-memory": {
+      "command": "uvx",
+      "args": [
+        "basic-memory",
+        "mcp"
+      ]
+    }
+  }
+}
+```
+
+For Claude Desktop, this file is located at:
+
+macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
+Windows: %APPDATA%\Claude\claude_desktop_config.json
+
+### 3. Start Synchronization (optional)
+
+To synchronize files in real-time, run:
+
+```bash
+basic-memory sync --watch
+```
+
+Or for a one-time sync:
+
+```bash
+basic-memory sync
+```
+
+## Configuration Options
+
+### Custom Directory
+
+To use a directory other than the default `~/basic-memory`:
+
+```bash
+basic-memory project add custom-project /path/to/your/directory
+basic-memory project default custom-project
+```
+
+### Multiple Projects
+
+To manage multiple knowledge bases:
+
+```bash
+# List all projects
+basic-memory project list
+
+# Add a new project
+basic-memory project add work ~/work-basic-memory
+
+# Set default project
+basic-memory project default work
+```
+
+## Importing Existing Data
+
+### From Claude.ai
+
+```bash
+basic-memory import claude conversations path/to/conversations.json
+basic-memory import claude projects path/to/projects.json
+```
+
+### From ChatGPT
+
+```bash
+basic-memory import chatgpt path/to/conversations.json
+```
+
+### From MCP Memory Server
+
+```bash
+basic-memory import memory-json path/to/memory.json
+```
+
+## Troubleshooting
+
+If you encounter issues:
+
+1. Check that Basic Memory is properly installed:
+   ```bash
+   basic-memory --version
+   ```
+
+2. Verify the sync process is running:
+   ```bash
+   ps aux | grep basic-memory
+   ```
+
+3. Check sync output for errors:
+   ```bash
+   basic-memory sync --verbose
+   ```
+
+4. Check log output:
+   ```bash
+   cat ~/.basic-memory/basic-memory.log
+   ```
+
+For more detailed information, refer to the [full documentation](https://memory.basicmachines.co/).
\ No newline at end of file