---

兼容性

方面	状态
Harness	DeepSeek Harness，dsh CLI
Node	>=20
文库	会话工作区下的 OKF/ Markdown（Paper / Claim / Topic / Method / Entity / Dataset / Gene / Pathway）
模型	不单独配模型。编译与视觉识读走 Harness 默认多模态模型

你能得到什么

• 文档收录 — PDF（anydoc 文本层 + pdfjs 兜底；扫描件/插图走视觉识读）、docx / pptx / xlsx / epub 等转 Markdown。
• 可引用的概念图 — Claim 是引用原子，Paper 是带链接的摘要，枢纽节点交叉链接。
• 检索与覆盖 — 全文检索（可选向量融合）、证据、反向引用、主题 × 年份热力图。
• 综述 — 起草 → okf_cite_check 校验 id → 保存；BibTeX / Pandoc / LaTeX 导出。
• Web UI — 会话视图 OKF 文库 标签：说明 / 文献（可拖文件）/ 图谱 / 校对 / 覆盖 / 综述 / 笔记。

来源文件 → 提取 / 视觉识读 → 分段编译 → 枢纽对齐
                ↓
         OKF/ Markdown 文库 → 检索 / 图谱 / 覆盖 / 综述

快速上手

# 1. 装进 web profile（npm；预构建，一般不用 allowBuilds）
dsh plugin --profile web add dsh-okf

其他安装通道见下方。然后：

1. 启动 dsh web，打开一个会话（工作区目录就是文库所在处）。
2. 切到会话顶部的 OKF 文库 → 文献，把 PDF 拖进去（或点「选择文件」）。
3. 编译完成后，把下面这句贴进对话：

这个工作区的 OKF 文库里有什么？按类型、年份和最常见的主题做一个概况，不要展开任何一篇论文。

没有 UI 时，也可以直接说：「把 ./paper.pdf 编进 OKF」，再贴上面那句。

安装与卸载

• npm（推荐）：dsh plugin --profile web add dsh-okf
• git：dsh plugin --profile web add github:1-CellBio/dsh-okf
• Release tarball：dsh plugin --profile web add https://github.com/1-CellBio/dsh-okf/releases/latest/download/dsh-okf.tgz
• 本地开发：pnpm install && dsh plugin --profile web add ./dsh-okf
• 卸载：dsh plugin --profile web remove dsh-okf

pnpm ≥10 从 git 安装时会拦截 prepare 构建。把 dsh 打印的片段写入该 profile 的 pnpm-workspace.yaml：

allowBuilds:
  dsh-okf: true

然后重新 add。从 npm / Release tarball 安装是预构建包，通常不需要这一步。

--profile <name> 是必填的（常用 web）。修改 dsh.client 后需重启 dsh web。

配置

文库存放在会话工作区的 OKF/ 下。浏览器不读目录。首次也可在对话里发送「初始化OKF」。

路径	用途
OKF/papers/、topics/、methods/、entities/、datasets/、genes/、pathways/、claims/、notes/、questions/、surveys/、extracts/	概念 Markdown
OKF/sources/pdfs/、OKF/sources/docs/	原始文件（打包时不含 PDF）
OKF/manuscripts/	导出稿
OKF/.okf/	可重建的索引

可选环境变量：OKF_DIR、OKF_PDF_DIR、OKF_EXPORT_DIR。按 id 覆盖 profile patch 会整段替换 config，需要的字段请全部重写：

- id: okf
  config:
    okfDir: ${cwd}/OKF
    pdfDir: ${okfDir}/sources/pdfs
    exportDir: ${okfDir}/manuscripts

语义检索可选：配置 KG_EMBED_MODEL / KG_EMBED_BASE_URL / KG_EMBED_API_KEY，运行 okf_sync_vectors。

工具

工具	用途
okf_help	使用说明 + 可复制示例提问
okf_ingest / okf_compile	收录与编译（后台任务）
okf_search / okf_get / okf_evidence	检索、读一页、主张证据
okf_stats / okf_coverage / okf_check	概况、覆盖度、健康检查
okf_graph / okf_neighbors / okf_backlinks / okf_compare	图谱与有界对比
okf_cite_check / okf_save_survey / okf_save_note	综述与笔记
okf_bib / okf_export / okf_pack / okf_merge	导出与迁移

只引用工具返回的 papers/、claims/ id。不要编造 DOI。不要对上千篇无范围 okf_compare。

开发

pnpm install
pnpm run build

改完客户端后重启 dsh web 并硬刷新。

License

MIT © 2026 1-CellBio