Docs
Install, structure, and everyday use
This page covers the whole path from installing the plugin to studying day to day: how a project is laid out, how to open the Study Desk, how to migrate an old directory, what each of the five skills does, and where your data lives.
Install & upgrade
The plugin requires DSH ≥ 0.2.1-rc.5 and Node 22.19+. Check the host version before installing; after installing, restart the host.
dsh plugin --profile web add dsh-ai-study-kitRequires DSH ≥ 0.2.1-rc.5 and Node 22.19+.
Which profile to install into
DSH can have several profiles, and the Study Desk appears in the sidebar of whichever profile the plugin is installed into.dsh plugin requires --profile, placed betweenplugin and add; the example below usesweb, the profile the GUI usually runs, so swap in your own profile name:
dsh plugin --profile web add dsh-ai-study-kitOnce installed, check in plugin management that the status is active; the five skills (ask-coach / study-coach / study-doctor / study-recap / study-podcast) register together.
Install from GitHub or a local directory
You can also install straight from the repository, or point at a local clone. Useful for tracking unreleased changes:
dsh plugin --profile web add github:jerryjiao/dsh-ai-study-kit
dsh plugin --profile web add <local clone directory>Upgrade
There is no separate update subcommand: just run the install command again, add a version after the package name to pin it if needed, then restart the host. Upgrading the plugin does not touch your study project.
Project structure
A study project is an ordinary directory with just three things: examples/,progress.json, and study/. The plugin does not require you to create it in any fixed location.
my-study/
├─ examples/
│ └─ git-basics/
│ ├─ questions.json
│ ├─ flashcards.json
│ ├─ plan.json
│ └─ theme-config.json
├─ progress.json
└─ study/
└─ records/Files inside examples/<theme>/
| File | Purpose |
|---|---|
questions.json | Questions, options, correct answers and explanations; the practice page scores by question id. |
flashcards.json | Front and back of each flashcard; spaced-repetition scheduling is recorded in progress.json and never written back here. |
plan.json | The study plan: unit order, goals and deadlines; both the home page and the coach read it. |
theme-config.json | Topic name, display settings and other metadata. |
MISSION.md and lessons/ are optional: if present they show up in the Study Desk and in live tutoring; without them practice and flashcards still work.
Your project root is not the bundled kit/
The kit/ inside the plugin install directory is a snapshot and reference material that the skills read; it is not your study project. Don't writeprogress.json there, and don't edit questions there — it is updated along with the package when you upgrade the plugin. Put your project in any directory; the plugin reads and writes only the one you select.
Open the Study Desk
- After restarting the host, a “Study Desk” icon appears in the sidebar; click it to open the home page.
- The top-right corner of the panel has a project dropdown where you can type a path or pick a recently used project.
- Whichever directory the project dropdown points at is the one the pages read and write; switching projects just means switching a path.
If you have never picked a project manually, the plugin looks in this order:
- the project used last time;
- the current launch directory (whichever directory DSH was started in);
~/study-kit.
If none of the three matches, the panel asks you to pick a directory. Once you do, it remembers and uses it next time.
Migrating the old layout
Older versions kept content in directories like kit/apps/quiz-app/examples/. The plugin recognizes the oldkit/apps/quiz-app, kit andapps/quiz-app layouts, prompts you to migrate, and never modifies the old directory directly.
Migration takes four steps, and you can stop after any of them:
- Back up the whole old directory (copy it, or commit it to your own git first).
- Copy
examples/<theme>/andprogress.jsonto the new project root. - Verify: question and answer counts match, your answered records are still there, and the Study Desk opens the same question set.
- Only after confirming all of that, delete the old directory.
Migration does not change question ids, so answered records and flashcard schedules keep working. If unsure, just back up and don't delete — leaving the old directory in place does not affect the new project.
How to use the five skills
Skills are all invoked inside a session: type the slash command, or just describe what you want in natural language. The only difference is that the former is more explicit and the latter more casual.
/ask-coach study coach (main entry point)
Ask it when you don't know what to do next. It scans your progress, wrong answers, due flashcards and exam date, reports a snapshot of where you stand, then names the one thing you should do now and why, and finally walks you through it.
/ask-coach I want to learn git/study-coach live tutoring
Sit down and study: it opens with what is most worth practicing today, teaches it piece by piece, quizzes you on the spot after each piece, and if you fail it goes back to shore it up instead of pushing on.
/study-coach continue studying/study-doctor health check
Checks the question bank, content alignment and environment configuration in one pass. Anything red is listed in repair order, telling you what to fix first and why.
/study-doctor health check/study-recap wrong-question deep dive
It takes your wrong answers from “knowing the answer” to “knowing why it was wrong”, then hands them back to you to redo. Once you have three or more wrong answers, the coach usually suggests a session.
/study-recap wrong-question deep dive/study-podcast podcast
Turns lessons you haven't mastered, or a wrong-question deep dive, into a two-host podcast you can listen to on the commute. Generating the podcast calls a model, so that step needs network access and your model configuration.
/study-podcast listen on my commuteLearners only need these five commands. Toolchain work such as installing dependencies, running builds and copying files is handled inside the skills; you don't need to remember it.
Data & backup
progress.json is plain-text JSON that records study state by question id. The main fields:
| Field | Contents |
|---|---|
answers | Answer records per question: which options were chosen, whether it was correct, and when. |
srs | Flashcard review schedule: each card's next due time and rating history. |
read | Records of lessons or sections already read. |
settings | Preferences: daily new-card limit, auto-advance, interface language and so on. |
There is also a little metadata, such as the last topic used. Writes follow “read — merge — write a temporary file — rename”, so a write interrupted halfway never leaves half a file; if the file is corrupt the plugin refuses to overwrite it and reports an error instead of quietly clearing it.
Backup
Copy the whole project root; the minimum is examples/ andprogress.json. study/ holds study records — copy it too if you want to keep them. Putting the project root in your own git also works; progress is runtime data, so ignore it as you see fit.
Moving to another machine
Install the plugin on the new machine, copy in the project root, open the Study Desk and select the directory, and your progress is back. There is no account to log into and no cloud data to restore.
Privacy
- The Study Desk pages and the plugin host communicate only over the local loopback interface; nothing listens on the LAN or the public internet.
- No accounts, no telemetry, no cloud sync; the plugin uploads none of your study data to any server.
- It reads and writes only the project directory you selected, does not scan other directories, and does not touch your notes or other repositories.
- Only model-dependent actions — generating questions, producing lessons, making podcasts — go over the network, and they use the model you configured yourself.
- All screenshots on the website and in the docs come from a fictional example project and contain no real user data.
Troubleshooting
No Study Desk icon in the sidebar
Most likely the plugin went into the wrong profile, or the host was not restarted after installing. First check in plugin management that the plugin is under the profile you want and that its status is active, then restart DSH.
The panel says it can't find a project
Pick a directory in the top-right project dropdown and make sure it contains examples/<theme>/. If the lookup order (last project → launch directory →~/study-kit) found nothing, selecting once by hand is remembered.
Progress is not saved
First check whether the project directory is read-only and whether the current user has write permission; then make sure progress.jsonis not held by another program. If the file's JSON is corrupt, the host reports an error and refuses to overwrite it — fix it, or restore from a backup.
Blank page or a missing build output warning
When installing from source, the plugin package has to be built first: run npm run build in the plugin repository, then reinstall or restart the host.