yusufpapurcu26 downloadsAsk AI about passages in your notes and get answers in a side panel, saved in separate files so your notes are never changed.
Yorum is Turkish for "comment" and "interpretation". It's an AI commentary layer for Obsidian: you write, and the AI answers in a panel beside your note, pinned to the passage you asked about.

[!WARNING] This is an MVP, and the codebase was built by an AI coding agent. A human set the direction, made the product calls and tested it in Obsidian; the code itself was written by the agent. It has a test suite (mocked LLM), but expect rough edges. Read the code before trusting it with notes you care about, and keep your vault in git or backed up.
Read-only. yorum never writes to your notes. Everything the AI says lives in a hidden .yorum/ folder at the vault root, one JSON file per note, mirroring its path:
vault/
Study/Recursion.md ← yours, never written by yorum
.yorum/Study/Recursion.json ← intent + comment threads for that note
There is one exception, and it's a button: Insert below passage copies an answer into your note as a callout when you click it.
Bring your own key (BYOK) or ChatGPT account. There is no yorum account, server or telemetry. You point it at any OpenAI-compatible endpoint (OpenAI, OpenRouter, a gateway, a local server) with your own key, or no key for a local server. You can instead sign in with your ChatGPT account, and answers count against your ChatGPT plan. Requests go straight from your device to that endpoint. The key and the ChatGPT sign-in are kept in Obsidian's Keychain on that device, never in the vault. What the AI sees shows the exact request before you rely on it.
chatgpt.com, plus auth.openai.com to sign in and renew the sign-in). yorum sends a request there when you ask something (a question, a quick action, a lens, a suggested intent), when you click Browse models in settings (it fetches the endpoint's model list), and at no other time. The request contains the current note, excerpts of up to four related notes, the passage and the thread. What the AI sees shows exactly what goes out.Select a passage → right-click → Ask… · Explain · Simplify · Challenge me · Visualize · Lens… (the same commands are in the command palette). Commented passages are highlighted in the editor. Click a highlight to open its thread.

The AI comments, answers and asks one sharp question back. It never rewrites your note. Challenge me goes after your weakest assumption. Related notes from your vault (links, backlinks, similar notes) go into the request, and answers link them as [[Note]].

Lens… explains a passage through a framework from another field: C.S. Holling's Adaptive Cycle, game theory, thermodynamics, and more. ✨ Surprise me lets the AI pick one. You get a mapping, the insight it reveals, and where the analogy breaks (see the screenshot at the top).

When a picture helps, or you click Visualize, answers include a Mermaid diagram or an SVG sketch that builds up step by step.

With a Gemini model, the AI searches the web when a question needs current facts. It cites inline and lists its sources.

Every thread can show the exact request: destination, model, which vault notes were included and how much, and every message.

Search across note titles, note text and AI comments. Accents are ignored, and Turkish ı matches i.

Insert below passage adds an answer to your note as a foldable [!ai] callout, with the passage, the question, the answer, its diagram and its sources. Copy as callout puts the same text on your clipboard.

Yorum is in Obsidian's community plugin directory. In Obsidian (1.11.4 or newer):
gpt-5.6-terra) or click Browse models to search your plan's list.
data.json only stores the secret's name, so it is safe to commit. Enter the key once per device.127.0.0.1:1455 for the redirect (desktop only). Code sign-in works everywhere but must first be turned on in ChatGPT → Settings → Security. Web search isn't offered with a ChatGPT account.chatgpt.com, which doesn't allow CORS). On mobile, ChatGPT answers arrive all at once instead of streaming..yorum/ is committed, diffed and synced like your notes. Files are pretty-printed JSON, written only when you ask, reply, save an intent or delete a thread. obsidian-git commits hidden folders unless your .gitignore excludes them..yorum/ file in the same commit, so a pull on another device brings both.updatedAt line.git mv) reaches Obsidian as a delete plus a create. The comments stay at the old path; with Delete AI comments with their note on, they are deleted..yorum/<note path>.json){
"version": 1,
"intent": "I'm struggling with recursion, quiz me",
"threads": [
{
"id": "…",
"anchor": { "blockIndex": 2, "quote": "how the answer actually comes back out" },
"createdAt": "…",
"lens": "C.S. Holling's Adaptive Cycle",
"messages": [
{ "id": "…", "role": "user", "content": "Explain this visually.", "createdAt": "…", "action": "visualize" },
{ "id": "…", "role": "assistant", "content": "… [\\[1\\]](https://…)", "createdAt": "…",
"sources": [{ "title": "python.org", "url": "https://docs.python.org/…" }],
"related": ["Systems thinking.md"] }
]
}
],
"updatedAt": "…"
}
Fields:
blockIndex is the top-level Markdown block of the note body (frontmatter excluded). If the note changes, the quote is found again anywhere in the note. If it's gone, the thread is marked as changed.anchor: null means a note-level thread.lens (the thread's concept lens), action (the quick action that sent a user message), sources (web search), related (vault notes given to the AI for that answer)..margin/…json, or <note>.ai.json next to the note) are moved into .yorum/ automatically.Each request sends:
Explain and Simplify use the model's faster thinking level.
npm test # Vitest, mocked LLM
npm run lint # Obsidian's review rules (eslint-plugin-obsidianmd)
npm run build # release build → main.js
npm run build:dev # dev build with source map → main.js
npm run install-plugin -- /path/to/your/vault # dev build, copied into the vault
Releasing the plugin: set the new version in manifest.json (and its minAppVersion if needed), commit, then push a tag with exactly that version, no v prefix (git tag 0.1.1 && git push origin 0.1.1). The Release plugin GitHub Action builds main.js and creates the GitHub release with main.js, manifest.json and styles.css attached, which is what Obsidian downloads.
src/: the plugin (NoteStore on Obsidian's vault API, panel, editor highlights, modals, ChatGPT sign-in).src/core/: Obsidian-free, I/O-free logic: the NoteStore interface, note parsing, sidecars, vault connections, search, quick actions and lenses, prompt assembly, LLM clients with streaming and Gemini grounding, callout export, and CommentaryService.tests/: Vitest suites; core tests run against a folder on disk (tests/fs-store.ts).sample-vault/: a few demo notes to try it on (the screenshots use them).docs/images/: README screenshots, taken in Obsidian 1.15.1 with real model answers.