快速开始
本页介绍如何安装 Knowlery、初始化 vault,以及初始化后会发生什么。
使用要求
Knowlery 面向 Obsidian desktop,并需要启用 community plugins。
如果你想让 agent 真正基于 vault 工作,还需要 Claude Code 或 OpenCode。可选工具准备和外部 skill browser 需要 Node.js 与 npm。
桌面行为
Knowlery 会使用本地命令行工具和 Electron desktop API 来支持 agent 相关功能。当前插件 manifest 标记为 desktop-only。
使用 BRAT 安装
BRAT 是 Obsidian 的 Beta Reviewers Auto-update Tool。Knowlery 尚未从 community plugin directory 安装时,可以用 BRAT 安装 beta 版本。
- 在 Obsidian 中安装 BRAT。
- 打开 BRAT 设置。
- 添加这个 beta plugin repository:
https://github.com/JayJiangCT/knowlery。 - 在 Settings -> Community plugins 中启用 Knowlery。
手动安装
- 从最新 GitHub release 下载
main.js、manifest.json和styles.css。 - 在你的 vault 中创建
.obsidian/plugins/knowlery/。 - 将这三个文件放入该目录。
- 重新加载 Obsidian。
- 在 Settings -> Community plugins 中启用 Knowlery。
第一次运行
启用插件后,可以从 ribbon 图标或 command palette 打开 Knowlery。
如果 vault 尚未初始化,Knowlery 会在 dashboard 和 settings tab 中显示 setup 入口。
Setup wizard 会要求你选择一个平台:
| 平台 | 生成的配置 |
|---|---|
| Claude Code | .claude/CLAUDE.md 和 .claude/rules/ |
| OpenCode | opencode.json 和 .agents/rules/ |
如果你是从旧版本升级,v0.3.5 会在插件第一次加载时自动同步 bundled skills,并就地迁移 SCHEMA.md。custom 和 forked skills 不会被覆盖。
如果 Knowlery 检测到旧的 BYOAO vault,setup wizard 会切换到 migration mode,并保留原有 BYOAO/OpenCode 文件,同时改为 Knowlery 的 Claude Code 配置。
Setup 会创建什么
Knowlery 会在 vault 中创建知识工作区和 agent 配置:
| 路径 | 用途 |
|---|---|
KNOWLEDGE.md | 给人和 agent 看的 vault 操作指南 |
SCHEMA.md | 知识分类与页面约定 |
INDEX.base | 编译知识页面的 Obsidian Bases 索引 |
entities/ | 人、工具、组织、项目等命名对象 |
concepts/ | 想法、框架、理论、心智模型 |
comparisons/ | 并排比较分析 |
queries/ | 保存的问题和研究线索 |
.knowlery/manifest.json | Knowlery setup 元数据 |
.agents/skills/ | skills 的 canonical 存放位置 |
.agents/rules/ | OpenCode rules 和共享 agent rules |
.claude/skills/ | 为 Claude Code 镜像的内置 skills |
.claude/CLAUDE.md | Claude Code vault instructions |
.claude/rules/ | Claude Code rules |
opencode.json | OpenCode 配置 |
skills-lock.json | skill 来源、版本、禁用状态 |
可选工具准备
Setup wizard 可以检测 Claude Code、OpenCode、Node.js、Claudian 和 skills tooling。
缺失的可选工具会显示为可选择的安装或准备步骤。已安装工具会显示为只读状态行。这些动作都是 opt-in,并且会以你的本机用户权限运行。
打开 Dashboard
Setup 完成后,打开 Knowlery dashboard。它有五个主要 tab:
| Tab | 用途 |
|---|---|
| Today | 从当前活动上下文开始,选择一个小的下一步 |
| This note | review 当前 Markdown 笔记并准备专注的 prompt |
| Weekly Review | 生成 Knowledge Atlas,并在需要时发送 polish request |
| Review Menu | 浏览 source skills、建议的下一步和可复用的 review recipes |
| System | 运行 health checks,并打开底层配置文件 |
推荐的第一次使用方式
- 先在一个干净 test vault 中初始化。
- 阅读生成的
KNOWLEDGE.md和SCHEMA.md。 - 打开 Today、This note 和 Review Menu,理解 Knowlery 的 review 方式。
- 往 vault 中加入一两篇真实笔记。
- 生成一次 Weekly Atlas,然后打开 System 运行诊断。