Skip to content

使用指南 ​

这些指南覆盖 Knowlery 的日常工作流。

初始化 Vault ​

  1. 打开 command palette。
  2. 运行 Knowlery: Initialize vault。
  3. 选择 Claude Code 或 OpenCode。
  4. Review Knowlery 将创建的文件、skills 和配置。
  5. 可选地选择缺失工具的准备步骤。
  6. 运行 setup。
  7. Setup 完成后打开 dashboard。

如果你还在评估 Knowlery,建议先使用 test vault。Setup 会写入多个顶层文件和文件夹。

阅读 Dashboard ​

Knowlery 现在围绕一个行动优先的 dashboard 组织:

区块作用
Today's move从当前活动状态开始,选择一个小的下一步
Suggested moves复制或发送 Process new material、Connect related notes、Challenge an idea、Fix note metadata、Draft an output 等可复用 prompts
Knowledge health查看过期页面与从未编译的笔记;复制 re-cook prompt
This notereview 当前 Markdown 笔记并寻找关联上下文
Recent activity查看最近的私有 activity receipts
This week生成 weekly summary,或发送 polish request
Bundles分享一个 review 过的 knowledge bundle,或安装别人分享的 bundle

最近活动或 vault 变化后,可以点刷新按钮。较长的 moves 和 activity 列表可以通过 View all 打开。

使用 Today's Move ​

Today's move 是最直接的“现在发生了什么”视图。

  1. 打开 dashboard。
  2. 阅读当前 summary 和高亮的下一步。
  3. 需要 agent prompt 时,使用复制或发送动作。
  4. 想记录自己对工作的简短想法时,使用 Add reflection。

如果已有 activity receipts,Knowlery 会显示活跃 thread 和建议的下一步;如果没有,它会把你引向第一个 cook 或一个小的 setup 步骤。

Review 一篇笔记 ​

打开一篇 Markdown 笔记,然后查看 dashboard 中的 This note 区块。

Knowlery 会尝试识别当前笔记,把它和最近的知识活动关联起来,并准备一个聚焦的 prompt。适合把单篇笔记连接到旧材料、comparison 或可复用结构。

生成 Weekly Summary ​

在需要更宏观的总结时,使用 This week 区块。

  1. 使用 Generate summary 在 .knowlery/reports/latest.html 生成本地 HTML 报告。
  2. 使用 Open last report 在 Obsidian 外打开这个文件。
  3. 使用 Send for review 让 companion agent 写一版更精炼的 review summary。
  4. 使用 Check result 刷新 request/result 状态。

报告还会保存一个带日期的 snapshot 到 .knowlery/reports/weekly/。

使用 Suggested Moves ​

Suggested moves 让你从产品语言动作开始,而不是从原始 skill 名称开始。

Move catalog 包括:

Move用途
Process new material将粗糙笔记、摘录或对话整理成持久知识页面
Connect related notes寻找旧笔记、相邻主题和可复用模式
Challenge an idea检查假设、缺失证据、反例和风险
Fix note metadataReview drift、重复、frontmatter gaps、broken links 和 index hygiene
Draft an output把成熟主题转成 checklist、outline、template、proposal 或 decision memo

打开某个 move 后,可以复制 prompt 或发送给配置好的 agent chat。打开 Settings -> Knowlery -> Skills 后,可以查看、创建、fork、编辑、禁用或删除底层 skills。

推荐 Skill 使用流 ​

目标Skill
处理原始笔记cook
询问 vault 已经知道什么ask
寻找主题之间的桥梁explore
审查假设challenge
生成综合想法ideas
检查结构问题audit
清理组织结构organize

分享 Knowledge Bundle ​

当你想把一部分 review 过的知识分享给别人时,使用 Share knowledge bundle(command palette 或 dashboard 的 Bundles 区块)。

  1. 选择一个 seed 主题。Knowlery 会收集与它相连的知识页面和被引用的原始笔记(graph-closure)。
  2. 逐条 review 范围内的每一项。每个页面和原始笔记都处于 unreviewed / approved / flagged 三种状态之一——没有被 approve 的内容不会被导出。
  3. 查看自动 risk scan。它会在导出前高亮 emails、敏感 URLs、person pages 和会议类笔记。
  4. 确认 bundle 元数据(id、title、version、creator、license)和选项。
  5. 导出。Bundle 会写入 .knowlery/exports/,并可以保存为 .zip 用于分享。

导出的 bundle 包含 approve 过的页面、用于导航的 index.md 和 agent-index.json、_sources/ 下 approve 过的原始笔记、update log,以及给接收者的 README。如果开启了 "Include SCHEMA.md",随包的 schema 只包含导出页面实际用到的 tags 和 domains——绝不会是整个 vault 的 taxonomy。

每个主题都有自己独立保存的 review scope,处理一个 bundle 不会影响另一个。

安装 Knowledge Bundle ​

使用 Install knowledge bundle(command palette 或 dashboard 卡片)安装别人分享给你的 bundle。

  1. 选择 bundle 的 .zip 或文件夹。
  2. 在写入任何内容之前,先 review manifest 和 conformance 预览。
  3. 安装。Bundle 会落到 Library/<bundle-id>/,并登记到 .knowlery/bundles.json。

已安装的 bundles 会显示在 dashboard 上,也可以从那里卸载。安装会在 KNOWLEDGE.md 中加入检索指引,/ask skill 在回答问题时会显式检查已安装的 bundles。更新要求更高的 bundle 版本号;带 conformance 错误的 bundle 需要显式确认才能安装。

想把某个 bundle 页面变成自己的知识时,在 bundle concept 页面的 file menu 中使用 Fork to my knowledge——它会把页面复制到你自己的知识目录中。

添加或编辑 Rules ​

Rules 用来指导 agent 在这个 vault 中如何行动。

  1. 打开 Settings -> Knowlery。
  2. 使用 Add rule 创建新 rule。
  3. 给 rule 一个聚焦的 filename 和 title。
  4. 用普通 markdown 编写指令。
  5. 保存并确认它出现在 rules list 中。

好的 rule 应该短而可执行。相比一篇泛泛的写作风格说明,Always cite source notes using wikilinks 这样的指令更有效。

切换平台 ​

可以在 settings tab 中切换 Claude Code 和 OpenCode。

Knowlery 会:

  • 创建目标 rules directory。
  • 将旧平台目录中的 markdown rules 复制到新目录。
  • 重新生成平台配置文件。
  • 可选地清理旧平台配置。

切换平台后建议 review 生成的 config,尤其是你有 custom rules 的时候。

运行健康诊断 ​

打开 Settings -> Knowlery,在 Diagnostics 区块点击 Run diagnosis。

Knowlery 会检查:

  • 没有 incoming wikilinks 的孤立笔记。
  • 无法解析到现有文件的损坏 wikilinks。
  • entities/、concepts/、comparisons/、queries/ 中缺失的 frontmatter。

Health output 是建议性质。对真实 vault 做结构调整前,请先 review 诊断结果。

检查 Knowledge Health ​

Dashboard 的 Knowledge health 区块由 staleness report 驱动:已编译页面的引用来源在页面写成之后又发生了变化,以及从未被编译进任何页面的用户笔记。

  1. 打开 dashboard,查看 Knowledge health 区块。
  2. 使用 Copy re-cook prompt 把过期页面清单作为 /cook 请求交给 agent。
  3. 使用 View all 查看完整明细:过期页面、从未编译的笔记和悬空来源。

同一份报告在 Obsidian 之外也能获取:knowlery stale、obsidian knowlery:stale,或 MCP 的 stale 工具。

两个可选的细化手段,让大 vault 上的"从未编译"列表保持有用:

  • 参考目录与忽略目录(Settings → Advanced → Rules & schema,或 knowlery reference / knowlery ignore)。你只读不编译的导入知识保持可检索,但不再列为未编译;根本不是知识的文件夹不会被扫描。node_modules/ 和项目清单旁边的构建产物会自动跳过,Diagnostics → Indexing 会列出每个被跳过的目录及原因。
  • Jev 排序(Settings → Jev cook 分诊,需要 TypeSafe AI 密钥)。钻取页里的 Rank N with Jev 会给每条未编译笔记打一个"含有持久知识的可能性"分数,并建议它应更新哪个编译页面;排序保存在 .knowlery/triage.json,所以 knowlery stale 以及在 Codex、Claude Code、Cursor 里 cook 的 agent 读到的是同一个顺序。它是阅读顺序,不是过滤器:低置信的笔记沉到底部,但仍然列出。

记录 Reflection ​

在 command palette 或 dashboard 中使用 Add reflection,可以把一次 agent 会话或人工 review 的简短总结写进 Activity Ledger。

它会进入 Activity Ledger,而不是普通 vault note。

重新生成 Agent Config ​

如果 agent instructions 漂移,或者 config file 被误改,可以在 settings tab 中重新生成平台配置。

这在修改 knowledge base name、切换平台、修复部分初始化失败的 vault 时很有用。

安全地和 Agents 一起工作 ​

让 agent 在 Knowlery vault 中工作时,建议:

  • 要求 agent 先阅读 KNOWLEDGE.md。
  • 将 source notes 与 compiled knowledge pages 分开。
  • 要求回答时使用 [[wikilinks]] 引用来源。
  • 在依赖生成内容前 review 知识页面。
  • 在大规模导入、迁移或 agent-generated changes 后运行 Health。

Released under the MIT License.