cc-obsidian-mem

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

# 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

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

{
  "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
  }
}

## Memory System (cc-obsidian-mem)

You have access to a persistent memory system via MCP tools. Use it proactively.

### Available Tools

| Tool                  | Use When                                                 |
| --------------------- | -------------------------------------------------------- |
| `mem_search`          | Looking for past decisions, errors, patterns, or context |
| `mem_read`            | Need full content of a specific note                     |
| `mem_write`           | Saving important decisions, patterns, or learnings       |
| `mem_write_knowledge` | Saving Q&A, explanations, research from conversations    |
| `mem_supersede`       | Updating/replacing outdated information                  |
| `mem_project_context` | Starting work on a project (get recent context)          |
| `mem_list_projects`   | Need to see all tracked projects                         |
| `mem_generate_canvas` | Generate Obsidian canvas visualizations                  |
| `mem_file_ops`        | Delete, move, or create directories in the vault         |

### When to Search Memory

**Proactively search memory (`mem_search`) when:**

- Starting work on a codebase - check for project context and recent decisions
- Encountering an error - search for similar errors and their solutions
- Making architectural decisions - look for related past decisions
- User asks "how did we..." or "why did we..." or "what was..."
- Implementing a feature similar to past work

**Example searches:**

- `mem_search query="authentication" type="decision"` - Find auth-related decisions
- `mem_search query="TypeError" type="error"` - Find past TypeScript errors
- `mem_search query="database schema"` - Find DB-related knowledge
- `mem_project_context project="my-project"` - Get full project context

### When to Save to Memory

**Save to memory (`mem_write`) when:**

- Making significant architectural or technical decisions
- Discovering important patterns or gotchas
- Solving tricky bugs (save the solution)
- Learning something project-specific that will be useful later

**Use `mem_supersede` when:**

- A previous decision is being replaced
- Updating outdated documentation or patterns

# 1. Uninstall the current version
/plugin uninstall cc-obsidian-mem

# 2. Reinstall from marketplace
/plugin install cc-obsidian-mem

# 3. Restart Claude Code session
# Exit and start a new Claude session to load the updated hooks

/mem-search authentication error fix
/mem-search database schema decisions
/mem-search API rate limiting patterns

/mem-save decision: We chose PostgreSQL for better JSON support
/mem-save pattern: This regex validates email addresses
/mem-save learning: API rate limits at 100 req/min

/mem-status

┌──────────────┐     ┌─────────────┐     ┌────────────────┐
│ Claude Code  │◄───►│ MCP Server  │◄───►│ Obsidian Vault │
└──────┬───────┘     └─────────────┘     └────────────────┘
       │
       ▼
┌──────────────┐     ┌─────────────┐
│    Hooks     │────►│Session Store│
│ (Lifecycle)  │     │ (Ephemeral) │
└──────────────┘     └─────────────┘

vault/
├── _claude-mem/
│   ├── index.md                     # Dashboard with Dataview queries
│   ├── projects/
│   │   └── {project-name}/
│   │       ├── {project-name}.md    # Project overview
│   │       ├── _index.json          # Project index (auto-generated for fast search)
│   │       ├── errors/
│   │       │   ├── errors.md        # Category index
│   │       │   └── *.md             # Error patterns
│   │       ├── decisions/
│   │       │   ├── decisions.md     # Category index
│   │       │   └── *.md             # Architectural decisions
│   │       ├── knowledge/
│   │       │   ├── knowledge.md     # Category index
│   │       │   └── *.md             # Q&A, explanations, learnings
│   │       ├── research/
│   │       │   ├── research.md      # Category index
│   │       │   └── *.md             # External research notes
│   │       ├── patterns/
│   │       │   ├── patterns.md      # Category index
│   │       │   └── *.md             # Project-specific patterns
│   │       ├── files/
│   │       │   ├── files.md         # Category index
│   │       │   └── *.md             # File-specific knowledge
│   │       ├── sessions/            # Session summary notes
│   │       │   └── *.md             # {date}_{session_id}.md
│   │       └── canvases/
│   │           ├── dashboard.canvas # Grid layout by folder type
│   │           ├── timeline.canvas  # Decisions chronologically
│   │           └── graph.canvas     # Radial knowledge graph
│   ├── global/
│   │   ├── patterns/                # Reusable cross-project patterns
│   │   └── knowledge/               # General learnings
│   └── templates/                   # Note templates

"logging": { "verbose": true }

Get-ChildItem "$env:USERPROFILE\.claude\projects" -Recurse -Filter "*.jsonl" |
  Where-Object { (Get-Content $_.FullName -Raw) -match "cc-mem-agent|cc-obsidian-mem-" } |
  Remove-Item -Force
Get-ChildItem "$env:USERPROFILE\.claude\projects" -Recurse -Filter "sessions-index.json" |
  Remove-Item -Force

grep -rl "cc-mem-agent\|cc-obsidian-mem-" ~/.claude/projects --include="*.jsonl" | xargs rm -f
find ~/.claude/projects -name "sessions-index.json" -delete

cc-obsidian-mem/
├── .claude-plugin/
│   └── marketplace.json     # Marketplace manifest
├── plugin/
│   ├── .claude-plugin/
│   │   └── plugin.json      # Plugin manifest
│   ├── .mcp.json            # MCP server config
│   ├── hooks/
│   │   ├── hooks.json       # Hook definitions
│   │   └── scripts/         # Hook scripts
│   ├── scripts/             # Utility scripts
│   ├── skills/              # Skill definitions
│   ├── tests/               # Test files
│   └── src/
│       ├── vault/           # Vault management (read/write/search), canvas generation
│       ├── summarizer/      # AI-powered knowledge extraction
│       ├── mcp-server/      # MCP tools (mem_search, mem_write, etc.)
│       ├── session-end/     # Background session processing
│       ├── sqlite/          # SQLite database operations
│       ├── context/         # Context injection for prompts
│       ├── sdk/             # SDK agent integration
│       ├── shared/          # Types, config, validation, logging
│       ├── cli/             # Setup CLI
│       ├── fallback/        # JSON fallback storage
│       └── worker/          # Background worker service

"deduplication": {
  "enabled": true,
  "threshold": 0.6
}

cd plugin && bun test

cd plugin && bun run build