Skip to content
Back to search

research-workbench-assistant

Local-first research memory for Codex: checkpoints, progress ledgers, and Markdown/JSON paper notes. Early alpha.

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/z-liu-xiugou--research-workbench-assistant/badge.svg)](/listings/z-liu-xiugou--research-workbench-assistant)

HTML

<a href="/listings/z-liu-xiugou--research-workbench-assistant"><img src="/api/listings/z-liu-xiugou--research-workbench-assistant/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 · 181 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. # Research Workbench Assistant|科研工作台助手
  2. [English](README_EN.md) · [安装与使用](docs/GETTING_STARTED.md) · [反馈问题](https://github.com/z-liu-xiugou/research-workbench-assistant/issues) · [参与讨论](https://github.com/z-liu-xiugou/research-workbench-assistant/discussions)
  3. [![tests](https://github.com/z-liu-xiugou/research-workbench-assistant/actions/workflows/tests.yml/badge.svg)](https://github.com/z-liu-xiugou/research-workbench-assistant/actions/workflows/tests.yml)
  4. **让 AI 对话结束后,科研进度仍然留在你自己的项目里。**
  5. 面向研究生的本地科研记录助手,以 Codex Skill 形式使用:记录目标、进展、问题和下一步,在新对话中按需续接;文献笔记保存为 Markdown 和 JSON。
  6. > **当前预览版:v0.1.0-alpha.9。** 已提供可安装 Skill、科研记录、Crossref 在线文献发现、离线总览和可选本地文献图库,适合个人试用。尚不是全自动科研平台,也不保证 AI 内容准确。
  7. 安装包、升级注意事项和对应提交的验证记录见 [alpha.9 Release](https://github.com/z-liu-xiugou/research-workbench-assistant/releases/tag/v0.1.0-alpha.9)。本页对应 alpha.9;alpha.2–alpha.8 是开发里程碑,累计变化见 [发布说明](docs/releases/v0.1.0-alpha.9.md)。完整独立真人 Codex 验收仍在 [#9](https://github.com/z-liu-xiugou/research-workbench-assistant/issues/9) 跟踪。
  8. 新增“先搜摘要,再按需读全文”:本地检索默认最多 10 条短摘要,可按记录类型/状态筛选和翻页,再用 show 读取选定记录,避免长笔记一次占满对话。旧版 search 的输出格式有所变化,[参数与升级说明](skills/research-workbench/references/records.md)。
  9. 本次补齐 v0.1 的证据约束与验收:进行中/已确认记录需要可定位证据,已确认还须记录用户明确确认的出处;增加决策与问题汇总和可测试的轻量续接路由。旧事件不改写,升级审计会提示需人工复核。[升级规则与格式](skills/research-workbench/references/records.md) · [验收证据](docs/ISSUE_ACCEPTANCE.md)
  10. ## 五分钟开始
  11. 需要:可用的本地 Codex、Python 3.10+、Git。基础工作台无第三方 Python 依赖,无需另填 API Key;可选 PDF 图库另装组件。Codex 本身仍需可用账户,可能产生使用费用。
  12. 在 PowerShell 或终端执行:
  13. ```powershell
  14. git clone --branch v0.1.0-alpha.9 --depth 1 https://github.com/z-liu-xiugou/research-workbench-assistant.git
  15. cd research-workbench-assistant
  16. python -X utf8 scripts/install.py
  17. ```
  18. 也可从上面的 Release 下载 `research-workbench-assistant-v0.1.0-alpha.9.zip`,解压后在包含 `scripts` 的目录运行安装命令;ZIP 安装不需要 Git。发布页附有 SHA-256 校验文件。使用主分支的开发版本时,请单独核对提交和版本。
  19. 安装器只复制 research-workbench Skill 到用户 `.agents/skills`,不会覆盖已有同名技能,不触碰其他助手。未识别时重启 Codex。也可让 `$skill-installer` 从本仓库 `skills/research-workbench` 安装,两种方式选一种。[Codex 官方技能说明](https://learn.chatgpt.com/docs/build-skills)
  20. 在 Codex 打开**你自己的科研项目**,输入:
  21. ```text
  22. $research-workbench 请为这个项目初始化科研工作台。先了解我的研究目标,不要编造进展,也不要覆盖已有记录。
  23. ```
  24. 完成一项工作后:
  25. ```text
  26. $research-workbench 请保存这次实质进展、证据位置和下一步,并更新续接断点。还没确认的方案不要写成已确认。
  27. ```
  28. 新建对话时:
  29. ```text
  30. $research-workbench 继续上次研究。先读当前断点,只加载这次任务需要的资料。
  31. ```
  32. ## 现在能做什么
  33. | 能力 | 当前范围 |
  34. | --- | --- |
  35. | 初始化工作台 | 独立目录,拒绝覆盖现有目录 |
  36. | 跨对话续接 | 保存本地断点,由 Codex 在新任务中读取;不是云端聊天记忆 |
  37. | 进展和分类台账 | 进展、任务、决策、问题、实验、材料、断点、文献记录 |
  38. | 修订留痕 | 追加新记录并标记替代关系,旧版本保留 |
  39. | 任务执行跟踪 | 待办、执行中、完成、取消;筛出未关闭任务,保留修订历史 |
  40. | 文献笔记库 | 将 Codex/用户提供的笔记生成 Markdown + JSON;区分摘要与全文 |
  41. | 本地检索 | 当前有效记录的关键词搜索,可限定文献类型 |
  42. | 在线文献发现 | Crossref 主题/年份查询,DOI 去重,来源与检索批次留痕 |
  43. | 候选文献队列 | 待筛选、保留、排除;已有笔记自动关联,不等于人工已读 |
  44. | 检查与恢复 | 校验结构、发现视图不一致、从历史记录重建 |
  45. | 只读诊断 | 检查技能文件、版本、目录权限、锁和工作台配置,默认隐藏个人路径 |
  46. | 项目偏好与入门引导 | 可跳过问题,将范围、语言、详略和资料位置保存在本项目约定中 |
  47. | 离线研究总览 | 按需生成 HTML 快照,集中查看断点、任务、候选和已有笔记,支持本地筛选和来源导航 |
  48. | 可选文献图库 | 指定本地 PDF 的完整图候选、裁切修正、跨页拼接、来源追溯和离线图片检索;需另装组件和复核 |
  49. **还不能做:** 全文下载、OCR、自动全文理解、内置 Google Scholar/知网/PubMed 等多来源检索、Zotero 同步、后台定时跟踪、自动推断/交互式文献图谱、多人实时协作。Crossref 查询并不覆盖全部论文,候选与实际阅读笔记严格分开。
  50. ## 从本地论文建立图片检索页
  51. 可选图库提供 `figures extract / build / verify`:提取完整图候选,按文献保存 PNG、缩略图、裁切 PDF 和页码/来源校验值,再生成可双击离线打开的页面。支持中文搜索、组合筛选、放大和来源入口。中文图意及用途由人工或 Codex 阅读后填写,新图先保留待复核。
  52. 输入示例、安装与命令见[文献图库说明](docs/FIGURES.md)。页面只负责浏览检索,裁切与说明通过清单维护;图库和论文需另行完整备份,现有工作台 backup 不包含它们。公开源码仅带虚构示例,不附带真实论文或图片。
  53. ## 安装或工作台出问题时
  54. 在仓库根目录运行:
  55. ```powershell
  56. python -B -X utf8 skills/research-workbench/scripts/workbench.py doctor
  57. python -B -X utf8 skills/research-workbench/scripts/workbench.py doctor --root demo-workbench
  58. ```
  59. 第一条检查正在运行的技能副本,第二条还检查指定工作台的配置与必要目录。要检查已安装版本,请使用它实际的 `workbench.py` 路径。命令只报告问题和建议,不写入工作台或删除锁;默认输出不包含个人绝对路径或研究正文。权限检查只观察系统返回的权限信息,不能保证下一次写入一定成功。状态码和用法见 [只读诊断说明](docs/DIAGNOSTICS.md)。
  60. ## 按你的项目习惯使用
  61. 在 Codex 中说:
  62. ```text
  63. $research-workbench 帮我设置这个项目的使用偏好,先问当前目标、输出语言和详略,其余暂时跳过。
  64. ```
  65. 设置写在项目内的 `PROJECT_MANUAL.md`,随工作台备份恢复,不需要修改安装的 Skill。未决定的选题或设置保留“待定”;临时要求不自动成为永久偏好。已有项目先读取约定,只补缺项;改变研究范围先展示变化并由用户确认。第一版由 Codex 阅读和应用文本约定,不增加配置解析命令或修改 config v1。[入门引导与两类虚构示例](docs/ONBOARDING.md)。
  66. ## 查看离线研究总览
  67. ```powershell
  68. python -X utf8 skills/research-workbench/scripts/workbench.py overview --root demo-workbench
  69. ```
  70. 然后双击工作台内的 `OVERVIEW.html`。页面显示断点、任务分组、候选文献和已有笔记,可搜索筛选,每项保留原始记录入口。无需启动服务,页面没有外部资源请求;它是一份快照,追加记录后再次运行命令才会更新。也可在 Codex 中说“更新项目总览”或“显示今天的研究进度”。[使用说明与数据解释](docs/OVERVIEW.md)。页面包含本地研究信息,分享前仍需核对内容。
  71. ## 在线找论文并保存候选
  72. 在已经初始化的工作台上运行:
  73. ```powershell
  74. python -X utf8 skills/research-workbench/scripts/workbench.py discover --root demo-workbench --query "renewable energy forecasting" --year-start 2023 --year-end 2025 --limit 10
  75. python -X utf8 skills/research-workbench/scripts/workbench.py candidates --root demo-workbench
  76. ```
  77. 也可直接在 Codex 中输入:
  78. ```text
  79. $research-workbench 用 Crossref 检索 renewable energy forecasting,限定 2023–2025 年,取前 10 条,去重后保存候选,不要标记为已读。
  80. ```
  81. 打开 CANDIDATES.md/JSON 查看结果。保留/排除候选要写理由;实际阅读并生成同 DOI 笔记后,候选自动关联到笔记。详见 [完整检索—筛选—笔记衔接流程](skills/research-workbench/references/discovery.md)。
  82. 查询使用 Crossref 公开元数据接口,无需 API Key;一次只取相关性排序前 1–50 条,不代表穷尽检索。检索词会发送给 Crossref,不能含未公开研究细节。[官方接口说明](https://www.crossref.org/documentation/retrieve-metadata/rest-api/)
  83. ## 不用 Codex 也能验证记录流程
  84. 在仓库根目录运行,demo-workbench 必须尚不存在:
  85. ```powershell
  86. python -X utf8 skills/research-workbench/scripts/workbench.py init --root demo-workbench --name "示例科研项目"
  87. python -X utf8 skills/research-workbench/scripts/workbench.py record --root demo-workbench --input examples/checkpoint.json
  88. python -X utf8 skills/research-workbench/scripts/workbench.py record --root demo-workbench --input examples/paper.json
  89. python -X utf8 skills/research-workbench/scripts/workbench.py resume --root demo-workbench
  90. python -X utf8 skills/research-workbench/scripts/workbench.py audit --root demo-workbench
  91. ```
  92. 打开 demo-workbench/ACTIVE_CONTEXT.md 和 demo-workbench/notes/ 查看结果。示例全部虚构,不可作为真实文献引用。详见 [使用指南](docs/GETTING_STARTED.md)。
  93. ## 数据与安全
  94. 新增任务示例为 examples/task.json。入库后可运行:
  95. ```powershell
  96. python -X utf8 skills/research-workbench/scripts/workbench.py tasks --root demo-workbench
  97. ```
  98. 默认返回未关闭任务;`--state done` 查看已完成。完成需提供证据,不能将“任务做完”混同于“研究结论已确认”。续接断点只展示短摘要与原始事件链接,完整任务见 TASKS.md。旧工作台升级先备份,再用新版 render 重建视图。
  99. - 只有 discover 向 Crossref 发送明确查询参数,不上传工作台或论文;其他记录命令不联网。使用 Codex 模型或外部工具也不等于完全离线,请遵守课题数据要求。
  100. - 工作台默认忽略 Git 提交,但 .gitignore 不是隐私保证。已跟踪文件、强制添加、同步盘需要另外检查。
  101. - 证据字段保留来源,不自动证明结论;生成笔记不等于你已读过原文。
  102. - 自动生成页面请勿手改;自由笔记放 PERSONAL_NOTES.md。重要资料仍需自行备份。
  103. ## 参与与维护
  104. 欢迎先试用“初始化 → 记录 → 新对话续接”,反馈最容易丢失的研究上下文。报告问题请附系统、Python 版本、命令和脱敏错误,不上传真实论文或密钥。
  105. ```powershell
  106. python -X utf8 -m unittest discover -s tests -v
  107. ```
  108. [贡献说明](CONTRIBUTING.md) · [安全报告](SECURITY.md) · [变更记录](CHANGELOG.md) · [推广文案](docs/LAUNCH_POST.md) · [历史规划](docs/OPEN_SOURCE_ROADMAP.md)
  109. 维护者可以用 [分发包验证工具](docs/DISTRIBUTION_VALIDATION.md) 检查指定提交的 ZIP 是否可在独立临时目录安装并完成基础流程。GitHub Actions 在现有四组环境中持续运行该检查;Actions 依赖另由 [Dependabot](docs/DEPENDENCY_UPDATES.md) 每周提出更新 PR,由维护者审查。
  110. 历史架构、迁移审计和路线图描述长期目标;当前能力以本 README、实际代码和测试为准。
  111. Apache-2.0 开源。非 OpenAI 官方项目;开源或获得 Star 不保证获得任何赞助计划资格。
  112. 文献库现支持作者、年份、DOI、期刊/会议和标签;同 DOI 重复入库会被拒绝,修订保留历史。PAPER_INDEX.md 提供当前文献目录。DOI 仅检查格式,不联网验证;无 DOI 不自动去重。
  113. ## 备份与恢复
  114. 新增 backup/restore:备份配置、原始事件、PERSONAL_NOTES.md 和 PROJECT_MANUAL.md;恢复前校验完整性与结构,只写入新目录,不覆盖已有项目。命令见[记录格式](skills/research-workbench/references/records.md#本地备份与安全恢复)。备份未加密,不包含论文、实验数据或其他自建文件,请另行保存这些材料。
  115. ## 文献与任务关联
  116. 现支持 links 显式关联,以及 related 双向查询、RELATIONS.md/JSON 关系清单。每条关联记录理由;引用旧版本会提示核对,不自动改为新版。适合追踪“任务引用了哪些文献”“材料被哪些当前记录引用”。这不是自动推断或交互式图谱,关联也不等于结论已验证。详见[使用指南](docs/GETTING_STARTED.md#5-关联文献任务和实验)。

Ratings and comments

Sign in to rate this skill.

Sign in

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