diff --git a/docs/index.html b/docs/index.html index b9af163..41c6d68 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3,24 +3,23 @@ -Obsidian + AI Agent 知识库 — 项目介绍 +NEURAL VAULT // AI 知识库 @@ -309,24 +447,26 @@
-
+
+
+
🧠
-

Obsidian + AI Agent 知识库

-

面向非技术用户的本地 AI 知识管理方案。 - 支持 OpenCode / Claude Code / Codex / Pi 四大 agent,无需编程,一键部署,开箱即用。

+

NEURAL VAULT

+
本地 AI 知识库
+

面向非技术用户的本地 AI 知识管理方案 · 支持 OpenCode / Claude Code / Codex / Pi 四大 agent · 无需编程,一键部署

- MIT License - Platform · macOS + MIT + macOS 4 Agents 6 Providers - 100+ 适配器 + 100+ Adapters
-
- $ bash setup.sh --agent opencode +
+ root@vault:~$ bash setup.sh --agent opencode_
@@ -334,60 +474,72 @@

Obsidian + AI Agent 知识库

-

为什么需要它?

-

传统知识管理的三个痛点,本方案逐一解决

+
+
// 01 SYSTEM ANALYSIS
+

为什么需要它

+

传统知识管理的三个系统缺陷

+
    -
  • ChatGPT 没有长期记忆 — 每次对话从零开始,存不下你的知识积累
  • -
  • 笔记软件不会整理 — 收藏一堆,但没人帮你归类、去重、建索引
  • -
  • 数据在云端不放心 — 个人笔记、采集的社交内容,不想全交给云服务
  • +
  • ChatGPT 无长期记忆
    每次对话从零开始,知识无法沉淀
  • +
  • 笔记软件不会整理
    收藏一堆,没人帮你归类去重建索引
  • +
  • 数据全在云端
    个人笔记和采集内容不想交给云服务
-

💡 本方案的回答

+

// SOLUTION

AI 自动整理 — 文章、PDF、截图丢给 AI,自动归类成结构化笔记

-

永久本地记忆 — 笔记存在你电脑,AI 对话时才发送给模型服务商

-

定期自动体检 — AI 检查死链、重复、孤岛页面,保持知识库健康

-

四个 AI agent 自由切换,规则和技能全部共用

+

永久本地记忆 — 笔记存在你电脑,仅对话时发送给模型服务商

+

定期自动体检 — AI 检查死链、重复、孤岛页面,保持健康

+

▸ 四大 AI agent 自由切换,规则技能全部共用

-
+
-

核心功能

-

一句话描述你要做什么,AI 全自动完成

+
+
// 02 CORE MODULES
+

核心功能

+

一句话描述意图,AI 全自动执行

+
+ 01
📥
-

自动录入 Ingest

-

文章、PDF、截图直接丢给 AI,自动存原始素材 + 整理成结构化 wiki 笔记 + 更新索引日志

+

INGEST

+

文章、PDF、截图丢给 AI,自动存原始素材 + 整理成 wiki 笔记 + 更新索引日志

+ 02
📱
-

社交采集 Social Ingest

-

小红书、抖音、Twitter、微博内容一键归类、去口语、评估可信度、同主题自动合并

+

SOCIAL INGEST

+

小红书、抖音、Twitter、微博一键归类、去口语、评估可信度、同主题自动合并

+ 03
🔍
-

智能查询 Query

-

像聊天一样问「我写过关于 XX 的内容吗」,AI 从索引定位 + 合成答案并引用来源

+

QUERY

+

像聊天一样问「我写过关于 XX 的内容吗」,AI 定位 + 合成答案 + 引用来源

+ 04
🏥
-

定期体检 Lint

-

每周一次,AI 检查索引一致性、死链、孤岛页面、跨文章事实矛盾,自动修复

+

LINT

+

每周体检,AI 检查索引一致性、死链、孤岛页面、事实矛盾,自动修复

+ 05
🔒
-

数据本地

-

笔记是普通 Markdown 文件,存在你电脑;raw/ 原始素材永不被 AI 修改,随时备份

+

LOCAL VAULT

+

笔记是普通 Markdown,存在你电脑;raw/ 永不被 AI 修改,随时备份

+ 06
⚡
-

一键部署

-

运行 setup.sh,选 agent + 选 provider + 粘贴 Key,5 分钟从零到可用

+

ONE-CLICK DEPLOY

+

运行 setup.sh,选 agent + 选 provider + 粘 Key,5 分钟从零到可用

@@ -396,12 +548,15 @@

一键部署

-

四大 AI Agent,自由切换

-

同一套规则与技能,按你的偏好选 agent。部署时用 --agent 选择

+
+
// 03 AGENT MATRIX
+

四大 AI Agent

+

同一套规则与技能,按你的偏好选择 · --agent <name>

+
- 推荐 + RECOMMENDED

OpenCode

--agent opencode
    @@ -432,7 +587,7 @@

    Codex

- 新增 + NEW

Pi

--agent pi
    @@ -442,40 +597,42 @@

    Pi

-
- 🔌 claudian 统一插件 — 四个 agent 都能在 Obsidian 内直接对话,一行配置搞定。 - OpenCode 还可选 --plugin opencode-obsidian 切回 serve 模式。 +
+ 🔌 CLAUDIAN UNIFIED PLUGIN — 四个 agent 都能在 Obsidian 内直接对话,一行配置搞定
-
+
-

日常怎么用?

-

四个触发词,覆盖知识管理的全流程

-
+
+
// 04 OPERATIONS
+

日常怎么用

+

四个触发词,覆盖知识管理全流程

+
+
1
-

录入素材

+

INGEST

丢文章/链接/截图给 AI

加到 wiki
2
-

社交采集

+

SOCIAL

小红书/抖音/Twitter 归档

收录这条
3
-

智能查询

+

QUERY

问已有笔记,引用来源

wiki 里有没有
4
-

定期体检

+

LINT

检查死链/重复/孤岛

lint wiki
@@ -486,20 +643,23 @@

定期体检

-

架构设计

-

三个组件协同,中间的 AI Agent 可四选一

-
+
+
// 05 ARCHITECTURE
+

架构设计

+

三个组件协同,AI Agent 四选一

+
+
┌──────────────────────────────────────────────────────────────────┐ │ │ │ ┌─────────────┐ ┌──────────────────────┐ ┌───────────┐ │ -│ │ Obsidian │◄──►│ AI Agent (四选一) │◄──►│ AGENTS.md │ │ +│ │ Obsidian │◄──►│ AI Agent (四选一) │◄──►│ AGENTS.md │ │ │ │ (笔记软件) │ │ OpenCode/Claude/Codex│ │ (AI 规则) │ │ -│ │ │ │ / Pi │ │ │ │ +│ │ │ │ / Pi │ │ │ │ │ └─────────────┘ └──────────────────────┘ └───────────┘ │ │ │ -│ · Obsidian:本地笔记,像普通笔记本 │ -│ · AI Agent:模型接口,四选一,规则技能共用 │ -│ · AGENTS.md:行为指南,定义 Ingest/Query/Lint/Social 行为 │ +│ ▸ Obsidian:本地笔记,像普通笔记本 │ +│ ▸ AI Agent:模型接口,四选一,规则技能共用 │ +│ ▸ AGENTS.md:行为指南,定义 Ingest/Query/Lint/Social 行为 │ │ │ └──────────────────────────────────────────────────────────────────┘
@@ -507,92 +667,97 @@

架构设计

-
+
-

知识库结构

-

清晰的目录职责,raw 永不改,wiki AI 维护

+
+
// 06 DATA STRUCTURE
+

知识库结构

+

raw 永不改,wiki AI 维护

+
-# 部署后的知识库 +// 部署后的知识库 我的知识库/ -├── AGENTS.md # AI 规则(系统维护) -├── AI_CONFIG.md # ⚙️ 用户可自定义配置 -├── raw/ # 原始素材(AI 只读) -│ └── social/ # 按知识域分类 -├── wiki/ # AI 整理的笔记 -│ ├── index.md # 全局索引 -│ └── log.md # 操作日志 -├── assets/ # 配图资源 -└── .opencode/skill/ # 9 个预装技能 - # (claude→.claude/skills) - # (codex/pi→用户级) +├── AGENTS.md // AI 规则(系统维护) +├── AI_CONFIG.md // ⚙️ 用户可自定义 +├── raw/ // 原始素材(AI 只读) +│ └── social/ // 按知识域分类 +├── wiki/ // AI 整理的笔记 +│ ├── index.md // 全局索引 +│ └── log.md // 操作日志 +├── assets/ // 配图资源 +└── .opencode/skill/ // 9 预装技能
-
-

📦 raw/ — 不可变原始素材

-

PDF、文章、截图、社交内容原样保存。AI 只读,永不修改,保证可追溯。按知识域分子目录。

+
+

▸ raw/ 不可变原始素材

+

PDF、文章、截图、社交内容原样保存。AI 只读永不修改,保证可追溯。按知识域分子目录。

-
-

📝 wiki/ — AI 维护的消化笔记

+
+

▸ wiki/ AI 维护笔记

AI 整理后的结构化笔记。同主题自动合并,跨主题交叉引用。index.md 全局索引,log.md 操作日志。

-

🛠️ .opencode/skill/ — 预装技能

-

9 个技能(obsidian-cli、opencli-usage、smart-search 等),内容四 agent 共用,按 agent 分发到对应目录。

+

▸ .opencode/skill/ 预装技能

+

9 个技能(obsidian-cli、opencli-usage、smart-search 等),内容四 agent 共用,按 agent 分发。

- -
+ +
-

5 分钟部署

-

两种方式,选适合你的

+
+
// 07 DEPLOYMENT
+

5 分钟部署

+

两种方式,选适合你的

+
-

🤖 方式一:让 AI 帮你部署(零门槛)

-

把这句话发给任何 AI 助手(ChatGPT、Claude、GLM),它自动完成全部部署:

-
请帮我部署 AI 知识库: +

🤖 方式一:AI 帮你部署

+

把这句话发给任何 AI 助手,自动完成全部部署:

+
请帮我部署 AI 知识库: https://github.com/zxfccmm4/Obsidian-OpenCode-Knowledge /blob/main/GUIDE_FOR_AI.md
-

AI 会读取部署指南,自动完成环境检查、安装、配置。

⌨️ 方式二:手动 3 步

-
# 1. 克隆仓库 -git clone https://github.com/zxfccmm4/Obsidian-OpenCode-Knowledge.git -cd Obsidian-OpenCode-Knowledge +
// 1. 克隆 +git clone https://github.com/zxfccmm4/Obsidian-OpenCode-Knowledge.git +cd Obsidian-OpenCode-Knowledge -# 2. 运行安装脚本(macOS) -bash setup.sh +// 2. 运行安装脚本 +bash setup.sh -# 3. 在 Obsidian 打开「我的知识库」
-

交互式选 agent、选 provider、粘 Key,5 分钟搞定。

+// 3. 在 Obsidian 打开知识库
-
-# 非交互式完整部署示例(脚本/CI 用) -bash setup.sh --non-interactive \ - --agent claude-code \ - --provider anthropic \ - --api-key "<KEY>" \ - --vault "$HOME/Desktop/我的知识库" \ - --overwrite-existing --overwrite-config +
+// 非交互式完整部署(脚本/CI 用) +bash setup.sh --non-interactive \ + --agent claude-code \ + --provider anthropic \ + --api-key "<KEY>" \ + --vault "$HOME/Desktop/我的知识库"
-
+
+
+
// 08 METRICS
+

数据一览

+
-
4
AI Agent
-
6
模型 Provider
-
9
预装技能
-
100+
网站适配器
-
5min
部署时间
+
4
Agents
+
6
Providers
+
9
Skills
+
100+
Adapters
+
5m
Deploy
@@ -600,27 +765,30 @@

⌨️ 方式二:手动 3 步

-

常见问题

+
+
// 09 FAQ
+

常见问题

+
-

Q:我没有技术背景,能用起来吗?

-

完全可以。专为非技术用户设计,跟着部署指南一步步操作,不需要懂编程。也支持「让 AI 帮你部署」的零门槛方式。

+

Q // 没有技术背景能用吗

+

完全可以。专为非技术用户设计,跟着部署指南操作不需要懂编程。也支持「让 AI 帮你部署」的零门槛方式。

-

Q:我的数据安全吗?

-

笔记文件保存在你自己电脑上,本项目不托管你的数据。使用 AI 时,当前对话内容会发送给你配置的模型服务商。raw/ 目录的原始素材永远不会被 AI 修改。笔记是普通 Markdown,随时可备份。

+

Q // 数据安全吗

+

笔记存在你自己电脑上,本项目不托管数据。使用 AI 时,当前对话内容会发送给你配置的模型服务商。raw/ 原始素材永不被 AI 修改。笔记是普通 Markdown,随时可备份。

-

Q:四个 agent 怎么选?

-

大多数用户选默认的 OpenCode(6 大模型原生、体验最完整)。偏好 Anthropic 选 Claude Code,偏好 OpenAI 选 Codex,喜欢开源轻量选 Pi。四个都支持 claudian 插件在 Obsidian 内对话,规则技能完全共用。

+

Q // 四个 agent 怎么选

+

大多数用户选默认的 OpenCode。偏好 Anthropic 选 Claude Code,偏好 OpenAI 选 Codex,喜欢开源轻量选 Pi。四个都支持 claudian 插件在 Obsidian 内对话,规则技能完全共用。

-

Q:和直接用 ChatGPT 有什么区别?

+

Q // 和 ChatGPT 的区别

ChatGPT 数据在云端、记忆是会话级、整理要手动。本方案数据本地、记忆永久、AI 自动整理归类、支持文件关联和交叉引用。

-

Q:想换 agent 或 provider 怎么办?

-

重跑 setup.sh 选新的即可,不会删除你已有的 raw/ wiki/ 笔记。详见 docs/agents.md 的切换指南。

+

Q // 想换 agent 或 provider

+

重跑 setup.sh 选新的即可,不会删除你已有的 raw/ wiki/ 笔记。详见 docs/agents.md。

@@ -630,14 +798,14 @@

Q:想换 agent 或 provider 怎么办?