项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
技术标签
使用教程
—
环境要求
- Node.js 与 npm(用于全局安装 shardmind)
- Obsidian 1.12+,并在设置 → General 中启用 Obsidian CLI
- 一个 AI 编程智能体 CLI:Claude Code(完整支持)、Codex CLI 或 Gemini CLI
- 安装前需新建并进入一个空文件夹,因为 shardmind install 会写入当前目录
安装与启动步骤
-
1安装 ShardMind
通过 npm 全局安装 ShardMind,它是 Obsidian 知识库模板的包管理器,安装模板时会用到。
npm install -g shardmind -
2新建知识库目录
shardmind install 会把内容写入当前目录,所以必须先创建并进入一个全新的空文件夹。
mkdir my-vault && cd my-vault -
3安装 obsidian-mind
向导会收集你的姓名、组织、知识库用途、要包含的智能体以及是否启用 QMD,随后初始化 git 并个性化 brain/North Star.md。
shardmind install github:breferrari/obsidian-mind -
4用 Obsidian 打开
把刚才安装好的文件夹作为一个 Obsidian vault 打开,即可看到生成的笔记体系。
-
5启用 Obsidian CLI
在 Obsidian 的 Settings → General 中启用 Obsidian CLI,这需要 Obsidian 1.12 及以上版本。
-
6在知识库中运行智能体
在知识库目录下启动智能体,三选一即可,hooks 与命令在三种智能体上通用。
claude -
7开始一次会话
用 /om-standup 做晨间启动,智能体会加载 North Star、活跃项目、开放任务与近期 git 变更。
/om-standup
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
姓名 | 是 | 向导收集的个人姓名,用于个性化 brain/North Star.md | Zhang San |
组织 | 是 | 向导收集的组织名称,写入个性化配置 | Acme Inc |
知识库用途 | 是 | 说明这个 vault 的用途,用于生成初始结构 | 个人工作知识库 |
agents | 是 | 选择要包含的智能体(Claude Code / Codex CLI / Gemini CLI) | claude-code |
QMD | 否 | 是否启用 QMD 模块,不使用可直接跳过 | 跳过 |
shard-values.yaml | 否 | ShardMind 写入的配置文件,删除后知识库仍可正常工作 | shard-values.yaml |
如何确认成功
该文件夹能被 Obsidian 识别为 vault 并看到 brain/North Star.md;在目录中运行 claude 后输入 /om-standup 能返回项目与任务概览。
常见问题
Q:用 ShardMind 安装和 git clone 有区别吗?
A:README 说明两种方式得到的是同一个 vault,所有取值都为默认时安装结果与 git clone 逐字节等价,ShardMind 只是额外提供了向导、可选模块和三方合并升级。
Q:删掉 .shardmind/ 和 shard-values.yaml 后还能用吗?
A:可以。ShardMind 是可叠加的而非必需的,删除这两个内容后已安装的 vault 依然能正常运行。
Q:可以从已有的旧 vault 迁移过来吗?
A:可以。运行 /om-vault-upgrade 指向旧 vault,智能体会检测版本、清点文件、给出迁移计划并在你批准后执行,且旧 vault 永不被修改,可用 --dry-run 预览。
Q:shardmind install 装到了哪里?
A:它会写入当前所在目录,因此务必先创建并进入一个新的空文件夹再执行安装。
Q:支持哪些 AI 编程智能体?
A:Claude Code 为完整支持,Codex CLI 和 Gemini CLI 提供可用的 hooks;三者共用同一套 hooks、命令与 vault。
注意事项
- Obsidian CLI 需要 Obsidian 1.12 及以上版本,低版本无法启用。
- 安装前先 mkdir 并 cd 进入新目录,否则安装内容会混入现有文件夹。
- 迁移旧 vault 时原 vault 不会被修改,建议先用 --dry-run 查看迁移计划。
- QMD 属于可选模块,用不到的模块可以直接跳过。
核心亮点
- 把 Obsidian 笔记库直接变成 AI Agent 的持久记忆层,复用已有 Markdown 工作流
- 同时适配 Claude Code、Codex CLI、Gemini CLI 等多个主流编码智能体
- TypeScript 实现,结构清晰,便于按自身笔记习惯定制自组织规则
不足之处
- 依赖用户已有 Obsidian 使用习惯,纯命令行或非 Obsidian 用户上手成本较高
- 自组织逻辑与各 Agent 的集成细节较多,缺少开箱即用的统一配置体验
适用场景
- 长期维护同一代码库,让 AI 助手记住架构决策和历史踩坑
- 个人第二大脑,把日常笔记自动整理成可供 AI 检索的上下文
- 团队共享知识库,让多个 AI 编码工具读取统一的项目记忆
替代项目
Basic Memory、mem0
上一篇:agentspan
下一篇:xyne-spaces
同类项目推荐
n8n
开源
拖拽搭建自动化流程,轻松接入 AI 与 400+ 应用,搞定重复工作。
Fair-code workflow automation platform with native AI capabilities. Combine visual b···
EasyCLIProxyAPI
开源
图形界面一键配好 AI 代理,省去手写配置文件
A desktop GUI for CLIProxyAPI and a tool for automatically configuring popular AI ag···
feishu-docx
开源
让 AI 代理轻松读写飞书文档,双向转换 Markdown
Feishu/Lark Docs、Sheet、Bitable <-> Markdown | AI Agent-friendly knowledge base exp···
puppeteer
开源
用 JavaScript 轻松操控无头浏览器,搞定自动化测试与网页抓取。
JavaScript API for Chrome and Firefox
