Skip to content

About

No description, website, or topics provided.

Resources

Stars

7 stars

Watchers

0 watching

Forks

Repository files navigation

Supermemory Obsidian Plugin

Directly sync your Obsidian notes to Supermemory and perform semantic, AI-powered searches across your entire second brain directly from within Obsidian.

Features

  • Real-time Automatic Sync: Syncs your markdown notes to Supermemory in real-time as you write (debounced to avoid spamming the API).
  • Auto-Rename & Delete Tracking: When you rename or delete a note, the plugin automatically keeps Supermemory in sync (deletes the old document reference and uploads the new one).
  • Premium Semantic Search: Open a search command inside Obsidian that queries Supermemory's hybrid search API.
  • Local Vault Integration: If a search result matches a note in your local vault, clicking it opens the local note directly! If it's an external memory (like web clippings, Drive, Notion, etc.), it opens the source URL.
  • Smart Hashing Cache: Keeps track of file hashes to avoid re-uploading unchanged notes, saving network requests and operations.
  • Manual Full Sync: A command and settings button to force sync all markdown files in your vault.
  • Ignored Folders: Exclude folders (like templates, private archives, or daily notes) from being synced.
  • Mobile Friendly: Built with native Web Crypto APIs and Obsidian HTTP utilities, making it compatible with both Desktop and Mobile Obsidian.

Installation

  1. In your Obsidian Vault, navigate to the plugins directory: <vault_folder>/.obsidian/plugins/ (create the plugins folder if it doesn't exist).
  2. Create a folder named supermemory-obsidian.
  3. Copy the following files from this repository into that folder:
    • main.js
    • manifest.json
    • styles.css
  4. Open Obsidian, go to Settings > Community plugins, click Reload, and toggle on Supermemory Sync & Search.

Configuration

The plugin supports both local (self-hosted) and cloud Supermemory instances.


Option A — Local / Self-Hosted

  1. Install and start the local Supermemory server (one-time setup):

    # via curl
    curl -fsSL https://supermemory.ai/install | bash
    
    # or via npx
    npx supermemory local
    
    # then start the server
    supermemory-server

    On first boot the server prints its API key and URL:

    ┌──────────────────────────────────────────────────┐
    │  url       http://localhost:6767                 │
    │  api key   sm_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx     │
    └──────────────────────────────────────────────────┘
    

    Save the api key — you will need it in the next step.

  2. Open Obsidian Settings > Supermemory Settings:

    • API Base URL: http://localhost:6767 (this is the default — no change needed if running locally)
    • API Key: Paste the sm_... key printed by the server above.
    • Container Tag: Set a tag for your vault (defaults to obsidian).
    • Ignored Folders: Comma-separated folders to exclude (e.g. templates, private/archive).
    • Sync on Edit: Toggle to automatically upload edits in real-time.

Option B — Cloud

  1. Log in to the Supermemory Developer Console.
  2. Go to API Keys and generate a new key.
  3. Open Obsidian Settings > Supermemory Settings:
    • API Base URL: https://api.supermemory.ai
    • API Key: Paste your cloud API key here.
    • Container Tag: Set a tag for your vault (defaults to obsidian). If you have multiple vaults or want to keep them separated, use unique tags.
    • Ignored Folders: List folders you want to exclude, separated by commas (e.g. templates, private/archive).
    • Sync on Edit: Toggle to automatically upload edits in real-time.

Usage

Commands

Open the Obsidian Command Palette (Ctrl/Cmd + P):

  • Supermemory: Search memories: Opens a beautiful search popup to query all your synced notes and external Supermemory items.
  • Supermemory: Sync all notes to Supermemory: Scans your vault and uploads notes that are new or have changed since the last sync.

Search Navigation

  • Clicking on a search result that represents a local note will instantly open that note in Obsidian.
  • Clicking on external results (e.g., from web clipper) will open the original web link in your default browser.
  • Displays a similarity matching score (e.g. 92% match) for each query.

Development

To make changes to this plugin:

  1. Clone the repository.
  2. Run npm install to set up development dependencies.
  3. Run npm run dev to start esbuild in watch mode (compiles automatically on file edits).
  4. Run npm run build to create a production bundle.

About

No description, website, or topics provided.

Resources

Stars

7 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages