Obuchator

Obuchator turns Markdown notes into a native study workspace inside Obsidian. It adds source-linked quizzes, FSRS review, an AI study assistant, progress tracking, and automatic vault indexing without embedding a website.

Features

• Native Obsidian view with responsive navigation and keyboard-accessible controls.
• Daily dashboard with study goals, review queue, mistakes, streaks, and recent note activity.
• Vault search and Markdown reading rendered with Obsidian's own Markdown renderer.
• Quiz generation from selected notes, saved quiz sets, answer feedback, explanations, and source links.
• FSRS review with confidence tracking, error repair, rating previews, and exact-source navigation.
• AI assistant grounded in the notes indexed by the local Obuchator service.
• Concept mastery, weak-topic tracking, and deadline-based study campaigns.
• Automatic debounced indexing after Markdown files are created, edited, renamed, or deleted.

Requirements

• Obsidian Desktop 1.7.2 or newer on Windows, macOS, or Linux.
• A running Obuchator companion application. The default address is http://127.0.0.1:3100.

The plugin is desktop-only because the companion application indexes the current vault through its absolute local filesystem path. The companion application stores the SQLite study history, runs FSRS scheduling, and communicates with an AI provider when the user has configured one.

Usage

1. Start the Obuchator companion application.
2. Open Settings → Community plugins → Obuchator and verify the local service address.
3. Select Check and sync to connect the current vault.
4. Select the graduation-cap icon in the ribbon, or run Open learning workspace from the command palette.

The native workspace contains six sections:

• Dashboard — today's goal, review queue, mistakes, and recent activity.
• Vault — search, read, and open Markdown source files.
• Quiz — generate or resume quizzes and inspect answer feedback.
• Review — complete scheduled FSRS reviews and repair errors.
• Assistant — ask questions grounded in indexed notes.
• Progress — inspect concept mastery and plan study campaigns.

Network and privacy disclosure

Obuchator uses the network as follows:

• The plugin sends GET and POST requests to the companion service address configured in settings.
• The default address is the local loopback interface, so requests do not leave the computer.
• The plugin sends the absolute path of the current vault to the companion service so it can index Markdown files and attachments.
• If the service address is changed to a remote URL, requests and the absolute vault path are sent to that server. Only use a server you trust.
• The plugin does not embed remote pages, load remote interface assets, include client-side telemetry, or contact advertising services.
• The companion application may contact an AI provider selected and configured by the user. AI requests are made by the companion service, not directly by this plugin.
• No Obsidian or Obuchator account is required for the local workflow.

Manual installation

Download main.js, manifest.json, and styles.css from the latest GitHub release and copy them to:

<vault>/.obsidian/plugins/obuchator/

Reload Obsidian, open Settings → Community plugins, and enable Obuchator.

Development

npm install
npm test
npm run build
npm run lint

Create a release-ready package:

npm run package

The release assets are main.js, manifest.json, and styles.css.

The embedded Geist and Geist Mono typefaces are distributed under the SIL Open Font License 1.1. Font binaries are supplied by Fontsource at build time.

License

The Obuchator plugin is available under the MIT License.