Study-Mate
你的AI学习搭档:定路线、讲知识、做项目,边学边做,学透一门科目
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
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/Miaotofu01/Study-Mate 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/Miaotofu01/Study-Mate'
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
Markdown
[](/listings/miaotofu01--study-mate)HTML
<a href="/listings/miaotofu01--study-mate"><img src="/api/listings/miaotofu01--study-mate/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
- web端
dsh plugin --profile web add @yunmiao/studymate
- 桌面端
dsh plugin --profile desktop add @yunmiao/studymate
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 · 192 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.
- <p align="center"><img src="docs/images/logo.png" width="120" alt="StudyMate"></p>
- <h1 align="center">StudyMate</h1>
- <p align="center"><b>你的AI学习搭档:定计划、讲知识、做项目,学透一门科目</b></p>
- <p align="center">
- <img src="https://img.shields.io/badge/DSH-%E5%AD%A6%E4%B9%A0%E6%A8%A1%E5%BC%8F%E9%A2%84%E8%AE%BE-1c5a40" alt="DSH 学习模式预设">
- <img src="https://img.shields.io/badge/Antigravity-%E5%A4%9A%E6%99%BA%E8%83%BD%E4%BD%93%E6%8F%92%E4%BB%B6-4285f4" alt="Antigravity 插件">
- <img src="https://img.shields.io/badge/Node.js-24%2B-339933" alt="Node.js">
- <img src="https://img.shields.io/github/license/Miaotofu01/Study-Mate" alt="MIT License">
- </p>
- <p align="center"><sub> StudyMate 是面向数学与计算机科目学习的助手,原则是「learn with doing」</sub></p>
- <p align="center">简体中文 · <a href="README.en.md">English</a></p>
- <p align="center"><a href="#快速开始">快速开始</a> · <a href="#它是什么">它是什么</a> · <a href="#核心功能">核心功能</a> · <a href="#常见问题">常见问题</a> · <a href="docs/使用/使用说明.md">使用说明</a> · <a href="docs/使用/Antigravity.md">Antigravity 说明</a></p>
- <p align="center"><img src="docs/images/taitou.png" width="860" alt="StudyMate:看板娘 + 手写体品牌字 + 覆盖科目(线代/微积分/概率论/C++/Python/机器学习/深度学习)+「任何科目,一站式搞定 / Learn With Doing」"></p>
- ## 前言
- 本项目原先是vibe出来给自己用的一个小项目,没想到有这么多人喜欢。但是vibe出来的东西有很多的问题,包括但不限于「文档过于臃肿且充满AI味、可读性极差」、「海量且无用的防御性代码」、「混乱的功能模块」。
- 虽然现在跑起来的效果也不差,但是跟我理想中的效果还是有很大差距
- 我觉得这样的东西对不起这么多的信任与star,我会直视这些问题,并且人工修改审查每一个文件,在未来的更新维护中给大家带来更好的体验,感谢大家的使用与支持,有任何建议都可以提个issue,本项目将长期维护。
- ## 快速开始
- ### DeepSeek Harness
- **DSH 依赖**:DSH 0.1.7-alpha.1+
- #### 安装
- - web端
- ```bash
- dsh plugin --profile web add @yunmiao/studymate
- ```
- - 桌面端
- ```bash
- dsh plugin --profile desktop add @yunmiao/studymate
- ```
- #### 更新
- - web端
- ```bash
- dsh plugin --profile web update @yunmiao/studymate@latest
- ```
- - 桌面端
- ```bash
- dsh plugin --profile desktop update @yunmiao/studymate@latest
- ```
- - **第一次学习**:新建会话时选「学习模式」,说一句「我想学 [某个科目]」。学习数据直接写进配置好的学习工作区(暂存模式已删,没有"收尾问落点再搬一次"这一步)。
- - **还没想好学什么**:在学习对话里说「我不知道学什么,帮我选方向」,可选探索后再决定是否开课;已有明确科目或恢复学习直接走原流程。
- - **学习工作区默认在 `~/StudyMate`,所有课件与记忆均存放在工作区**;已有配置会沿用。
- - **阅读在 DSH 的阅读端**:装好后新建会话时选「学习模式」,从侧边栏切到阅读端就能读课件、作答、搜资料——页面由阅读端实时渲染,不再预生成 HTML。
- 工作区、更新、桌面端与换机器续学、以及老版本 DSH 的替代装法见 [安装说明](docs/使用/安装.md)。
- ### Codex 和 ChatGPT Work
- > **支持范围:只有 `v1.0.0`。** 1.1.0 起的版本不再保证在这一侧可用。
- 从 [`v1.0.0` 的 Release](https://github.com/Miaotofu01/Study-Mate/releases/tag/v1.0.0)([ZIP 直链](https://github.com/Miaotofu01/Study-Mate/releases/download/v1.0.0/studymate-openai.zip))下载 **studymate-openai.zip**,通过 Codex/ChatGPT 提供的插件导入入口导入(详见 [导入说明](docs/使用/Codex与ChatGPT.md))。这一侧没有后续版本可换,换机器时用同一个 ZIP。
- ### Google Antigravity
- > **支持范围:只有 `v1.0.0`。** 1.1.0 起的版本不再保证在这一侧可用。
- 用 `v1.0.0` 那棵树构建并安装(不要用 `main`):
- ```bash
- git checkout v1.0.0
- node bin/studymate.mjs build-antigravity --install
- ```
- 或者通过 `npm run build:antigravity` 构建 ZIP 包手动导入(详见 [Antigravity 说明](docs/使用/Antigravity.md))。
- ## 它是什么
- StudyMate 是一套**数学/计算机学习工作流、SKILL 与 DSH 插件**,支持 DSH(DeepSeek Harness)的「学习模式」预设、Google Antigravity 原生多智能体插件,也可打包为 Codex 和 ChatGPT Work 插件。它按需组织收集资料、采图、课程设计、讲解、练习评估五个角色;宿主支持时可委派给子代理,否则依次完成各角色工作。
- - **课程组成:讲解|练习|项目实操**:每门课一份大纲——知识点按前置依赖排成路线图,每个知识点标课的类型「概念课 | 实操课 | 实验课」(大纲里写 `概念`/`实操`/`实验`)。学习进度落在文件里,每次新对话可继承已有进度。
- - **跨科目共享记忆**:记住你的现有水平、哪种讲法有效、常见卡点,下一门课不用重新自我介绍。
- ## 为什么用它
- | 常见做法 | 卡在哪 | StudyMate 的做法 |
- | ---------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------ |
- | 直接跟 AI 聊天学 | 会话一长上下文就吃不下;聊完不留痕,下次从零开始 | 信息与偏好由记忆文件保存;每次会话只带相关记忆、上下文短;课件是教科书式的讲解与配图 |
- | 看视频课 / 网课 | 质量参差不齐;付费;无法跟随前沿发展的节奏 | 讲解方式定制化;收集最新的资料与标准;完全开源 |
- ## 核心功能
- **课程总览与大纲路线图**:总览页列全部科目与当前节点,点进去是那门课的知识点路线图,按依赖分层排开、按状态着色,点节点原地展开课件子卡片。
- <img src="docs/images/preview-index.png" width="640" alt="路线图示例">
- **课件是学习的主载体**:经典教材的讲解风格,丰富的配图,定制化的题目与项目目标。
- <img src="docs/images/preview-lesson.png" width="640" alt="课件示例">
- 阅读端就是产出本身:课件页由阅读端实时渲染,公式、配图、题目都在里面;需要一份能离线打开的副本时走导出(`npx -y @yunmiao/studymate export`,产物在 `<工作区>/export/`)。仓库里**不再入库示例工作区**——测试用的科目现造现弃([ADR-0009](docs/adr/0009-示例与生成产物不再入库.md)),示例截图见上面的预览图。
- ## 用法示例
- - **「我不知道学什么,帮我选方向」** → 一次聊一个问题,可跳过或先看建议;选定方向后补齐开课信息,确认后接回建课与首课流程(见 [可选方向探索](docs/使用/使用说明.md#可选先探索学习方向))。
- - **「我想学 C++ 打竞赛」** → 先盘问目的/程度/项目/实验方式,再产出大纲路线图与科目主页,开第一课。
- - **带着指定教材自学** → 盘问结束后主动提供本地资料路径(讲义、笔记或教材目录),系统把教材转成 Markdown 放进 `reference/`(学生能翻),把它收集到的在线来源转成 Markdown 放进 `sources/`(写课对齐用);大纲与课件都对着这批原文写。
- - **贴一段看不懂的课文 + 「这里没懂」** → 主教练当场答一小段,记一条档案,送你回原位接着读。
- - **「考考我」** → 现场出题 + 按可运行证据核验,给一份评估记录并更新进度。
- - **「太简单了 / 没听懂」** → 换讲法(加边界与反例,或降一层抽象),并把这条偏好记进共享记忆。
- <img src="docs/images/preview-chat.png" width="640" alt="对话示例">
- ## 配置与维护
- 日常要跑的命令只有一条,就是你装完之后自检的那条:
- ```bash
- npm test
- ```
- 它不需要真实 DSH、浏览器或模型服务;测试自己造临时科目,不碰你的学习工作区。引擎脚本已经没有了(Python 随 #83 退役),**原生工具的清单与参数**只有两个出处:代码是 [`lib/tools/index.ts`](lib/tools/index.ts),人读的那份是[原生工具契约](preset/skills/learning-system/references/tools.md);各命令的前置、按需入口(真实浏览器、真实 DSH)与退出码语义见[测试说明](scripts/tests/README.md)——几处各是唯一出处,本文不重抄。
- 独立 Web 运行时(`study-mate-web/`,FastAPI + Next.js)曾落在主线,现已移出到分支 [`web/0.7.0-beta`](https://github.com/Miaotofu01/Study-Mate/tree/web/0.7.0-beta)——它自带一套引擎,与插件端读写同一份学习工作区,等有人把它适配到新引擎后合回。为什么移出、合回前必须满足什么,见 [ADR-0013](docs/adr/0013-Web运行时移出主线.md)。
- ## 项目结构
- 目录树、每个目录干什么、哪个文件归谁维护,见[工程约束](docs/规范/工程约束.md) §二 目录与规则归属
- 与[文件归属](docs/规范/文件归属.md)——两处各有唯一出处,这里不再抄一份。
- DSH 侧就是**一个插件包**(`@yunmiao/studymate`):Host 半注册原生工具与阅读端数据路由,Client 半是阅读端本体;预设与工作区配置由安装器写。学习数据默认位于独立的 `~/StudyMate`,无需保留源码仓库;详见 [安装说明](docs/使用/安装.md)。
- 学习工作区里面长什么样(科目文件夹、课件、lab、档案、课型与题型),见 [使用说明 §六](docs/使用/使用说明.md#六学习数据存在哪)。
- **无界笔记**接入,在学习界面的左上角中切换,拥有独立的笔记界面、无界画布与节点等内容。功能仍在开发中。相关文档见:状态唯一出处是[无界笔记设计](docs/设计/无界笔记.md) §0;模块、单入口构建与独立数据域见 [ADR-0015](docs/adr/0015-无界笔记模块与独立数据域.md),首轮持久化见 [ADR-0016](docs/adr/0016-无界笔记持久化与单文件版本栅栏.md),保留下来的网页开发与验收入口见 [`prototypes/unbounded-notes/`](prototypes/unbounded-notes/README.md)。
- ## 常见问题
- <details>
- <summary><b>装完看不到课件页</b></summary>
- 课件由**阅读端实时渲染**,不再预生成 HTML(页面模板已随 #83 退役)。在 DSH 里新建会话选「学习模式」,从侧边栏切到阅读端即可。要一份能离线打开的,跑 `npx -y @yunmiao/studymate export`,产物在 `<工作区>/export/`。
- </details>
- <details>
- <summary><b>还需要装 Python 吗</b></summary>
- 不需要。引擎从 Python 脚本迁到了随包发的 TypeScript 插件([ADR-0002](docs/adr/0002-引擎改用TypeScript.md)),安装器也不再探测 Python。只有一件事另外要 Node:导出静态页面时要一份 React(`npm i -g react react-dom`,或用 `STUDYMATE_REACT_DIR` 指过去)。
- </details>
- 更多问题(手改 YAML 的坑、大纲改节点后指针为什么会错、能不能离线)见 [使用说明 §八 常见问题](docs/使用/使用说明.md#八常见问题)。
- ## 贡献 / License
- - **项目交流群**(QQ):161914370
- - **参与开发**:[CONTRIBUTING.md](CONTRIBUTING.md)(改哪块先读哪份、本地怎么验、提交信息规范)
- - **变更日志**:[CHANGELOG.md](CHANGELOG.md)
- - **文档**:[使用说明](docs/使用/使用说明.md)(日常怎么用、课型与题型、检查与档案规则)· [Codex 与 ChatGPT](docs/使用/Codex与ChatGPT.md)(OpenAI 插件构建、安装与工作区)· [Antigravity 说明](docs/使用/Antigravity.md)(Antigravity 插件构建、多智能体协同与安装)· [课件内容格式](docs/规范/课件内容格式.md)(内容文件与题目位置的语法)· [阅读端呈现](docs/规范/阅读端呈现.md)(四个面「看起来对不对」的意图判据)· [文件归属](docs/规范/文件归属.md)(代称 ↔ 路径 ↔ 维护者)· [Agent 交接协议](docs/规范/Agent交接协议.md)(staged 子代理交付的机器边界)· [目标态规格](docs/设计/目标态规格.md)(重构后系统的形状与门禁)· [工程约束](docs/规范/工程约束.md)(目录约定、规则归属、原生工具指针)· [工作区数据骨架](templates/README.md)
- ### 提改动前先跑这几条
- 规矩见 [CONTRIBUTING.md](CONTRIBUTING.md);各命令要跑什么、前置是什么见 [测试说明](scripts/tests/README.md)。
- ### License
- MIT(见 [LICENSE](LICENSE),版权 Cattofu)。
- ## Star 趋势
- <p align="center">
- <a href="https://star-history.com/#miaotofu01/study-mate&Date">
- <picture>
- <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/chart?repos=miaotofu01/study-mate&type=date&theme=dark" />
- <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/chart?repos=miaotofu01/study-mate&type=date" />
- <img alt="Star History Chart" src="https://api.star-history.com/chart?repos=miaotofu01/study-mate&type=date" />
- </picture>
- </a>
- </p>
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.