# szarkans/dont-forget architecture

> Architecture diagram of the GitHub repository szarkans/dont-forget, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/szarkans/dont-forget
- Repository: https://github.com/szarkans/dont-forget

## Overview

don't forget is a Claude Code memory plugin backed by a user-owned vault of Markdown notes. The main workflow is saving a note, indexing it, and later searching text and wiki-link relationships; optional semantic search adds a meaning-based lane. Session and audit skills support review and thread tracking, while setup and health manage vault configuration and index status. The README documents several skill capabilities whose implementation details were not sampled; those relationships are shown only where documented.

Main entry points: [`scripts/index.py`](https://github.com/szarkans/dont-forget/blob/main/scripts/index.py) (Vault indexer), [`scripts/search.py`](https://github.com/szarkans/dont-forget/blob/main/scripts/search.py) (Text and link search), [`scripts/common.py`](https://github.com/szarkans/dont-forget/blob/main/scripts/common.py) (Config and paths), [`skills/session/SKILL.md`](https://github.com/szarkans/dont-forget/blob/main/skills/session/SKILL.md) (Session review)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_experience["Plugin skills"]
  node_save_skill["Save note<br/>[SKILL.md]"]
  node_recall_skill["Recall notes<br/>[SKILL.md]"]
  node_session_skill["Session review<br/>[SKILL.md]"]
  node_setup_skill["Vault setup<br/>[SKILL.md]"]
  node_health_skill["Vault health<br/>[SKILL.md]"]
  node_audit_skill["Vault audit<br/>[SKILL.md]"]
end

subgraph group_vault["Vault operations"]
  node_vault[("Markdown vault")]
  node_writer["Note writer<br/>[vault-write.py]"]
  node_setup["Vault discovery<br/>[setup.py]"]
end

subgraph group_retrieval["Index and search"]
  node_indexer["Vault indexer<br/>[index.py]"]
  node_search["Text and link search<br/>[search.py]"]
  node_semantic["Semantic runner<br/>[semantic.py]"]
  node_worker["Embedding worker<br/>[semantic_worker.py]"]
  node_index_db[("SQLite search index")]
  node_vector_db[("Vector index")]
end

subgraph group_session["Session and oversight"]
  node_transcript["Transcript reader<br/>[transcript.py]"]
  node_threads["Thread tracking<br/>[threads.py]"]
  node_audit["Vault audit<br/>[audit.py]"]
  node_checkup["Vault checkup<br/>[checkup.py]"]
  node_hot_scan["Context scan<br/>[hot-scan.py]"]
  node_context_guard["Compaction guard<br/>[context-guard.py]"]
end

subgraph group_shared["Shared runtime"]
  node_common["Config and paths<br/>[common.py]"]
end

node_developer(("Developer"))
node_claude["Claude Code"]

node_developer -->|"uses plugin"| node_claude
node_claude -->|"invokes"| node_save_skill
node_claude -->|"invokes"| node_recall_skill
node_claude -->|"invokes"| node_session_skill
node_claude -->|"invokes"| node_setup_skill
node_claude -->|"invokes"| node_health_skill
node_claude -->|"invokes"| node_audit_skill
node_save_skill -.->|"records note"| node_writer
node_writer -->|"writes Markdown"| node_vault
node_setup_skill -.->|"configures vault"| node_setup
node_setup -->|"uses config"| node_common
node_setup -->|"builds index"| node_indexer
node_indexer -->|"reads notes"| node_vault
node_indexer -->|"builds SQLite index"| node_index_db
node_recall_skill -.->|"searches vault"| node_search
node_search -->|"queries index"| node_index_db
node_search -->|"requests meaning search"| node_semantic
node_semantic -->|"dispatches worker"| node_worker
node_worker -->|"reads chunks"| node_index_db
node_worker -->|"stores vectors"| node_vector_db
node_session_skill -.->|"reads transcript"| node_transcript
node_session_skill -.->|"tracks threads"| node_threads
node_audit_skill -.->|"reviews notes"| node_audit
node_health_skill -.->|"checks vault"| node_checkup
node_context_guard -.->|"reads session data"| node_transcript
node_hot_scan -.->|"scans indexed notes"| node_index_db
node_writer -->|"uses paths"| node_common
node_search -->|"uses paths"| node_common
node_indexer -->|"uses config"| node_common

click node_save_skill "https://github.com/szarkans/dont-forget/blob/main/skills/that/SKILL.md"
click node_recall_skill "https://github.com/szarkans/dont-forget/blob/main/skills/about/SKILL.md"
click node_session_skill "https://github.com/szarkans/dont-forget/blob/main/skills/session/SKILL.md"
click node_setup_skill "https://github.com/szarkans/dont-forget/blob/main/skills/setup/SKILL.md"
click node_health_skill "https://github.com/szarkans/dont-forget/blob/main/skills/health/SKILL.md"
click node_audit_skill "https://github.com/szarkans/dont-forget/blob/main/skills/audit/SKILL.md"
click node_writer "https://github.com/szarkans/dont-forget/blob/main/scripts/vault-write.py"
click node_setup "https://github.com/szarkans/dont-forget/blob/main/scripts/setup.py"
click node_indexer "https://github.com/szarkans/dont-forget/blob/main/scripts/index.py"
click node_search "https://github.com/szarkans/dont-forget/blob/main/scripts/search.py"
click node_semantic "https://github.com/szarkans/dont-forget/blob/main/scripts/semantic.py"
click node_worker "https://github.com/szarkans/dont-forget/blob/main/scripts/semantic_worker.py"
click node_transcript "https://github.com/szarkans/dont-forget/blob/main/scripts/transcript.py"
click node_threads "https://github.com/szarkans/dont-forget/blob/main/scripts/threads.py"
click node_audit "https://github.com/szarkans/dont-forget/blob/main/scripts/audit.py"
click node_checkup "https://github.com/szarkans/dont-forget/blob/main/scripts/checkup.py"
click node_hot_scan "https://github.com/szarkans/dont-forget/blob/main/scripts/hot-scan.py"
click node_context_guard "https://github.com/szarkans/dont-forget/blob/main/scripts/context-guard.py"
click node_common "https://github.com/szarkans/dont-forget/blob/main/scripts/common.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_save_skill,node_recall_skill,node_session_skill,node_setup_skill,node_health_skill,node_audit_skill toneBlue
class node_vault,node_writer,node_setup toneAmber
class node_indexer,node_search,node_semantic,node_worker,node_index_db,node_vector_db toneMint
class node_transcript,node_threads,node_audit,node_checkup,node_hot_scan,node_context_guard toneRose
class node_common,node_developer,node_claude toneIndigo
```

## Components

### Plugin skills

- [Save note](https://github.com/szarkans/dont-forget/blob/main/skills/that/SKILL.md): `skills/that/SKILL.md`
- [Recall notes](https://github.com/szarkans/dont-forget/blob/main/skills/about/SKILL.md): `skills/about/SKILL.md`
- [Session review](https://github.com/szarkans/dont-forget/blob/main/skills/session/SKILL.md): `skills/session/SKILL.md`
- [Vault setup](https://github.com/szarkans/dont-forget/blob/main/skills/setup/SKILL.md): `skills/setup/SKILL.md`
- [Vault health](https://github.com/szarkans/dont-forget/blob/main/skills/health/SKILL.md): `skills/health/SKILL.md`
- [Vault audit](https://github.com/szarkans/dont-forget/blob/main/skills/audit/SKILL.md): `skills/audit/SKILL.md`

### Vault operations

- **Markdown vault**
- [Note writer](https://github.com/szarkans/dont-forget/blob/main/scripts/vault-write.py): `scripts/vault-write.py`
- [Vault discovery](https://github.com/szarkans/dont-forget/blob/main/scripts/setup.py): `scripts/setup.py`

### Index and search

- [Vault indexer](https://github.com/szarkans/dont-forget/blob/main/scripts/index.py): `scripts/index.py`
- [Text and link search](https://github.com/szarkans/dont-forget/blob/main/scripts/search.py): `scripts/search.py`
- [Semantic runner](https://github.com/szarkans/dont-forget/blob/main/scripts/semantic.py): `scripts/semantic.py`
- [Embedding worker](https://github.com/szarkans/dont-forget/blob/main/scripts/semantic_worker.py): `scripts/semantic_worker.py`
- **SQLite search index**
- **Vector index**

### Session and oversight

- [Transcript reader](https://github.com/szarkans/dont-forget/blob/main/scripts/transcript.py): `scripts/transcript.py`
- [Thread tracking](https://github.com/szarkans/dont-forget/blob/main/scripts/threads.py): `scripts/threads.py`
- [Vault audit](https://github.com/szarkans/dont-forget/blob/main/scripts/audit.py): `scripts/audit.py`
- [Vault checkup](https://github.com/szarkans/dont-forget/blob/main/scripts/checkup.py): `scripts/checkup.py`
- [Context scan](https://github.com/szarkans/dont-forget/blob/main/scripts/hot-scan.py): `scripts/hot-scan.py`
- [Compaction guard](https://github.com/szarkans/dont-forget/blob/main/scripts/context-guard.py): `scripts/context-guard.py`

### Shared runtime

- [Config and paths](https://github.com/szarkans/dont-forget/blob/main/scripts/common.py): `scripts/common.py`

### Other components

- **Developer**
- **Claude Code**

## Connections

- Developer → Claude Code: uses plugin (evidence: `README.md`)
- Claude Code → Save note: invokes (evidence: `README.md`)
- Claude Code → Recall notes: invokes (evidence: `README.md`)
- Claude Code → Session review: invokes (evidence: `README.md`)
- Claude Code → Vault setup: invokes (evidence: `README.md`)
- Claude Code → Vault health: invokes (evidence: `README.md`)
- Claude Code → Vault audit: invokes (evidence: `README.md`)
- Save note → Note writer: records note
- Note writer → Markdown vault: writes Markdown (evidence: `scripts/vault-write.py`)
- Vault setup → Vault discovery: configures vault
- Vault discovery → Config and paths: uses config (evidence: `scripts/setup.py`)
- Vault discovery → Vault indexer: builds index (evidence: `scripts/setup.py`)
- Vault indexer → Markdown vault: reads notes (evidence: `README.md`)
- Vault indexer → SQLite search index: builds SQLite index (evidence: `scripts/index.py`)
- Recall notes → Text and link search: searches vault
- Text and link search → SQLite search index: queries index (evidence: `README.md`)
- Text and link search → Semantic runner: requests meaning search (evidence: `scripts/search.py`)
- Semantic runner → Embedding worker: dispatches worker (evidence: `scripts/semantic.py`)
- Embedding worker → SQLite search index: reads chunks (evidence: `scripts/semantic_worker.py`)
- Embedding worker → Vector index: stores vectors (evidence: `scripts/semantic_worker.py`)
- Session review → Transcript reader: reads transcript
- Session review → Thread tracking: tracks threads
- Vault audit → Vault audit: reviews notes
- Vault health → Vault checkup: checks vault
- Compaction guard → Transcript reader: reads session data
- Context scan → SQLite search index: scans indexed notes
- Note writer → Config and paths: uses paths (evidence: `scripts/vault-write.py`)
- Text and link search → Config and paths: uses paths (evidence: `scripts/search.py`)
- Vault indexer → Config and paths: uses config (evidence: `scripts/index.py`)
