Skip to content
Back to search

dsh-web-studyhub

StudyHub: a DeepSeek Harness (DSH) plugin that turns your own material into questions and spaced review · 把自己的资料变成题目与间隔复习的 DSH 学习插件

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/EricWang1358/dsh-web-studyhub with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/EricWang1358/dsh-web-studyhub'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/ericwang1358--dsh-web-studyhub/badge.svg)](/listings/ericwang1358--dsh-web-studyhub)

HTML

<a href="/listings/ericwang1358--dsh-web-studyhub"><img src="/api/listings/ericwang1358--dsh-web-studyhub/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

| You want to | You need | Cost | | --- | --- | --- | | Take the sample course and tour, browse sources, practise existing questions | StudyHub only | Free, no model calls | | Generate questions, explanations and **Help me understand** | A model provider key in DSH **Settings › Models** | Billed by your provider, for example the [DeepSeek API](https://platform.deepseek.com/) | | Turn recordings into text | A transcription key in StudyHub **Settings › Audio transcription** | SiliconFlow SenseVoice supports recording transcription. Gemini and Groq availability and allowances depend on the provider |

1. **Install DSH** (skip this if you have it). Use the official [Windows x64 installer](https://download.deepseek.com/desktop/dsh-latest-windows-x64.exe) or [macOS Apple silicon installer](https://download.deepseek.com/desktop/dsh-latest-macos-arm64.dmg). On any other computer, install Node.js 22.19 or later and run `npx @deepseek-ai/dsh web`. 2. **Install StudyHub.** In DSH, open **Plugins**, click **Add plugin**, paste this address and click **Enable**:

   https://github.com/EricWang1358/dsh-web-studyhub/releases/download/v3.5.0/ericwang1358-dsh-daily-flashcard-3.5.0.tgz

Check that the package is `@ericwang1358/dsh-daily-flashcard`, version **3.5.0**. StudyHub then opens by itself. Later, open it from **StudyHub** in DSH's left sidebar (the session tab and the right sidebar also work); you do not need to send a chat message first. 3. **Take the tour (optional, a minute or two).** On the welcome page, click **Load the sample and start the tour**. The 8-step tour follows the main line (add a source, make questions, practise), then shows where Jobs and the model settings are, pointing at the real controls. A full tour of every page is offered at its end. The sample makes no model calls and can be removed with one click. 4. **Add a model.** Paste a key in DSH **Settings › Models** and choose a model in your session. Until then, StudyHub says so wherever a step needs a model, with a **Go to settings** link, instead of letting the step fail later; **Settings › Library & model** shows **Model connected** or **Model not connected** and the steps. 5. **Start with your own material.** Click **Add source** and drop several PDFs, slides or notes at once. Then use **Generate from sources**, review the draft, publish it and practise.

Notes on installing:

- **Already use DSH?** Install only the plugin. Keep your current desktop app or web server, profile, model settings and workspace. - **GitHub address does not work?** Download the `.tgz` from the [release page](https://github.com/EricWang1358/dsh-web-studyhub/releases/tag/v3.5.0) in your browser and give **Add plugin** its absolute path. The file must be on the computer or server that runs DSH. - **Which file on the release page?** Only the complete package, `ericwang1358-dsh-daily-flashcard-<version>.tgz`, and you normally do not need to download it: step 2 pastes its address. The other files are the six separate components, the search extension (StudyHub installs it when you click **Install the search extension**), the checksum list and two setup guides. - More options, including the command line: [installation and model setup guide](docs/install.md). Setup guides you can open in a browser: [English](https://github.com/EricWang1358/dsh-web-studyhub/releases/download/v3.5.0/StudyHub-3.5.0-Setup.html) · [Chinese](https://github.com/EricWang1358/dsh-web-studyhub/releases/download/v3.5.0/StudyHub-3.5.0-Setup.zh-CN.html). DSH itself comes only from the official sources in step 1.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 280 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. # StudyHub
  2. English · [简体中文](README.zh-CN.md)
  3. Turn your lecture slides into questions that each link back to their page; finish a round and see yourself getting it.
  4. Free and open source, your sources stay on your computer; pick your own model and pay for what you use.
  5. StudyHub is a plugin for [DeepSeek Harness (DSH)](https://www.deepseek.com/en/harness/), an AI agent app. DSH runs as a desktop app or as a web page served from your own computer, and StudyHub opens inside it.
  6. [Try the demo](https://daily-flashcard-demo.ziangw1358.chatgpt.site) · [Install guide](docs/install.md) · [Release 4.13.0](https://github.com/EricWang1358/dsh-web-studyhub/releases/tag/v4.13.0) · [Changelog](CHANGELOG.md)
  7. The demo runs in your browser with sample questions, playable **Interactive Companions**, and prepared AI replies. It needs no install and no key, and your progress there stays in that browser.
  8. ## At a glance
  9. - **Made for:** students who learn from slides, PDFs, notes and recorded lectures, in English or Chinese.
  10. - **Cost:** StudyHub is free and open source (MIT). Browsing sources, answering questions and review scheduling are free, with no model calls. Generating questions and AI help are billed by your model provider. StudyHub shows the estimated tokens before a generation run and the actual tokens after it, and **Statistics** totals the last 7 or 30 days.
  11. - **Network and cost:** supported regions, free allowances and pricing depend on each provider’s current terms. If installing from the GitHub address fails, see the notes under [Quick start](#quick-start).
  12. - **Computers:** the install links below cover Windows x64 and macOS on Apple silicon. For other systems, check current DSH support or use the web version with Node.js 22.19 or later.
  13. - **Requires:** DSH 0.2 (0.2.0-rc.2 or later, below 0.3).
  14. - **Your data:** the library is a folder on your computer. [Data and privacy](#data-and-privacy) lists what is sent where.
  15. ## What you can do
  16. - **Make questions from your own sources.** Pick pages or chapters and generate flashcards, single- or multiple-choice, open-response or fill-in-the-blank questions. Every question cites its passage, and you review the draft before you publish it.
  17. - **Move between questions and sources.** A citation opens the passage it came from. In a source, paragraph and table markers lead to the questions and explanations linked to them.
  18. - **Build cross-discipline Interactive Companions.** Open **Interactive Companions** on **Course outline** or **Sources** to generate self-contained 16–20 slide zero-dependency `.html` lessons (`generation.companion.build`) across Mathematics, Philosophy, Mechanical Engineering, Physics, Economics and Computer Science — with parametric math sandboxes, dialectical thought-experiment matrices, stepwise vector schematics, empirical code/proof traces, built-in LaTeX-to-MathML formulas and 0-token spaced-repetition card sync — or mount existing local HTML companion packs (`companion.attach`). See [Interactive Companions and external tools](docs/companions.md).
  19. - **Practise and review.** Start today's study from the **Study library**, shape each course's **Learning method** or ask the main chat for **AI-guided study**, click **Help me understand** on any question, and let FSRS-6 schedule your reviews.
  20. - **Add exam focus highlights, even from screenshots.** Drop chat screenshots, whiteboard photos or scope notes into **Add exam focus…** (works with both vision and text-only models such as DeepSeek): focus topics schedule at shorter intervals, go first in daily rounds and study plans, and generate deeper application and advanced questions. Once topics are saved, the home shows how many are mastered, not yet and without questions, with a link to practise the ones you can't do yet; **Course settings** lists each topic with its questions.
  21. - **Find weak points.** Use **Mistakes & weak points**, **Statistics** and **Mock exam**, which offers a multiple-choice paper, a case paper or an oral interview.
  22. - **Finish with a daily recap.** After answering 10 distinct questions in one course on the same day, generate one recap across its chapters. Retries count once. Choose a friendly or professional tone and opt into automatic generation in Settings. Recaps open in the source reader as publishable Markdown study articles, and saving one as a course source is a separate action.
  23. - **Turn recordings into text.** Import a lecture recording, or transcribe a **Live class** as it happens, and get a Chinese–English transcript you can generate questions from.
  24. - **Read and organise.** The reader keeps its toolbar short (**Contents**, **Make questions**, **Mistakes**, **Mind map**); search, **Translate…**, display settings and **Study tools** are in **More**, and **Practise these pages** is the arrow beside **Make questions**. Courses, **Study notes**, **Jobs** and a **Knowledge outline** keep a term's work together.
  25. - **Works well with** the open-source [Archify](https://github.com/tt-a1i/archify) (MIT licence, by tt-a1i; no partnership with StudyHub): your assistant can draw a knowledge outline as an interactive diagram with it, and StudyHub keeps and shows the file. See [Interactive Companions and external tools](docs/companions.md).
  26. ## Quick start
  27. | You want to | You need | Cost |
  28. | --- | --- | --- |
  29. | Take the sample course and tour, browse sources, practise existing questions | StudyHub only | Free, no model calls |
  30. | Generate questions, explanations and **Help me understand** | A model provider key in DSH **Settings › Models** | Billed by your provider, for example the [DeepSeek API](https://platform.deepseek.com/) |
  31. | Turn recordings into text | A transcription key (or local live engine) in StudyHub **Settings › Audio transcription** | Google Gemini, Groq Whisper and SiliconFlow SenseVoice are supported for recordings (availability and allowances depend on the provider); **Live class** also supports an offline local engine |
  32. 1. **Install DSH** (skip this if you have it). Use the official [Windows x64 installer](https://download.deepseek.com/desktop/dsh-latest-windows-x64.exe) or [macOS Apple silicon installer](https://download.deepseek.com/desktop/dsh-latest-macos-arm64.dmg). On any other computer, install Node.js 22.19 or later and run `npx @deepseek-ai/dsh web`.
  33. 2. **Install StudyHub.** In DSH, open **Plugins**, click **Add plugin**, paste this address and click **Enable**:
  34. ```text
  35. https://github.com/EricWang1358/dsh-web-studyhub/releases/download/v4.13.0/ericwang1358-dsh-daily-flashcard-4.13.0.tgz
  36. ```
  37. Check that the package is `@ericwang1358/dsh-daily-flashcard`, version **4.13.0**. The [release page](https://github.com/EricWang1358/dsh-web-studyhub/releases) is the newest channel: npm's `latest` tag can lag behind it, so install the `.tgz` from the release page. StudyHub then opens by itself. Later, open it from **StudyHub** in DSH's left sidebar (the session tab and the right sidebar also work); you do not need to send a chat message first.
  38. 3. **Take the tour (optional, a minute or two).** On the welcome page, click **Load the sample and start the tour**. The 7-step tour follows the first-run line's order (where the model is set up, add a source, make questions, check the draft, practise), pointing at the real controls, and ends on the line's step 2. A full tour of every page, Jobs included, is offered at its end. The sample makes no model calls and can be removed with one click.
  39. 4. **Add a model.** Paste a key in DSH **Settings › Models** and choose a model in your session. Until then, StudyHub says so wherever a step needs a model, with a **Go to settings** link, instead of letting the step fail later; **Settings › Library & model** shows **Model connected** or **Model not connected** and the steps.
  40. 5. **Start with your own material.** Click **Add source** and drop several PDFs, slides or notes at once. Then use **Generate from sources**, review the draft, publish it and practise.
  41. Notes on installing:
  42. - **Already use DSH?** Install only the plugin. Keep your current desktop app or web server, profile, model settings and workspace.
  43. - **GitHub address fails, or says `unable to get local issuer certificate`?** Use your browser to [download the complete 4.13.0 package](https://github.com/EricWang1358/dsh-web-studyhub/releases/download/v4.13.0/ericwang1358-dsh-daily-flashcard-4.13.0.tgz). **Keep the original `.tgz` file; do not extract it.** In **Add plugin**, enter the absolute path to the file itself, for example `C:\Users\your-name\Downloads\ericwang1358-dsh-daily-flashcard-4.13.0.tgz`, replacing it with your actual saved path. The file must be on the computer or server that runs DSH. See the [local-file install steps](docs/install.md#if-dsh-cannot-download-from-github).
  44. - **Which file on the release page?** A standard install needs only that complete package. It includes the main entry and six components, seven entries in total; there is no need to download, extract or merge the separate component packages. StudyHub installs the optional search extension when you click **Install the search extension**. The checksum list and two setup guides are there for reference.
  45. - More options, including the command line: [installation and model setup guide](docs/install.md). Setup guides you can open in a browser: [English](https://github.com/EricWang1358/dsh-web-studyhub/releases/download/v4.13.0/StudyHub-4.13.0-Setup.html) · [Chinese](https://github.com/EricWang1358/dsh-web-studyhub/releases/download/v4.13.0/StudyHub-4.13.0-Setup.zh-CN.html). DSH itself comes only from the official sources in step 1.
  46. ## Use StudyHub
  47. ### Add sources
  48. Click **Add source**, choose the course, then drop several files at once or paste text. Recordings go in the **Audio / recording** tab of the same window.
  49. | Format | Limit | Notes |
  50. | --- | --- | --- |
  51. | PDF | 8 MB, 200 pages | Kept as one document that you expand to pages. For bigger books, see below |
  52. | Word (.docx), PowerPoint (.pptx, and the old .ppt) | 40 MB | Only text is read. Pictures, charts and SmartArt are skipped, and so are Word text boxes, headers and footers. A presentation keeps one page per slide, with its speaker notes. In an old .ppt, bullet indent levels are not kept |
  53. | Markdown, HTML, TXT | 8 MB | |
  54. | JSON deck | 2 MB | Questions you already have, or ones written elsewhere ([format](docs/json-import.md)) |
  55. | Subtitles (.srt, .vtt) | 8 MB | Needs the audio component |
  56. | Audio (MP3, WAV, M4A, AAC, OGG, FLAC, OPUS, WEBM, AIFF) | 512 MB, 8 hours | See [Transcribe recordings](#transcribe-recordings) |
  57. Old .doc files (and .wps, .key, .pages) are not read. Save them as .docx or PDF first. Password-protected files are not read either.
  58. **Large textbooks** (over 8 MB or 200 pages):
  59. - Click **Convert with MinerU** in the import window. StudyHub converts PDFs up to 800 MB and imports the result as one paged book that you can choose by chapter.
  60. - MinerU runs on this computer. Click **One-click install** in **Settings › PDF conversion** (or right in the import window): StudyHub puts the program, Python and the models into one folder, not on the system drive by default, with no admin rights and nothing to install beforehand. The PDF stays on your computer and no token is needed. The cloud route was removed in 3.5.5 ([details](docs/mineru-conversion.md)).
  61. - To practise across a whole book, use the search extension or the **Step-by-step path** on **Create deck**.
  62. See [large textbooks](docs/large-documents.md) and [MinerU conversion](docs/mineru-conversion.md).
  63. For another route, open the [external Marker guide](docs/marker-external.md) from Add material, download a script to run yourself, then choose its paginated Markdown output. Install Marker and its models separately; code and model licences apply separately.
  64. ### Generate a deck
  65. 1. Open **Create deck**. On the **Generate from sources** tab, choose sources by document (or by chapter for a big book), then the question type, count and difficulty. Not sure what to focus on? **Suggest a focus** proposes topics from your source titles and headings, without sending the full text.
  66. 2. Click **Generate & check deck**. The job runs in the background; you can keep studying.
  67. 3. Review the draft and its citations, then publish it. Publishing checks every question again; questions with a problem stay in the draft. Drafts stay separate from published questions.
  68. To add to an existing deck, choose that deck: approved questions are added, and the old questions and their review progress stay. To bring in questions you already have, use the **Import JSON deck** tab.
  69. <details>
  70. <summary>How generation checks questions</summary>
  71. - Each batch gets one independent review. Questions that pass are kept, and any shortfall is reported. Version 2.5.8 introduced one citation repair; the current workflow verifies knowledge points and answers first, corrects those preparation stages when needed, then writes and independently reviews questions. A question flagged only for wording is re-worded once and re-reviewed alone; there is no open-ended repair loop.
  72. - When you add to an existing deck, reviewed questions are saved even if the generation budget runs out, with no second publish step.
  73. - Citations and question structure are checked in code. The content itself can still be wrong, so read the draft. More in [question quality checks](docs/assessment-quality.md).
  74. - Source text is given to the model as evidence, never as instructions to follow.
  75. - Courses label sources and decks; folders only group decks for display. Every action uses only the courses, sources and decks you selected.
  76. </details>
  77. Save a default question type, count, content language, difficulty and focus in **Settings › Question defaults**; each new request can override them. Questions per batch, parallel batches and the time budget are there too, initially 5, 4 and 20 minutes. Started tasks keep their original choices; a continued draft keeps its own, except the time budget and applying review suggestions, which follow the setting as it is now. See [Generation pace](docs/generation-agents-sidebar.md#what-a-generation-task-does).
  78. ### Interactive Companions
  79. Open **Interactive Companions** on **Course outline** or **Sources** to unpack difficult concepts in a progressive stage-and-voice lesson (`studyhub-lesson/1`):
  80. - **Generate for any discipline (`generation.companion.build`).** A 4-stage pipeline compiles a 16–20 slide, zero-dependency `.html` file into `<workspace>/companions/<course>/` using four interactive stage archetypes — **Parametric & Phase-Plane Math Sandbox** (`sandbox`, pure AST 1D curves, 2D parametric trajectories, phase-plane quiver vector fields, live equilibrium markers and hover crosshair readouts), **Dialectical Counterexample Matrix** (`dialectic`, predict-before-reveal matrices and Socratic lanes), **Closed-Loop Schematic & Force Path** (`mechanism`, curved feedback loops and clickable node details) and **Empirical Trace & Workshop** (`empirical`, `spot`, `try`) — with offline built-in zero-dependency W3C MathML rendering, `?` keyboard shortcut help and `@media print` multi-slide study-sheet export. Grounded builds cite selected materials; free-topic builds work without materials and are honestly marked **AI-drafted**.
  81. - **Mount local packs, live-compile JSON & sync cards (`companion.attach`, `companion.sync`).** Point StudyHub at a single `.html` lesson or a folder of companion pages (`pages/*.html` or unbuilt `lessons/*.json` compiled live): existing courses link matching questions to exact `#slide` anchors (**Enrich existing**), while blank courses deterministically compile takeaway flashcards, boundary quizzes and oral/task drills at **0 model tokens** (**Full pack**, granting **First-Pass Credit** on walkthrough completion). Inside the sandboxed viewer, jump slides, sync dark/light themes, 1-click **Sync disk changes**, or highlight text to look up terms, ask the tutor (`companion.ask`), save cards to **Companion Catch-ups**, and sync `<pack>/feedback/questions.json`. See [Interactive Companions and external tools](docs/companions.md).
  82. ### Practise and review
  83. Today's learning plan connects tasks to the library home. Ask AI for a plan based on real due reviews, weak areas, available materials and accepted tasks. Give feedback to revise it, or accept. Each action has a reason and estimated duration; suggestions become board tasks only after acceptance, with direct start and resume controls.
  84. Today's time budget is separate from your saved weekday/weekend pace; zero minutes supports a rest day. Unfinished actions are allocated within the budget, and completed actions still count toward today's workload. Record actual time after completion. After at least five comparable completed-day records, the median estimates your usual pace; explicitly saved preferences always take priority.
  85. Practice progress counts actual answers, flows use completed steps, and you explicitly mark a reading block complete. Opening content or skipping questions does not count, and completing an action does not establish mastery. AI sees compact titles, progress and exam dates, not full materials. Invalid or unavailable AI results are clearly labelled as local suggestions. Plans are saved by library and date, alongside ordinary board tasks.
  86. - Answer, then read the explanation. **Help me understand** asks a tutor about the current question.
  87. - Rate flashcards and open answers from 0 to 5; FSRS-6 picks the next review date from your rating and the days that really passed since the last review. Each rating button shows the gap it would give. Answering and scheduling make no model calls.
  88. - **Mistakes & weak points** groups wrong answers by deck (or by topic), filters them by deck, status and keyword, and can **Generate variants**. **Mock exam** and **Statistics** show what still needs work.
  89. <details>
  90. <summary>How Help me understand keeps context</summary>
  91. When DSH supports local subagents, repeated **Help me understand** on the same question keeps the same tutor and its conversation, and follow-ups sent together are answered in order. Moving to another question, editing the question or switching model starts a new tutor. A tutor is released after 2 idle minutes or 8 rounds; a new one receives the last 3 answered exchanges. Earlier answers stay saved with the question.
  92. </details>
  93. ### Read your sources
  94. - Sources keep their original file and earlier versions, and open full screen.
  95. - **Original page** shows the PDF page behind a citation, **More › Translate…** adds a translation, and **Practise these pages** (the arrow beside **Make questions**, shortcut P) quizzes you on the pages you are reading.
  96. - Select a passage to ask about it, or to generate candidate questions that you review and add to an existing deck.
  97. - A source imported as text only can get its original back with **Add the original file**, with no reimport.
  98. - When a source changes and a linked position is no longer certain, StudyHub asks you to relocate it instead of guessing.
  99. - Explanations, notes, **Jobs** and the **Inbox** link back to the question or source they are about. The reader and question links help you return to the current question.
  100. - Press `?` to see every keyboard shortcut.
  101. ## Choose a model
  102. Generation, explanations and learning help use the model selected in your DSH session. To use a different model for StudyHub, open **Settings › Library & model** and change **Generation model** from **Follow current session**. DSH stores the model credentials.
  103. - **Everyday use:** the [official DeepSeek API](https://platform.deepseek.com/).
  104. - **Heavy use:** a Coding Plan, but only if it gives you an API key and allows DSH and your actual study use. Before you buy, check its supported tools, endpoint, models, concurrency and quota rules.
  105. - **Subscriptions are not keys:** Claude Pro/Max and ChatGPT/Codex subscriptions do not provide a general API key for DSH. Separately billed Anthropic or OpenAI APIs can be added as third-party providers.
  106. Setup steps: [configure a model provider](docs/install.md#configure-a-model-provider). For how many tokens each feature uses, see [token usage and estimates](docs/token-usage.md).
  107. ## Transcribe recordings
  108. 1. Open **Settings › Audio transcription** and add a key for **Google Gemini** (AI Studio), **Groq** (Whisper) or **SiliconFlow** (SenseVoice, convenient in mainland China).
  109. 2. Open **Audio transcription**, click **Add audio** and then **Start import**. Nothing is uploaded until a provider is set up.
  110. 3. The transcript is saved as a source. Generate questions from it like any other source.
  111. Only transcription uses these keys. Proofreading and translation use your DSH model by default, so their tokens are billed by your model provider and appear under **Model usage** in **Statistics**. **Live class** transcribes lectures in real time (producing bilingual transcripts) using either **Google Gemini** or the **offline local engine** (SenseVoice / Whisper, installed locally with no transcription key).
  112. <details>
  113. <summary>More about audio</summary>
  114. - With several keys, StudyHub tries Gemini free, then SiliconFlow, Groq and Gemini paid. A single import can be set to use paid keys only.
  115. - M4A recordings over 1 hour can be split losslessly with one click.
  116. - Recordings are processed one at a time; within a recording, 2–3 proofreading and translation windows run in parallel. Finished windows are checkpointed, and a retry reuses them.
  117. - The **Proofreading & translation** panel sets the reasoning level for each step: Low, Medium, High or Model default. Higher levels take longer and do not guarantee better accuracy. A level the model does not support falls back to its default. Only high-confidence corrections that pass the source-location check rewrite the text; the rest are left as suggestions for you to check.
  118. - The **Usage console** on the audio page records this plugin's requests to the transcription providers (failures and retries included), tokens and audio minutes. It shows free and paid keys separately, with a 7-day trend, and keeps 31 days. Groq's remaining daily quota comes from its responses; for Gemini, you can enter the daily limit shown in AI Studio to get an estimate. Requests from other apps, live-class streams and DSH model tokens are not counted there.
  119. - Keys are stored in `study/audio.json` in your DSH home (by default `~/.dsh/study/audio.json`), outside the library. The interface shows only whether a key is set and its last 4 characters. Keys never enter library exports or chats. The environment variables `GEMINI_FREE_API_KEY`, `GEMINI_PAID_API_KEY`, `GROQ_API_KEY` and `SILICONFLOW_API_KEY` fill in a key that is not saved.
  120. </details>
  121. See [audio import](docs/audio-import.md) and [live class](docs/live-class.md).
  122. ## Use StudyHub from the DSH chat
  123. - **Study mode preset.** For a new session, pick the agent preset **StudyHub · Study Mode**. The assistant then takes "materials", "my notes" or "this lecture" to mean your StudyHub library, replies in your language, and asks when a request is ambiguous. It has the same tools as DSH's standard preset, so it can also run commands and edit files to convert material (for example split a question book by chapter) before importing it: it writes the results under `studyhub-work/` in the workspace, never deletes or overwrites your originals, and asks before installing anything.
  124. - **Ask about your library** in the main chat: see [query sources and decks from the main chat](docs/main-session-queries.md).
  125. - **Save a question you could not answer.** Type `/study-spar <your question>` in a DSH chat. StudyHub files it in your question bank as a flashcard. Add `--mq` (or `as MCQ`) for single choice, `--multi` (or `as multi-select`) for multiple choice, or `--open` (or `as open question`); start with `--pre` (or `prerequisite:`) to file it as a prerequisite of the question you are working on.
  126. - **Follow background tasks** in DSH's sidebar: see [background tasks and the sidebar](docs/generation-agents-sidebar.md).
  127. ## Update StudyHub
  128. DSH plugins do not update themselves, and restarting DSH alone keeps the old version.
  129. - **2.1.2 and later:** StudyHub asks GitHub for a new release at most every 6 hours. When there is one, a **Version x.y.z available** chip appears in its sidebar, where x.y.z is the new version. Click it, then **Upgrade to x.y.z** and **Upgrade now**. StudyHub downloads the package, checks it against the release's `SHA256SUMS-x.y.z.txt` and hands it to DSH's plugin manager. If background tasks are running, **Stop tasks and upgrade** stops them and keeps their finished parts. The check sends no study data; switch it off in **Settings › About & updates**.
  130. - **Older versions, or a DSH that cannot install from inside the app:** finish or cancel background tasks, open **Plugins**, uninstall StudyHub, then use **Add plugin** with the new release's package address.
  131. Then restart DSH. Quit the desktop app fully (including the tray icon) and reopen it, or restart the web service with its original profile and reload the page. A browser refresh alone does not load new plugin code. Your library and settings are kept.
  132. ## Data and privacy
  133. **Stays on your computer**
  134. - The library: sources and their original files, decks, answers and review schedules, saved in shards. By default it is in the DSH session's workspace folder; choose another folder in **Settings › Library & model**.
  135. - Transcription keys, in `study/` in your DSH home (by default `~/.dsh/study/`). They never enter the library, exports or backups. DSH keeps the model keys. (A MinerU token saved by a version before 3.5.5 stays in `study/mineru.json`; nothing reads it any more, and you can delete it.)
  136. - The usage frequency record, if you turn it on in **Settings › Usage frequency record**. It is off by default, and StudyHub never sends it anywhere ([details](docs/usage-frequency.md)).
  137. **Leaves your computer only when you use the feature**
  138. - Generating questions or asking for help sends the selected source text to your model provider through DSH. **Suggest a focus** sends only titles and headings.
  139. - Recordings go to your transcription provider. PDF conversion with MinerU runs on this computer; installing it downloads the program and its models (from mainland mirrors or the official sources) and uploads nothing.
  140. - The update check asks GitHub for the latest version and sends no study data.
  141. **Backups and older libraries**
  142. - In **Settings › Import, schedule and backup**, **Backup & restore** exports one JSON file with your sources, decks, review progress and answers. Original files that were copied into the library are included; originals attached by reference are only listed.
  143. - A restore first saves the current library under `backups/`. It is refused while a generation job is running.
  144. - An older library is migrated on its first write, and its original file is backed up. Libraries missing newer optional fields stay usable, and data from a plugin that is not installed is kept.
  145. - To import a library from the older `study-lib-spar` tool, use the same Settings category and choose the folder that holds `study-lib.json`, `nodes/` and `quizzes/` (not the tool's source code). The import only reads those files, keeps the due dates, intervals and sources it can parse, and importing again does not overwrite existing progress.
  146. - Clearing finished task cards keeps the sources and questions they produced. Audio usage records and keys are not part of library backups.
  147. ## Interface language
  148. The interface starts in Chinese when your browser's first preferred language is Chinese, and in English otherwise. Switch it with **Language** at the bottom of the sidebar; StudyHub remembers your choice. Buttons, errors, background progress, notifications, messages handed to the chat and new AI explanations follow it.
  149. Switching does not translate what you saved: sources, file names, questions, notes and provider replies stay in their original language. New questions use the interface language unless you choose another in the **Language** field of **Create deck**. To read English under a Chinese question while you practise, click **EN** on the practice toolbar ([details](docs/translate-en.md)). Audio transcripts keep their own source and translation languages.
  150. ## Choose components
  151. The complete package installs seven components. DSH's own plugin manager lists them as **StudyHub** (the main package), **StudyHub · Core**, **StudyHub · Materials**, **StudyHub · Question bank**, **StudyHub · Question generation**, **StudyHub · Practice & review** and **StudyHub · Audio**. Turn each one on or off there. Saved data is kept while a component is off.
  152. - **Create deck** needs Materials, Question bank and Question generation. Practice, **Mistakes & weak points**, **Mock exam** and **Statistics** need Question bank and Practice & review.
  153. - A component that is off hides its pages or says that it is turned off.
  154. - If several installed packages provide the same component, turn all of them off to switch it off.
  155. - The release page also has each component as a separate package.
  156. Details and safe source deletion: [customise components](docs/install.md#customise-components). Command-line installs: [install from the command line](docs/install.md#install-from-the-command-line).
  157. ## Development
  158. StudyHub is an ES-module DSH plugin built on Cordis, with a React interface bundled by esbuild. Its seven components work together through public plugin APIs; see [architecture](docs/architecture.md). The package is named `@ericwang1358/dsh-daily-flashcard`; the product name is StudyHub.
  159. ```sh
  160. npm install --legacy-peer-deps
  161. npm run verify # lint, tests and build
  162. npm run test:fast # the tests without browser, ffmpeg and program-starting files, for quick iteration
  163. npm run dev # preview at http://127.0.0.1:4178 (after a build)
  164. npm run build:demo # static demo in output/static-demo-site/dist
  165. npm run release:pack # release packages and SHA256SUMS-<version>.txt in output/release-<version>
  166. ```
  167. - `npm run dev` needs `npm run build` (or `npm run verify`) first, because it serves `dist/`. It uses a throwaway library in `output/preview-library` and keeps global study files in `output/preview-home`, never in `~/.dsh`. Add `-- --library=<dir>` to open another library, and set `STUDY_FAKE_MODEL=1` for a deterministic fake model.
  168. - `npm run release:pack` does not build; run `npm run verify` first.
  169. - `npm test` (and so `npm run verify` and CI) always runs every test file, starting the longest first from the durations of the last run (cached in `node_modules/.cache/studyhub-tests/`; a machine with no timings of its own, such as a CI runner, orders by `tests/test-weights.json`). Full runs on one machine take turns through a lock file in `~/.cache/studyhub-tests/`: a second run prints one line and waits (at most 20 minutes, then it goes ahead with fewer workers); set `STUDY_TEST_NO_LOCK=1` to skip the queue. `npm test -- tests/<file>.test.mjs` runs just those files without queueing.
  170. - `npm run test:fast` skips the files named in `tests/slow-tests.json`: those that launch a browser, run ffmpeg or start another program. `tests/slow-tests-list.test.mjs` fails when a new test file does one of these and is not listed, so the fast tier stays fast; run `npm run verify` before a pull request.
  171. - The host supplies the DSH SDKs `@deepseek-ai/dsh-tools` and `@deepseek-ai/dsh-llm` (optional peers, `>=0.2.0-rc.2 <0.3`). Tests that need a missing SDK report an explicit skip.
  172. - CI runs on Node 22, on Ubuntu and Windows, for every pull request: lint and the build once (Ubuntu), and the tests cut into shards of about equal weight (3 on Ubuntu, 5 on Windows), each shard on its own machine, with one `verify` check that is green only when lint and every shard are. A new push to a pull request replaces the checks still running for it. `node scripts/test.mjs --shard=2/5` runs one shard locally (`--list` with `node scripts/qa/run-tests.mjs` names its files). `tests/test-weights.json` says roughly how long each test file takes, so that every machine cuts the suite the same way and a fresh machine starts the longest files first; refresh it with `node scripts/qa/test-weights.mjs --write <durations.json>` (the shards of a CI run upload theirs as `durations-*` artifacts; add `--sum` for the files of one run). A separate, non-blocking `browser-smoke` job (`.github/workflows/browser-smoke.yml`, Ubuntu) installs Playwright's Chromium and runs four real-browser test files (shell, review reveal, mistakes page, right-sidebar hand-off) that otherwise skip in the shards for want of a browser; it stays green when they fail, so open its run to see the result. To make it blocking, remove its `continue-on-error` and require it in the branch protection.
  173. - The [static demo](docs/static-demo.md) runs the real interface with public examples and prepared replies instead of a live model.
  174. ## Documentation
  175. - **Install:** [installation and model setup](docs/install.md)
  176. - **Sources:** [PDF to quizzes and flashcards](docs/pdf-workflow.md) · [large textbooks](docs/large-documents.md) · [MinerU conversion](docs/mineru-conversion.md) · [JSON deck import](docs/json-import.md)
  177. - **Science tools and media:** [display settings and local tools](docs/science-settings.md) · [images and formulas](docs/images-latex.md) · [calculation guidance](docs/calculation-guidance.md)
  178. - **Questions:** [quality checks](docs/assessment-quality.md) · [your own reference questions](docs/reference-questions.md) · [adding questions to a deck](docs/supplementation.md) · [retiring a question](docs/slay.md) · [showing questions in English](docs/translate-en.md) · [token usage](docs/token-usage.md)
  179. - **Studying:** [course study, archived learning flows and study notes](docs/study-workflows.md) · [coaching and personalised questions](docs/coach.md) · [follow-up questions](docs/followup.md)
  180. - **Audio:** [audio import](docs/audio-import.md) · [live class](docs/live-class.md)
  181. - **Chat and tasks:** [main chat queries](docs/main-session-queries.md) · [background tasks and the sidebar](docs/generation-agents-sidebar.md)
  182. - **Interactive Companions & external tools:** [cross-discipline HTML lessons, companion packs and Archify](docs/companions.md)
  183. - **Optional:** [usage frequency record](docs/usage-frequency.md) · [Jev decision layer (experimental)](docs/jev-experimental.md)
  184. - **Developers:** [architecture](docs/architecture.md) · [architecture case study](https://github.com/EricWang1358/dsh-web-studyhub/tree/main/docs/case-study) · [verification records](docs/verification.md) · [voice and tone for interface text](docs/voice-and-tone.md) · [FSRS-6 review scheduling](references/sm2-scheduling.md) · [legacy study-lib-spar format](references/library-schema.md)
  185. ## Join the project
  186. Contributions of code, bug reports, testing and documentation are welcome:
  187. - Open an issue or feature discussion in [GitHub Issues](https://github.com/EricWang1358/dsh-web-studyhub/issues), or send a pull request after running `npm run verify`.
  188. - Chinese-speaking contributors can also join the StudyHub QQ group listed in [README.zh-CN.md](README.zh-CN.md).
  189. ## Feedback and license
  190. Report a bug or ask a question in [GitHub Issues](https://github.com/EricWang1358/dsh-web-studyhub/issues).
  191. MIT License; see [LICENSE](LICENSE). The learning-quality and scheduling references are in [`references/`](references/).

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.