Skip to content

README.md

Latest commit

 

History

History
74 lines (53 loc) · 5.86 KB

README.md

File metadata and controls

74 lines (53 loc) · 5.86 KB
Raw

kb-starter：LLM Agent + Obsidian + Zotero 的个人知识库模板

面向的问题：电脑里散落着多年积累的文献 PDF、几个废弃的笔记仓库、下载夹里分不清的资料——想要一套管得住它们的系统，而不是又一次失败的大扫除。

方案：三层架构（笔记进 Obsidian、文献进 Zotero、大文件留原地只链接）+ LLM agent 做整理执行者 + 云盘同步 + 本地 git 备份。核心哲学：堆的时候零决策，找的时候零翻找，规则长在系统里。

  • METHOD.md — 方法论全文（六原则 / Agent 安全边界 / Zotero 经验 / 踩坑史）
  • vault/ — Obsidian starter vault（首页仪表盘、CSS、模板、自动化配置）
  • skill/kb-keeper/ — 给 Claude Code 等 LLM agent 的技能包（可选；不用 AI 完全不影响其余部分）
  • docs/zotero.md — Zotero 侧速查
  • AGENTS.md — 给 AI Agent 的机器可执行部署指引（如果你让自己的 agent 直接读取本仓库完成部署，从这里开始）

环境要求：Obsidian ≥ 1.9（首页与数据库用到 Bases/Dataview）；备份步骤需要已安装 git。

两种起点

  • 起点 A：从零开始 → 直接走下面的快速开始。
  • 起点 B：带着一台乱电脑来（最常见） → 先走快速开始把空系统立起来，然后做存量收编：
    • 有 AI agent：让它读 skill/kb-keeper/references/intake.md，按"只读盘点 → 方案确认 → 分批执行 → 验收"四阶段收编你的散乱文件（每批都会先给你清单过目，私人文件只统计不处理，删除只入废纸篓）
    • 不用 AI：按 METHOD.md 的"从混乱到系统"一章手动分批做，原则相同——先笔记、再文献、资料最后，永远复制不搬源，一次别贪多

快速开始

  1. 复制 vault：把 vault/ 复制到你的云盘目录（iCloud/OneDrive/坚果云均可），Obsidian →「打开另一个仓库」选中它。 首次打开会问「是否信任此仓库的作者」——选信任并启用插件（本模板依赖社区插件）。

  2. 先装插件再看首页：装好前首页只会显示一段代码，这是正常的。设置 → 第三方插件 → 社区市场，按下表安装并启用（共 9 个）。仓库已附带 Dataview（含开启 JS 查询）、Templater、Homepage、附件管理的配置；其余插件默认设置即可用。

    插件 用途 开源仓库
    Dataview 首页仪表盘与所有自动视图的地基 blacksmithgu/obsidian-dataview
    Templater 模板引擎（证据卡自动套用、按钮建卡） SilentVoid13/Templater
    Omnisearch 全文搜索 scambier/obsidian-omnisearch
    CM-CHS-Patch 中文分词（配合搜索与双击选词） aidenlx/cm-chs-patch
    Fuzzy Chinese Pinyin 拼音首字母快速打开 lazyloong/obsidian-fuzzy-chinese
    Homepage 启动自动打开首页 mirnovov/obsidian-homepage
    Easy Typing 中英混排自动空格等输入优化 Yaozhuwa/easy-typing-obsidian
    Attachment Management 截图自动改名归位 trganda/obsidian-attachment-management
    Style Settings 主题微调（不装 Border 主题可跳过） mgmeyers/obsidian-style-settings

    Border 主题（可选）：Akifyss/obsidian-border

  3. 填写 CLAUDE.md：替换尖括号占位符——这是 AI（以及未来的你）理解这个库的"宪法"。

  4. 主题（可选）：想要卡片质感装 Border 主题；不装则默认主题，一切照常工作。

  5. 备份（强烈建议）：终端执行（首次用 git 需先配置 user.name/user.email）：

    cd <你的vault路径>
git init --separate-git-dir ~/Documents/kb-backup.git
git add -A && git commit -m "init"

    仓库本体在本地磁盘、不进云盘。云同步不是备份。

  6. 接入 AI（可选）：把 skill/kb-keeper/ 复制到 ~/.claude/skills/，之后对 Claude 说「整理 inbox」「备份」「开一个XX证据卡库」即可。

首页仪表盘

vault/scripts/homepage.js 顶部有 CONFIG 区——改板块路径、按钮、入口 chips 都在那里，无需读懂其余代码。删除示例项目后记得把 CONFIG.evidenceFolder 改为你自己的证据卡库路径（或留空隐藏该卡片）。

这套规程有用吗：evals

evals/ 用可复跑的对照实验回答这个问题：同一模型、同一句任务，agent 带 skill/kb-keeper/ 与不带，行为差多少。

评的不是"答案对不对"（AI 输出没有唯一正解），而是该发生的行为发生了没有——有没有先做 git 快照、批量移动前有没有把清单交用户过目、有没有碰不该碰的私人文件。两个 case 各配一张评分表，逐项打勾。

Case 带技能 对照组
01 整理一个乱 inbox（fixture 内埋 5 个陷阱） 7 / 8 4 / 8
02 从零初始化一个新库 6 / 6 0 / 6
合计 93% 29%

差距集中在程序性纪律而非分类判断：对照组的归位其实也做对了大半，但没有一次快照、批量前不出清单、把重复文件直接删了。跑法与完整评分表见 evals/README.md，结果与局限见 evals/RESULTS.md。

许可

MIT。方法论与配置自由取用；插件与主题请从各自官方渠道安装（本仓库不分发第三方代码）。