# douyin&bilibili Video to Obsidian

[![CI](https://github.com/cgmdeep/video-to-obsidian/actions/workflows/ci.yml/badge.svg)](https://github.com/cgmdeep/video-to-obsidian/actions/workflows/ci.yml)
[![Security](https://github.com/cgmdeep/video-to-obsidian/actions/workflows/security.yml/badge.svg)](https://github.com/cgmdeep/video-to-obsidian/actions/workflows/security.yml)
[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)

把抖音或哔哩哔哩单视频交给 Kimi 分析，并把正式中文笔记写入 Obsidian。

推荐入口是：

```text
用户自己的微信 → 用户自己的 ZCode → video-to-obsidian MCP → Obsidian
```

也可以直接把完整分享文本粘贴到 ZCode。

> 当前公开版本是 Windows x64 未签名的 `v0.1.0-alpha.12`。GitHub Release、COS 国内镜像和 `shizhiku.cn` 生产官网已经切换到同一版本；安装器会创建或修复 Obsidian Vault、ZCode 专用工作区和本地“知识激活”助手。双平台真实视频、长视频、缓存、质量固定集和 ZCode 官方微信 Bot 已有证据；从生产官网开始的陌生用户首装、一次真实衍生知识调用和更大规模体验仍属于上线验收，不得声称稳定生产版。

官网 [shizhiku.cn](https://shizhiku.cn/) 提供 COS 国内镜像和 GitHub 备用下载；安装包大小与 SHA-256 以当前 Release 的 `SHA256SUMS` 为准。

主线阶段、完成门槛与暂停项见 [`docs/PRODUCT_ROADMAP.md`](docs/PRODUCT_ROADMAP.md)。

## 设计目标

- 使用用户自己的 Kimi API Key、抖音账号和B站账号。
- 默认 Kimi K2.7；只有精确短语“使用K3深度分析”触发 K3。
- 默认不生成逐字稿、不永久保存原视频。
- 可选连接 SenseVoice，生成原始逐字稿。
- 视频、Cookie、密钥、缓存和运行状态不进入 Obsidian Vault。
- 首版一次只处理一条视频，失败不盲目重试。
- 人类只负责 API Key、扫码和 Vault 选择，其余部署工作交给 AI 助手。

## 当前可用命令

```bash
video-to-obsidian init --vault "/path/to/Video Knowledge Base"
video-to-obsidian set-kimi-key
video-to-obsidian doctor
video-to-obsidian audit-vault --json
video-to-obsidian route "完整的视频分享文本"
video-to-obsidian mcp
video-to-obsidian configure-zcode
video-to-obsidian bootstrap-workspace --workspace "/path/to/视知库助手"
video-to-obsidian zcode-model-status --json
video-to-obsidian configure-zcode-moonshot --json
```

`init` 会建立公共配置和 `Douyin/`、`Bilibili/` 两个笔记目录，但不会修改 `.obsidian`。

`set-kimi-key` 会在终端无回显地读取两次 Key，并保存到 Windows 凭据库或 macOS 钥匙串。无钥匙串的服务器可以显式向服务进程注入 `KIMI_API_KEY`。

`doctor` 只检查配置、Vault、Kimi Key 是否存在，以及 Firefox、ffmpeg、ffprobe、yt-dlp、Obsidian 是否可用；只显示Key来源，不显示密钥值，也不会发起付费视频分析。

`audit-vault` 只读扫描当前 Vault 的受管来源笔记，忽略 `.obsidian`、回收站和 Syncthing 历史版本，报告稳定身份重复组与不可读文件；不读取 Key、不联网，也不会发起付费分析。

统一 MCP 当前暴露：

- `doctor`：免费环境体检；
- `route_video`：免费识别平台和 K3 触发词；
- `analyze_douyin`：抖音普通单视频；
- `analyze_bilibili`：B站普通单视频，多P必须使用带 `?p=` 的具体链接。

两个分析工具默认 `save_video=false`，每次工具调用最多发起一次 Kimi 分析，不在服务内部自动重试。

`bootstrap-workspace` 为 ZCode Bot Channel 创建一个独立的“视知库助手”工作区，只在
该工作区内添加 MCP 和视频路由规则，不修改用户的其他编程项目。
`zcode-model-status` 只读检查 ZCode 是否已有可用模型通道，只返回密钥“是否存在”，
不返回 API Key 或接口地址，也不发起模型调用。Coding Plan 不是必需条件；用户可在
ZCode 中使用自己的 Moonshot 或其他兼容模型通道。

当用户没有 Coding Plan，且 ZCode 也没有其他可用模型通道时，安装向导可在获得明确选择后
调用 `configure-zcode-moonshot`，复用已安全保存的 Kimi Key 增量添加 Moonshot 通道。
该操作会保留 ZCode 其他供应商，创建权限受限的恢复副本，不在终端显示 Key，
也不发起模型调用。

## 总结不合口味怎么办

总结强度和写法不是固定死的。直接告诉 AI 助手你的偏好即可，例如：

```text
以后总结更详细，按时间线展开，所有数据和例子都保留，特别注意区分反讽和作者真实观点。

以后少写背景铺垫，重点提炼方法、操作步骤、参数和失败原因。
```

AI 助手会把长期偏好保存到 Vault 外的私有配置文件：

```bash
video-to-obsidian set-summary-preferences "按时间线详细总结，保留数据、例子和反讽语境"
```

查看偏好或恢复默认：

```bash
video-to-obsidian show-summary-preferences
video-to-obsidian clear-summary-preferences
```

只想调整某一条视频时，把要求和链接写在同一条消息中即可，不会改变长期偏好。偏好可以调整篇幅、结构、语气和关注点，但不会自动切换 K3、增加重试、改变是否保存视频，也不能绕过单视频、隐私和安全边界。若同一来源已经有正式笔记，重新总结的结果会进入 Vault 外候选目录供比较，不会覆盖原笔记。

## Windows alpha 安装

普通用户的目标入口是单个 `VideoToObsidian.Setup.exe`，不需要克隆仓库、安装 Coding Plan、理解 Python、PowerShell 或 MCP。首个公开包是 GitHub Pre-release 中的未签名 Alpha；下载后应对照 Release 页提供的 SHA256。它不是稳定版，Windows SmartScreen 可能显示未知发布者提示。

同一个安装器提供两个清楚的档位，不需要下载两套程序：默认“标准版”只生成结构化笔记；高级设置中的“逐字稿增强版”会尝试连接用户自己的 SenseVoice 兼容服务。SenseVoice 不可用时只跳过逐字稿，仍继续生成正式笔记。公开 Alpha 不提供作者的 ASUS 作为公共转写服务，也不会暗示普通用户已经获得一键本地 ASR。

安装向导会：

- 通过 Windows `winget` 检查或安装 Python、Firefox、Obsidian 和 ffmpeg；
- 在 `%LOCALAPPDATA%\VideoToObsidian\runtime` 创建隔离核心；
- 新建 Obsidian Vault 和 `文档\视知库助手` ZCode 专用工作区；
- 创建隔离的 Firefox `VideoToObsidian` 登录空间；
- 让用户在不回显密钥的界面中保存自己的 Kimi API Key；
- 提供抖音、B站、ZCode 官方微信 Bot Channel 的扫码入口与免费状态检查。

用户只需完成三类私密动作：输入自己的 Kimi Key、扫码登录自己的视频平台账号、在 ZCode 官方 Bot Channel 中扫码连接自己的微信。项目不使用企业微信机器人，也不会读取用户的日常 Firefox Profile。

没有 Coding Plan 也可以使用：安装器会优先保留 ZCode 已有模型；确实没有可用模型时，待 ZCode 首次初始化后，可复用同一把 Kimi Key 增量配置 Moonshot 路由模型。该检查不发起付费调用。

仓库中的 `scripts/install.ps1` 仅作为开发者、AI 助手和故障恢复的高级入口，不是普通用户主流程。

完整步骤、失败恢复和卸载方式见 [Windows 安装与扫码指南](docs/INSTALL_WINDOWS.md)。
仓库或工作区没有自动出现时，使用 [Windows 手动恢复与 Agent 兜底](docs/RECOVERY_WINDOWS.md)，
不要让 Agent 猜测配置或覆盖其他项目。

当前 Alpha 首发以 Windows 11 x64 为优先验证平台。发布包见 [GitHub Releases](https://github.com/cgmdeep/video-to-obsidian/releases)，发布门槛见 [docs/RELEASE_CHECKLIST.md](docs/RELEASE_CHECKLIST.md)。

## 两种档位

### 标准版（默认）

- Kimi 直接观看视频并写正式笔记。
- 不运行本地 SenseVoice。
- 不需要显卡或闲置服务器。
- 默认不保存原视频。

### 逐字稿增强版

- 增加 SenseVoice 原始逐字稿。
- SenseVoice 可以在本机运行，也可以连接远程闲置主机。
- 逐字稿失败不应阻止 Kimi 正式笔记入库。

## 日常需要运行什么

| 软件或服务 | 是否需要保持运行 | 说明 |
|---|---|---|
| ZCode | 是 | 对话和微信入口。 |
| Video to Obsidian MCP | 是 | 由 ZCode 自动启动，无单独窗口。 |
| Obsidian | 否 | Markdown 可以在应用关闭时写入。 |
| Firefox | 否 | 只在首次扫码或 Cookie 失效时打开。 |
| SenseVoice | 仅增强版 | 标准版不需要。 |
| ffmpeg / yt-dlp | 无需手工打开 | 由流水线调用。 |

## 文件体积参考

现有真实 B站样本中，约 5～46 分钟的视频下载体积约 34.7～306.9 MB；带逐字稿的 Markdown 约 14.7～63.1 KB，去掉逐字稿后约 4～14 KB。视频清晰度越高，下载和临时空间通常越大。

不保存原视频时，成功后应删除下载视频、Kimi 临时代理和临时音频，最终通常只留下几 KB 到几十 KB 的 Markdown。

分析过程中仍需预留临时空间。建议至少保留“预计视频大小的 3 倍 + 1 GB”，以容纳下载文件、合并过程和低码率分析代理。失败时会保留必要检查点供人工重试；成功且未要求归档时会清理视频和代理。

## 模型与费用

- 默认档使用 `kimi-k2.7-code`；它价格较低并支持视频输入，但官方定位偏 Coding，因此公开版仍需用固定视频集验证总结质量。
- 只有同一条消息包含精确短语“使用K3深度分析”才使用 `kimi-k3`。K3 适合更高强度的知识工作和推理，费用通常更高。
- Kimi 按实际输入与输出 token 计费，视频长度、画面采样、推理量和正文长度都会影响费用；项目不会把“每条视频固定多少钱”写死。
- 文件上传与保存接口是否免费、模型单价和充值规则可能变化，使用前请查看 [Kimi 官方价格页](https://platform.kimi.com/docs/pricing/chat)。
- K3 当前需要账户完成充值后才能调用；新用户赠送额度可能不能用于 K3，详见 [K3 官方说明](https://platform.kimi.com/docs/guide/kimi-k3-quickstart)。

公开测试价格必须来自真实 `usage`，不能按时长猜测。验收记录同时列出视频时长、输入 token、输出 token、模型和当时官方单价；费用是依据 API usage 的估算，不冒充控制台账单。独立 Windows 设备上的抖音、B站典型视频和长视频付费样本见 [公开验收记录](docs/ACCEPTANCE.md)。

## 安全边界

- Cookie 只能来自用户自己的账号。
- 不提供共享 Cookie，不绕过会员、付费内容或 DRM。
- API Key 优先保存在系统钥匙串；无可用钥匙串的服务器才使用进程环境变量 `KIMI_API_KEY`。
- 不把密钥、Cookie、Authorization、签名视频地址写入笔记或日志。
- 不修改用户现有 `.obsidian` 配置、主题和插件。

## 卸载

当前 Alpha 尚未注册到 Windows“已安装的应用”。普通用户可在安装向导底部点击“安全卸载（保留笔记）”：它只移除核心和本项目的 ZCode MCP，保留 Vault、专用工作区、Firefox Profile、Kimi Key 和第三方软件。开发者或 AI 助手也可使用源码脚本：

```powershell
powershell -ExecutionPolicy Bypass -File .\scripts\uninstall.ps1
```

只有明确确认不再需要失败检查点、候选笔记和视频归档时，才添加 `-RemovePrivateData`。脚本永远不会删除 Obsidian Vault。

## 开源许可与安全报告

本项目使用 [Apache License 2.0](LICENSE)。安全问题请按照 [SECURITY.md](SECURITY.md) 通过 GitHub 私密漏洞报告提交，不要在公开 Issue 中粘贴 Key、Cookie、视频或个人信息。

AI 助手部署要求见 [AGENTS.md](AGENTS.md)。