README file from
GithubAI Study Buddy
An AI learning assistant embedded directly in your Obsidian vault. It makes direct API calls to LLM providers (Anthropic Claude, OpenAI, OpenAI Compatible) so it works on Desktop and iPad.
Features
- AI chat sidebar inside Obsidian
- Bilingual UI — English / 中文, switchable in Settings
- Direct API calls — no middleman, your API key stays local
- Multiple providers — Anthropic Claude, OpenAI, OpenAI Compatible (DeepSeek, Qwen, Moonshot, etc.)
- Learning materials — select any Markdown note as the current study material
- Learning roles — Private Tutor, Socratic Tutor (STEM), Language Partner (Humanities)
- 8 learning method commands —
/guide,/quiz,/confuse,/gap,/predict,/audio,/feynman,/mock - 9 learning action commands —
/flashcard,/summary,/map,/plan,/review,/checkup,/stats,/mistakes,/buddy - Spaced repetition — SM-2 algorithm schedules flashcard reviews automatically
- Error notebook — collects quiz mistakes for targeted review
- Learning statistics — track flashcards, reviews, quizzes, and activity streak
- File references —
@filenameto include vault files in context - Quote to chat — right-click selected text to quote it into AI Study Buddy
- Inline edits — edit, explain, translate, summarize selected text
- Conversation history — automatically saved
Installation
Community plugins (recommended)
Search "AI Study Buddy" in Obsidian Community Plugins and install.
Manual installation
- Download
main.js,manifest.json, andstyles.cssfrom the latest GitHub Release - Create a folder
.obsidian/plugins/claudian-api/inside your vault - Copy the three files into that folder
- In Obsidian, go to Settings → Community plugins, disable Safe mode, and enable AI Study Buddy
Setup
- Open AI Study Buddy settings
- Enter your API key for at least one provider
- (Optional) Add custom models for OpenAI Compatible providers
- Open the AI Study Buddy view from the ribbon icon or command palette
Usage
Select a learning material
- Click + Material in the chat header
- Search and pick a Markdown file from your vault
- The dropdown groups files by folder, mirroring your vault structure
Switch learning role
Use the Role bar to choose:
- Private Tutor — systematic five-step teaching loop based on your material
- Socratic Tutor (STEM) — asks guiding questions instead of giving direct answers
- Language Partner (Humanities) — vocabulary, grammar, translation, and cultural context
Use learning method commands
Type / in the input box to see commands. These wrap your query with a study-focused prompt:
/guide quantum mechanics— structured study guide/quiz quantum mechanics— Socratic quiz/confuse quantum mechanics— multi-angle explanation of confusing concepts/gap quantum mechanics— find knowledge gaps/predict quantum mechanics— predict exam focus points/audio quantum mechanics— podcast-style dialogue/feynman— test understanding with the Feynman technique/mock quantum mechanics— practice exam
Use learning action commands
These call AI and save results to your vault:
/flashcard quantum mechanics— generate flashcard Q&A cards (with spaced repetition scheduling)/summary— generate a summary of the current conversation/map quantum mechanics— generate a Mermaid knowledge concept map/plan quantum mechanics— generate a phased learning plan/review— start a spaced repetition review session for due flashcards/checkup quantum mechanics— AI quiz with auto-grading and error notebook logging/stats— show learning statistics dashboard/mistakes— review error notebook entries/buddy quantum mechanics— enter study buddy mode (AI acts as a confused classmate)
Reference files
- Type
@filenamein the input to include a vault file as context - Right-click selected text in the editor and choose Claudian: Quote to chat
Development
npm install
npm run dev # watch mode
npm run build # production build
npm run typecheck
npm test
License
MIT