Skip to content

orange-dot/obsidian-learning-coach

Repository files navigation

Obsidian Learning Coach

Source-grounded explain, quiz, and review workflows for Obsidian notes. Learning Coach reads the active note, builds structured Codex prompts from the note content and nearby context, and helps turn notes into active recall and review loops inside Obsidian.

Requirements

  • Obsidian 1.5.0+ on desktop
  • A local filesystem vault
  • A local codex executable available on PATH or configured explicitly in plugin settings
  • Markdown notes in the current vault

Learning Coach depends on the local Codex CLI for explain and quiz generation. Without codex, the plugin loads but the core commands cannot run.

What it does

  • Explains the current note with structured, source-grounded output
  • Generates interactive quizzes for the current note
  • Supports follow-up questions and per-question grading
  • Tracks confidence and review scheduling in note frontmatter
  • Opens a custom quiz view inside Obsidian
  • Builds a review queue from due notes

Commands

  • Explain current note
  • Start interactive quiz on current note
  • Restart interactive quiz
  • Mark confidence for current note
  • Open review queue
  • Start review session from due notes
  • Open Learning Coach settings

Quick start

  1. Place this repo in your vault under .obsidian/plugins/learning-coach or copy the built main.js, manifest.json, and styles.css there.
  2. Enable the plugin in Settings -> Community plugins.
  3. Open plugin settings and confirm the codex executable path, plus any model or profile overrides you want to use.
  4. Open a markdown note and run Explain current note or Start interactive quiz on current note.

Settings

  • codex executable path
  • Optional Codex model override
  • Optional Codex profile override
  • Optional reasoning effort override
  • Request timeout
  • Quiz question count
  • Follow-up behavior
  • Confidence interval defaults
  • Auto-apply confidence after quiz sessions
  • Notices on success and warning paths

Architecture

The plugin parses the active note, gathers nearby supporting context, and sends structured prompts to the local Codex CLI. Quiz state and review state live in plugin memory plus note frontmatter, while the custom quiz view renders the interactive session inside Obsidian.

Status

This repo is extracted from a working local plugin and packaged as a standalone public project. It is desktop-only because it depends on a local CLI workflow and local filesystem access. It is not yet prepared for Community Plugins submission.

Screenshots

  • TODO: explain-note flow
  • TODO: quiz view
  • TODO: review queue example

About

Source-grounded explain, quiz, and review assistant for Obsidian notes powered by the local Codex CLI.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors