ai-knowledge-vault
Health Warn
- License — License: MIT
- Description — Repository has a description
- Active repo — Last push 0 days ago
- Low visibility — Only 7 GitHub stars
Code Pass
- Code scan — Scanned 5 files during light audit, no dangerous patterns found
Permissions Pass
- Permissions — No dangerous permissions requested
This is a local-first personal knowledge management template designed to integrate Obsidian with Claude Code. It processes and structures Markdown notes, concepts, and reports, relying on a two-tier retrieval system for efficient querying without complex RAG architecture.
Security Assessment
Overall Risk: Low. The code operates primarily on local files (reading/writing Markdown in the `knowledge/` directory) and does not require dangerous system permissions. A light code scan of five files found no dangerous patterns, hardcoded secrets, or suspicious network requests. The tool is designed to execute local Python scripts via Claude Code (e.g., `knowledge_ops.py` for compiling and querying data). While executing AI-generated or assisted shell commands always carries some inherent risk, the underlying codebase appears safe, confined to local workspace manipulation, and free of malicious intent.
Quality Assessment
The project is highly active, with its last push occurring today, though it currently has very low community visibility (only 7 stars). The code is well-documented and comes with a clear MIT license. It offers an English translation of the documentation, making it highly accessible to a broader audience despite the author's primary language being Chinese.
Verdict
Safe to use: a clean, permissively licensed, and actively maintained local tool with minimal security concerns.
Local-first Obsidian + Claude Code knowledge vault for structured notes, concept pages, reports, and AI workflows
ai-knowledge-vault
ai-knowledge-vault 是一个面向 Obsidian + Claude Code 的本地优先 AI 知识库模板:用 Markdown 管理 knowledge/ 下的条目、索引与收件箱。
英文说明见 README.en.md。
这是什么
这是我在自己一直在用的 AI 知识库 做法上继续迭代的一版:1.0版本说明我写在飞书:https://mcndg9yue1j0.feishu.cn/wiki/D6rPw8SnVizcq3kbtIVcqtAKn3f
在这个仓库里,我把那套思路开源成可直接克隆的目录约定,并吸收了 Andrej Karpathy 公开分享过的个人知识库想法——原始材料先进库、再由模型参与整理成可浏览的 Markdown 结构、平时以问答和报告迭代、辅以体检把结构保持干净。
主要特性
- 本地优先:内容落在
knowledge/*.md,Obsidian 打开即可协作阅读。 - inbox → 正式条目:手动素材走
inbox/manual/(pending/processed/review);音视频可走inbox/video/并可选转写。 - 先索引再深入:
knowledge/_index.md与knowledge/concepts/适合作为检索入口,需要细节再打开单篇的## 原始内容。 - 编译与导航:
compile维护概念层与索引关联。 - 查询可沉淀:
find支持把主题检索整理进knowledge/reports/。 - 健康与整理:
health/tidy做结构检查与归一化。 - Claude Code:
.claude/skills/kb/提供/kb工作流(见.claude/skills/kb/SKILL.md)。
系统逻辑闭环
flowchart LR
rawInput["RawInput: manualOrMedia"] --> ingest["Ingest: kbAddOrAddVideo"]
ingest --> entries["Entries: knowledgeMd"]
entries --> compile["Compile: knowledgeOpsCompile"]
compile --> concepts["Concepts: knowledgeConcepts"]
compile --> indexNode["Index: knowledge_index"]
entries --> query["Query: knowledgeOpsFind"]
concepts --> query
query --> reports["Reports: knowledgeReports"]
entries --> healthNode["Health: knowledgeOpsHealthOrTidy"]
healthNode --> reports
三条常用流:
- 入库流:原始资料进入
inbox,形成knowledge/*.md知识条目 - 编译流:
compile生成概念层与索引,形成导航网络 - 查询与体检流:
find/health/tidy产出报告并反哺知识库质量
分层架构
- 内容层(Source of Truth):
knowledge/knowledge/*.md:时间线知识条目(原始内容 + 核心观点)knowledge/concepts/:编译后的概念导航层knowledge/reports/:查询报告与健康检查报告
- 自动化层(Automation):
.claude/skills/kb/SKILL.md:/kb命令约定scripts/knowledge_ops.py:find/compile/health/tidyscripts/video_ingest.py:音视频入库与转写
- 消费层(Frontend & Agent):Obsidian + Claude Code
- Obsidian 用于浏览、链接、可视化
- Claude Code 负责增量维护和问答研究
5 分钟快速跑通(最小闭环)
1) 安装
git clone https://github.com/dingshuxin353/ai-knowledge-vault.git
cd ai-knowledge-vault
pip3 install -r requirements.txt
2) 准备一条待处理素材
把任意 Markdown 放到 knowledge/inbox/manual/pending/,或在 Claude Code 里使用 /kb add。
如果你已经批量放入了 pending/,可继续在 Claude Code 中执行 /kb process-pending 进行入库整理。
3) 编译概念层与索引
python3 .claude/skills/kb/scripts/knowledge_ops.py compile
4) 做一次查询并沉淀报告
python3 .claude/skills/kb/scripts/knowledge_ops.py find "你的主题关键词"
5) 做一次健康检查
python3 .claude/skills/kb/scripts/knowledge_ops.py health
按上述步骤执行后,预期会得到类似产物:
- 知识条目:
knowledge/*.md - 概念层:
knowledge/concepts/*.md - 索引入口:
knowledge/_index.md - 报告输出:
knowledge/reports/*.md
两层检索机制(为什么它在小中规模很实用)
- 第一层:读取
knowledge/_index.md+knowledge/concepts/*.md,先定位主题和范围 - 第二层:按需展开具体条目的
## 原始内容,只在必要时读取细节证据
这种分层可以在不引入复杂 RAG 工程的前提下,在个人知识库规模内保持较好的查询质量与响应效率。
目录地图(关键部分)
knowledge/
_index.md
concepts/
reports/
inbox/
manual/
pending/
processed/
review/
video/
raw/
transcripts/
logs/
.claude/skills/kb/
docs/
说明:本仓库以模板形式分发,knowledge/concepts/ 下的概念页通常需要在本地运行 compile 后逐步生成。
可选能力:视频/音频转写
需要:
pip3 install dashscope- 已安装
ffmpeg与ffprobe - 配置
.claude/skills/kb/config.local.json(或DASHSCOPE_API_KEY)
运行:
python3 .claude/skills/kb/scripts/video_ingest.py
更多细节见 [docs/video-transcription.md](./docs/video-transcription.md)。
适合谁 / 不适合谁
适合:
- 想把长期研究资料沉淀为可被 AI 持续操作的知识系统
- 想在本地 Markdown 上构建可迁移、可追溯的个人 wiki
- 想让每次问答结果都“累积进知识库”而非一次性对话
不适合:
- 只需要临时笔记,不需要结构化维护
- 期望零配置云托管 SaaS 体验,不想维护本地文件与脚本
文档入口
- 架构说明:
[docs/architecture.md](./docs/architecture.md) - 安装指南:
[docs/installation.md](./docs/installation.md) - 视频转写说明:
[docs/video-transcription.md](./docs/video-transcription.md) - 概念层目录说明:
[knowledge/concepts/README.md](./knowledge/concepts/README.md) - 报告目录说明:
[knowledge/reports/README.md](./knowledge/reports/README.md) - 手动入库目录说明:
[knowledge/inbox/manual/README.md](./knowledge/inbox/manual/README.md) - 视频入库目录说明:
[knowledge/inbox/video/README.md](./knowledge/inbox/video/README.md)
下一步建议
- 先向
knowledge/inbox/manual/pending/放入少量原始材料试跑 - 执行一次
compile + find + health,观察概念层与报告如何联动 - 按自身主题与领域,扩展
.claude/skills/kb/scripts/中的处理策略
开源许可
MIT License
Reviews (0)
Sign in to leave a review.
Leave a reviewNo results found