cc-obsidian-mem

cc-obsidian-mem

This repository is archived and no longer actively maintained. I've moved away from Obsidian and am no longer using or developing this project. Feel free to fork it and build on it, or use it as a starting point for your own memory system.

Obsidian-based persistent memory system for Claude Code. Automatically captures session activity, errors, decisions, and patterns into a browsable, visualizable knowledge base.

Documentation

Check out the Wiki for comprehensive guides:

Guide	Description
Getting Started	Step-by-step setup for beginners
Installation	Detailed installation instructions
Configuration	All configuration options explained
MCP Tools	Tools Claude uses to access memory
Skills	Slash commands (/mem-search, /mem-save, etc.)
Vault Structure	How knowledge is organized
Troubleshooting	Common issues and solutions
FAQ	Frequently asked questions

Features

• Automatic Capture: Hooks automatically track file edits, commands, and errors
• Exploration Tracking: Captures codebase exploration (files read, search patterns used)
• AI Summaries: Claude-powered knowledge extraction from conversations with Zod validation
• Obsidian Integration: Full Obsidian syntax support with Dataview queries for visualization
• Canvas Visualizations: Auto-generated dashboard, timeline, and graph canvases
• File-Based Indexing: JSON index files for faster search operations
• Session Summaries: Creates session summary notes with exploration history
• Project Organization: Memories organized by project with cross-project patterns
• MCP Tools: Search, read, and write memories directly from Claude Code
• Skills: User-invokable commands (/mem-search, /mem-save, /mem-status)

Quick Start

Prerequisites

• Bun runtime installed
• Obsidian with an existing vault
• Dataview plugin (recommended for dashboards)
• Claude Code CLI v1.0.49 or later (required for --no-session-persistence flag)
  • Check your version: claude --version
  • Upgrade if needed: npm install -g @anthropic-ai/claude-code

Step 1: Install the Plugin

Option A: From GitHub Marketplace (Recommended)

# In Claude Code, run:
/plugin marketplace add z-m-huang/cc-obsidian-mem
/plugin install cc-obsidian-mem

Option B: From Local Clone

# Clone the repository
git clone https://github.com/Z-M-Huang/cc-obsidian-mem.git
cd cc-obsidian-mem/plugin
bun install

# In Claude Code, run:
/plugin marketplace add /path/to/cc-obsidian-mem
/plugin install cc-obsidian-mem

Step 2: Configure Your Vault

Run the setup wizard:

# Navigate to the plugin directory and run setup
cd ~/.claude/plugins/cc-obsidian-mem  # or your clone location
cd plugin && bun run setup

The wizard will prompt you for your Obsidian vault path and create the config file.

Or manually create ~/.cc-obsidian-mem/config.json:

{
  "vault": {
    "path": "/path/to/your/obsidian/vault",
    "memFolder": "_claude-mem"
  },
  "logging": {
    "verbose": false
  },
  "capture": {
    "fileEdits": true,
    "bashCommands": true,
    "bashOutput": { "enabled": true, "maxLength": 5000 },
    "errors": true,
    "decisions": true
  },
  "summarization": {
    "enabled": true,
    "model": "sonnet",
    "sessionSummary": true,
    "errorSummary": true,
    "timeout": 180000
  },
  "contextInjection": {
    "enabled": true,
    "maxTokens": 4000,
    "includeRelatedErrors": true,
    "includeProjectPatterns": true
  },
  "canvas": {
    "enabled": true,
    "autoGenerate": true,
    "updateStrategy": "always"
  },
  "processing": {
    "frequency": "compact-only",
    "periodicInterval": 10
  },
  "deduplication": {
    "enabled": true,
    "threshold": 0.6
  }
}

Note: AI summarization uses the Claude Code CLI (claude -p), so no separate API key is required. Valid model values: sonnet, opus, haiku.

Step 3: Restart Claude Code

Restart Claude Code to load the plugin and hooks.

Step 4: Enable Proactive Memory Use (Important!)