Skip to content
Back to search

MindTrain

AI-driven knowledge training platform with pluggable schedulers, Codex Skill integration, and optional Anki/FSRS support.

Safety scan

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

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/shigella520--mindtrain/badge.svg)](/listings/shigella520--mindtrain)

HTML

<a href="/listings/shigella520--mindtrain"><img src="/api/listings/shigella520--mindtrain/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

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 · 305 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. <p align="center">
  2. <img src="assets/brand/mindtrain-icon.png" width="128" alt="MindTrain 图标" />
  3. </p>
  4. <h1 align="center">MindTrain</h1>
  5. <p align="center">
  6. <a href="README.en.md">English</a> ·
  7. <strong>简体中文</strong> ·
  8. <a href="README.zh-TW.md">繁體中文</a>
  9. </p>
  10. <p align="center">
  11. <strong>私有 AI 知识训练平台:把想学的知识,变成每天可以练的题。</strong>
  12. </p>
  13. <p align="center">
  14. <a href="https://mindtrain.jianyutan.com/">在线演示</a> ·
  15. <a href="#5-分钟开始使用">快速开始</a> ·
  16. <a href="doc/CodexPlugin部署.md">Codex Plugin</a> ·
  17. <a href="doc/部署与运维.md">部署与运维</a>
  18. </p>
  19. <p align="center">
  20. <a href="https://github.com/shigella520/MindTrain/actions/workflows/ci.yml"><img src="https://github.com/shigella520/MindTrain/actions/workflows/ci.yml/badge.svg" alt="CI" /></a>
  21. <a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="MIT License" /></a>
  22. <a href="https://openjdk.org/projects/jdk/21/"><img src="https://img.shields.io/badge/Java-21-ED8B00?logo=openjdk&logoColor=white" alt="Java 21" /></a>
  23. <a href="https://spring.io/projects/spring-boot"><img src="https://img.shields.io/badge/Spring_Boot-3.5-6DB33F?logo=springboot&logoColor=white" alt="Spring Boot 3.5" /></a>
  24. </p>
  25. MindTrain 是一个面向 Codex 和其他 AI 客户端的开源知识训练平台。AI 负责出题和讲解,MindTrain 负责判分、记录和调度。你可以像普通聊天一样随时追问、质疑和索要提示。
  26. - **对话不中断**:遇到不懂的概念直接问,当前题目不会被误判为已作答。
  27. - **数据归自己**:单用户私有部署,题库和学习历史保存在自己的 PostgreSQL 中。
  28. - **真正形成闭环**:复习旧题、按需生成新题、记录错误,并控制每天的新题与到期积压。
  29. - **知识目录初始化**:既可通过 AI 对话规划领域与知识点,也可指定本地资料目录整理知识树;完整预览并确认后才保存。
  30. MindTrain 核心不绑定具体知识领域;每个私有实例可以独立管理自己的领域、知识点和题库。
  31. ## 使用预览
  32. ### 如何工作
  33. ![MindTrain 内部架构](doc/architecture-overview.svg)
  34. - Training Core 是题目、会话、作答、复习状态和配置的权威数据源。
  35. - Trainer MCP 只调用 Core API,不直接访问数据库。
  36. - Skill 负责教学和工具编排,不保存业务数据。
  37. - AI 临时题会先校验并入库再展示;作答前可拒绝并物理删除,作答后转为普通复习题。
  38. 设计决策和数据边界见[概要设计](doc/概要设计.md)。
  39. ### 训练流程
  40. ![MindTrain 训练流程](doc/training-flow.svg)
  41. 一次训练并不是简单的“显示答案”:调度器先根据到期状态和新题额度选题;用户可以在提交前无限追问;只有明确提交选项后,Core 才会精确判分并追加学习记录。题库不足时,Core 会返回结构化生成要求,由 Codex 生成、Core 校验入库后再展示。
  42. 每轮题量、复习与新题配额、积压暂停规则和 AI 临时题有效期均由数据库配置控制,可在 Web 管理页调整。
  43. ### 在 Codex 中训练、追问和复习
  44. ![MindTrain Codex 对话式训练示例](doc/preview-codex-training.png)
  45. 在线演示:[https://mindtrain.jianyutan.com/](https://mindtrain.jianyutan.com/)(可公开查看示例统计;训练需要连接自己的私有实例)
  46. ## 为什么使用 MindTrain
  47. | 能力 | 你得到什么 |
  48. | --- | --- |
  49. | 对话式 AI 教练 | 在同一题中追问概念、索要提示、质疑答案,再继续作答 |
  50. | 确定性判分 | 单选和多选按选项集合精确判分,不让模型“凭感觉”决定分数 |
  51. | 抗遗忘调度 | 默认平衡复习题和新题;积压过高时自动暂停新题 |
  52. | AI 补题 | 题库不足时由 Codex 按指定知识点、题型和难度生成并校验新题 |
  53. | 本地资料库 | 支持 MD、TXT、PDF、DOCX、PPTX;原文和索引只留在本机 |
  54. | 训练地图 | 在知识点树中查看未训练、积累中、待加强、巩固中、已掌握,以及到期与逾期数量 |
  55. | 题目维护 | 答前答后均可通过 Codex 修订;Web 和 Codex 支持删除、恢复,保留历史版本与答题记录;未作答当前版本不显示答案 |
  56. | 掌握双榜 | 根据掌握度和最低作答样本区分待加强、擅长与数据积累中的知识点 |
  57. | 私有数据 | Core 是唯一权威数据源;Skill 无状态,仓库不承载运行数据 |
  58. | Web + Codex | Web 用于看板、训练地图、题库管理、旧题复习和配置;Codex 用于完整 AI 教练和题目修订 |
  59. 当前可用:Training Core、Trainer MCP、MindTrain Web、Codex Plugin 和加权调度。Anki / FSRS Provider 尚在规划中。
  60. ## 5 分钟开始使用
  61. ### 前置条件
  62. - Git
  63. - Docker 与 Docker Compose
  64. - Codex CLI 或 Codex App(使用 AI 教练时需要)
  65. ### 1. 安装并启动 MindTrain
  66. ```bash
  67. git clone https://github.com/shigella520/MindTrain.git
  68. cd MindTrain/deploy/core-only
  69. cp .env.example .env
  70. ```
  71. 编辑 `.env`,至少替换下面两项:
  72. ```dotenv
  73. POSTGRES_PASSWORD=请替换为随机数据库密码
  74. MINDTRAIN_BOOTSTRAP_TOKEN=请替换为随机长令牌
  75. ```
  76. 可以使用 `openssl rand -hex 32` 生成随机值。`MINDTRAIN_BOOTSTRAP_TOKEN` 同时保护 Codex → Trainer MCP 和 Trainer MCP → Core,请勿提交或公开。
  77. ```bash
  78. docker compose up -d --build
  79. docker compose ps
  80. ```
  81. 等待四个容器健康后访问:
  82. - Web:[http://127.0.0.1:4173](http://127.0.0.1:4173)
  83. - Core 健康检查:[http://127.0.0.1:8080/actuator/health](http://127.0.0.1:8080/actuator/health)
  84. - MCP 健康检查:[http://127.0.0.1:8787/actuator/health](http://127.0.0.1:8787/actuator/health)
  85. PostgreSQL 不对宿主机开放;Core、MCP 和 Web 默认只监听 `127.0.0.1`。
  86. ### 2. 配置 Codex Plugin
  87. 先安装 MindTrain Plugin:
  88. ```bash
  89. codex plugin marketplace add shigella520/MindTrain --ref main
  90. codex plugin add mindtrain@mindtrain
  91. ```
  92. 安装完成后新建一个 Codex 任务,输入:
  93. ```text
  94. $mindtrain 配置我的 MindTrain 实例
  95. ```
  96. 按提示提供:
  97. 1. MCP 地址。本机部署使用 `http://127.0.0.1:8787/mcp`;云端部署使用自己的 HTTPS 地址。
  98. 2. `.env` 中的 `MINDTRAIN_BOOTSTRAP_TOKEN`。
  99. 配置只保存在本机用户配置目录,不进入项目仓库。完整安装、升级和故障排查见 [Codex Plugin 部署](doc/CodexPlugin部署.md)。
  100. ### 3. 创建训练领域
  101. 第一次训练前,先告诉 MindTrain 你想学习什么。一个私有实例可以管理多个训练领域,每个领域可以包含多棵知识点树。
  102. 最简单的方式是让 Codex 根据学习目标规划领域:
  103. ```text
  104. 使用 $mindtrain,根据【我的学习目标】创建一个训练领域。请先展示完整知识点树,等我确认后再保存。
  105. ```
  106. 使用前请把 `【我的学习目标】` 替换为具体内容,例如“准备 Kubernetes 运维面试,重点掌握 Pod、Deployment、Service 和故障排查”。如果没有提供具体目标,MindTrain 会先询问学习主题、范围和期望深度,再生成知识点树。
  107. 如果已有自己的学习资料,也可以指定本地目录:
  108. ```text
  109. $mindtrain 使用 /path/to/notes 创建 backend-notes 资料库,
  110. 为我整理训练领域和知识点,预览确认后保存
  111. ```
  112. 无论使用哪种方式,Codex 都会先展示完整的领域信息和知识点树;只有你明确确认后,MindTrain 才会原子写入 Core。通过本地资料创建时,Plugin 会在本机缓存目录建立私有解析环境和全文索引,Core 不接收文件原文、绝对路径或本地索引。PDF 首期只抽取文本,不做 OCR。
  113. 创建完成后,可以在 Web 的“知识目录”中浏览知识树、搜索知识点并查看题目覆盖和掌握度。详细说明见[知识目录](doc/知识目录.md)。
  114. ### 4. 开始第一次训练
  115. 新建一个任务并输入:
  116. ```text
  117. $mindtrain 开始训练
  118. ```
  119. 只有一个训练领域时会自动使用;存在多个领域时,Codex 或 Web 会要求你选择本次训练的领域,例如 `$mindtrain 开始 ai-agent 训练`。一次训练 Session 只会从所选领域出题,不会在多个领域之间随机混合。
  120. 你可以在任何一道题中直接问:
  121. ```text
  122. 这个概念具体是什么?
  123. 为什么 B 不对?
  124. 先给我一个提示,不要公布答案。
  125. 这道题不适合当前主题,换一道。
  126. ```
  127. 只有明确提交选项时才会产生 Attempt;普通追问不会消耗题目。
  128. ## 云端私有部署
  129. MindTrain 面向单用户私有部署。推荐只通过反向代理公开 Web 和 Trainer MCP:
  130. ```text
  131. https://mindtrain.example.com/ -> http://127.0.0.1:4173/
  132. https://mindtrain.example.com/mcp -> http://127.0.0.1:8787/mcp
  133. ```
  134. 云端 MCP 必须使用 HTTPS 和 Bearer Token。不要公开 PostgreSQL,也没有必要把 Core 端口暴露到公网。
  135. Nginx/Caddy/Cloudflare Tunnel、健康检查、备份恢复、升级和完整配置说明见[部署与运维](doc/部署与运维.md)。
  136. ## 升级 MindTrain
  137. 升级分为服务端和 Codex Plugin 两部分。升级前先备份 PostgreSQL;训练领域、题库、作答记录和应用配置都保存在数据库中,不应依赖容器本身保存。
  138. ### 1. 备份数据库
  139. 在 `deploy/core-only` 目录执行:
  140. ```bash
  141. mkdir -p ../../backup
  142. docker compose exec -T postgres \
  143. sh -c 'pg_dump -U "$POSTGRES_USER" -d "$POSTGRES_DB" -Fc' \
  144. > ../../backup/mindtrain.dump
  145. ```
  146. 同时把 `.env` 备份到密码管理器或其他受控位置,不要提交到 Git。
  147. ### 2. 升级服务端
  148. 使用仓库源码部署时:
  149. ```bash
  150. cd MindTrain
  151. git pull --ff-only
  152. cd deploy/core-only
  153. docker compose up -d --build
  154. docker compose ps
  155. ```
  156. 如果自己的 Compose 使用 `ghcr.io/shigella520/mindtrain-*:latest` 镜像,则执行:
  157. ```bash
  158. docker compose pull
  159. docker compose up -d --remove-orphans
  160. docker compose ps
  161. ```
  162. `latest` 指向最新正式 Release;`1.0.0` 等精确标签内容不可变,生产部署建议优先固定精确版本。`dev` 用于测试任意功能分支,不建议长期作为正式实例的固定升级通道。Training Core 启动时会由 Flyway 自动迁移数据库;如果迁移失败,应保留日志并恢复旧版本,不要手工修改 Flyway 历史表。
  163. ### 3. 升级 Codex Plugin
  164. ```bash
  165. codex plugin marketplace upgrade mindtrain
  166. codex plugin add mindtrain@mindtrain
  167. ```
  168. 更新后新建一个 Codex 任务,使新版 Skill 和 MCP bridge 重新加载。现有实例地址和 Token 保存在 Plugin 之外,不会因升级而丢失。
  169. MindTrain 会在任务开始及远程工具调用时自动校验 Plugin、Trainer MCP 和接口契约版本。版本不同但兼容时会提醒同步升级;不兼容时会停止训练并明确指出需要升级 Plugin、服务端或两者。看到版本提示后不要绕过校验,升级 Plugin 后务必新建 Codex 任务。
  170. 升级完成后确认 Core、MCP 和 Web 均为 `healthy`,再开始训练。备份恢复、版本回退和故障排查见[部署与运维](doc/部署与运维.md),Plugin 细节见[Codex Plugin 部署](doc/CodexPlugin部署.md)。
  171. ## 常用操作
  172. ```bash
  173. # 查看状态和日志
  174. cd deploy/core-only
  175. docker compose ps
  176. docker compose logs -f trainer-core trainer-mcp web
  177. # 停止服务但保留数据
  178. docker compose down
  179. ```
  180. 训练题量、新题额度、积压阈值、临时题有效期和报表时区可在 Web 的“管理 → 训练配置”中修改,不需要重启服务。
  181. ## 文档导航
  182. | 想做什么 | 阅读 |
  183. | --- | --- |
  184. | 部署到服务器、配置反向代理、备份或升级 | [部署与运维](doc/部署与运维.md) |
  185. | 安装、切换分支、更新或排查 Codex Plugin | [Codex Plugin 部署](doc/CodexPlugin部署.md) |
  186. | 本地开发、运行测试、构建镜像或了解 CI | [开发指南](doc/开发指南.md) |
  187. | 维护版本号或发布正式 Release | [版本与发布规范](doc/版本与发布规范.md) |
  188. | 了解 Dashboard、Web 训练和视觉设计 | [Web 设计](doc/Web设计.md) |
  189. | 创建、查询领域与知识点树 | [知识目录](doc/知识目录.md) |
  190. | 查看 REST API | [Training Core OpenAPI](contracts/openapi/trainer-core.yaml) |
  191. | 查看产品方向、架构与仓库边界 | [产品路线图](doc/产品路线图.md) · [目标需求](doc/目标需求.md) · [概要设计](doc/概要设计.md) · [仓库目录规划](doc/仓库目录规划.md) |
  192. | 查看 Skill 工作流 | [MindTrain Plugin Skill](plugins/mindtrain/skills/mindtrain/SKILL.md) |
  193. ## 路线图
  194. MindTrain 1.0 已完成私有部署、领域初始化、对话式训练、加权调度和动态学习看板。后续按依赖关系推进:
  195. 1. 完善题库治理、复习明细、近期会话和训练趋势。
  196. 2. 增加备份恢复,以及训练内容与个人学习记录的独立导入导出。
  197. 3. 扩展来源治理、内容质量评测和可验证的新题型。
  198. 4. 在 Core 调度契约稳定后接入 FSRS Provider 与可选 Anki Bridge。
  199. 5. 最后扩展多用户、权限和共享领域治理。
  200. 详细阶段目标、完成标准和非目标见[产品路线图](doc/产品路线图.md)。
  201. 欢迎通过 Issue 提交使用反馈、题目质量问题和新的知识领域建议。
  202. ## 许可证
  203. MindTrain 使用 [MIT License](LICENSE) 开源,可自由使用、修改、分发和商用,但需保留原始版权声明和许可证文本。
  204. ## 友情链接
  205. <p align="center">
  206. <a href="https://linux.do" target="_blank">
  207. <img src="https://img.shields.io/badge/LINUX-DO-FFB003?style=for-the-badge&logo=linux&logoColor=white" alt="LINUX DO" />
  208. </a>
  209. </p>

Ratings and comments

Sign in to rate this skill.

Sign in

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