echore_vault-autopilot/README.zh.md

7.2 KiB
Raw Permalink Blame History

English | 简体中文

Vault Autopilot

Vault Autopilot 配合配套的 Chrome 扩展 Obsidian Visual Clipper 使用:扩展负责接收剪藏内容,本插件负责把它们写入 vault 中结构化的笔记和图片——全程自动,无需手动粘贴、排版。

插件和扩展是一套完整方案扩展在浏览器里负责抓取网页截图、视频封面、Hook、关键帧本插件负责接收并归档。两者缺一不可。

功能说明

  • 网页截图 → 存成一条独立笔记,图片放入其 frames/ 子文件夹。
  • 视频类剪藏封面、Hook、关键帧→ 同一个视频的所有剪藏会合并写入同一条笔记。哪种剪藏先到就由它创建笔记,之后的剪藏会往里追加新的小节。
  • 每次剪藏的响应都会带上一个 obsidian:// 深链,指向被创建或更新的那条笔记,方便扩展直接跳转过去。

安装

社区插件市场(推荐,上架后可用):打开 Obsidian → 设置 → 社区插件 → 浏览 → 搜索 "Vault Autopilot" → 安装 → 启用。

通过 BRAT 安装(市场上架前的临时方案):安装 BRAT 插件,然后用 "Add a beta plugin" 添加本仓库地址。

Vault Autopilot 仅支持桌面端——它会启动一个本机 Node HTTP 服务Obsidian 移动端不支持本地服务,因此不可用。

要让剪藏内容真正到达插件,还需要安装 Obsidian Visual Clipper Chrome 扩展。

快速上手

Vault Autopilot 零配置可用:装好插件和扩展、启用插件即可直接开始剪藏,笔记会存到下文所述的默认 Clips/ 目录下。

想确认两边是否连通,可以打开扩展的引导页:它会对插件的健康检查接口做一次实时自检,并提供发送测试剪藏的功能,方便你在正式依赖它之前把整条链路验证一遍。

一个视频一条笔记。 同一个视频的封面、Hook、关键帧剪藏都会合并写入同一条笔记——谁先到就由它创建笔记之后的剪藏往里追加新的小节。网页截图与视频无关因此每一张都会独立成为一条笔记。

所有存储路径和端口都可以在设置里修改。插件只在本机 127.0.0.1:17183 提供本地服务,不会被局域网或公网访问到。插件发出的唯一一次网络请求,是从视频平台下载视频封面图,用于保存到你的 vault 中。

目录结构

默认情况下,所有内容都存放在 Clips/ 下:

Clips/
  Videos/
    covers/       ← 视频封面图 (<video_id>.webp)
    frames/       ← Hook / 关键帧抽出的帧图
    <video note>.md
  Screenshots/
    frames/       ← 截图图片
    <screenshot note>.md

一个视频一条笔记。 同一个视频的封面、Hook、关键帧剪藏都会往同一条笔记里追加小节——谁先到就由它创建笔记。网页截图与视频无关因此每一张都会独立成为一条笔记。

设置项说明

打开 设置 → Vault Autopilot。

语言

设置页顶部的语言下拉框可以在英文和中文之间切换插件——包括设置界面、通知,以及写入生成笔记里的文本。默认英文。切换语言后旧笔记依然能被正确识别与追加:小节匹配同时理解中英两种语言,所以已有笔记不会因为切换语言而失效(同一条笔记内可能出现中英标题混排,仅影响观感,不影响功能)。

存储位置

字段 默认值 用途
视频笔记文件夹 Clips/Videos 视频笔记(封面/Hook/关键帧合并写入)的存放位置
封面图片文件夹 Clips/Videos/covers <video_id>.webp 封面图的存放位置
帧图片文件夹 Clips/Videos/frames Hook/关键帧抽出的帧图存放位置
截图文件夹 Clips/Screenshots(含 /frames 独立截图笔记及其图片的存放位置

这四个字段都接受任意 vault 内相对路径;保持默认值即可维持零配置行为。

高级

字段 默认值 用途
启用 HTTP 服务 开启 开关本地接收剪藏的服务
端口 17183 本地服务监听的端口。只有端口冲突时才需要修改;改动之后必须同步修改扩展设置里的相同值,否则两边会断开连接
抽帧数量上限 5 每次 Hook/关键帧剪藏最多保留几帧120
封面/截图/Hook/关键帧 SOP 路径 可选vault 内某个 markdown 文件的路径,为对应剪藏类型提供分析指令。留空则该模式进入纯素材模式——笔记写入时不带分析提示块

网络使用说明

Vault Autopilot 会启动一个绑定在 127.0.0.1:17183(可配置)的本地 HTTP 服务。它存在的唯一目的,是让配套的 Chrome 扩展能把剪藏内容传给插件——浏览器扩展无法直接向 vault 写入文件,所以需要一个本地回环服务作为桥梁。

  • 服务只绑定在 127.0.0.1(回环地址)——不会被局域网或公网访问到。
  • GET /ping 是健康检查接口,返回 { "app": "vault-autopilot", "version": "<version>" },供扩展自检使用。
  • POST /clip 是唯一接受数据的接口。服务只对 chrome-extension:// 来源返回 CORS 响应头,普通网页无法读取其响应;再加上只绑定回环地址,只有你本机上运行的程序才能访问到它。
  • 该接口有意不设鉴权:配对令牌只能防御已经在你机器上运行的恶意软件,代价却是安装流程变复杂。接口只会向 vault 写入剪藏内容,不会读出任何数据,所以这类软件最坏也只是添加几条不想要的笔记。
  • 插件自身发出的唯一一次出站网络请求,是从视频平台的 CDN例如 YouTube 或 B 站的图片服务器)下载视频封面/缩略图,以便保存到你的 vault 中。除此之外没有任何其他出站请求,也没有任何数据被发送到除你本机文件系统以外的任何地方。
  • 本插件不会上传、追踪,或把任何数据发送给第三方服务。

疑难排解

"端口已被占用" / 扩展无法连接:

  • 可能有其他进程占用了 17183 端口。发生这种情况时 Vault Autopilot 会弹出通知,提示具体是哪个端口冲突。
  • 解决方法:要么关掉占用该端口的程序,要么同时在 Vault Autopilot 设置(高级 → 端口和扩展设置Advanced → Port里改成同一个新端口然后重启 Obsidian。

扩展显示插件离线 / 自检失败:

  • 确认 Vault Autopilot 已经在 Obsidian 的社区插件列表中启用。
  • 确认插件设置里的启用 HTTP 服务已打开。
  • 确认扩展中配置的端口与插件的端口设置完全一致。
  • Vault Autopilot 仅支持桌面端;如果 Obsidian 只在移动端打开,插件不会运行,扩展也无法连接到它。

剪藏内容到了,但存到了意料之外的文件夹:

  • 检查设置里的存储位置——各文件夹均可自定义,首次保存时的通知会明确告诉你每种模式的第一条笔记具体存到了哪里。

许可证

MIT — 详见 LICENSE