Obsidian CLI 扫描工具

安装与使用

npm install
npm run build
npm link

运行命令：

scan-obsidian --directory /path/to/vault --index /path/to/index.md --sync /path/to/content

配置文件（推荐）

CLI 支持从本地配置文件读取默认参数：

• 路径：~/.config/obs-scanner/config.yaml
• 字段：directory、index、sync

示例：

directory: /path/to/vault
index: /path/to/index.md
sync: /path/to/content

命令行参数优先于配置文件。若配置文件不存在，CLI 会提示：

配置文件 /Users/yourname/.config/obs-scanner/config.yaml 不存在

路径支持使用 ~/ 作为用户目录的简写，CLI 会自动展开为绝对路径。

发布到 npm

项目提供了一个轻量发布脚本：

npm run release:npm

脚本会按顺序执行这些检查和动作：

• 校验当前 npm registry 必须是官方源 https://registry.npmjs.org/
• 校验当前分支必须是 main
• 校验 git 工作区必须干净
• 校验当前 npm login 状态有效
• 执行 npm test
• 执行 npm pack --dry-run
• 最后执行 npm publish

如果需要临时改发布分支或目标源，可以通过环境变量覆盖：

EXPECTED_BRANCH=release EXPECTED_REGISTRY=https://registry.npmjs.org/ npm run release:npm

npm 包本身只发布运行所需内容和少量说明文件，当前白名单包括：

• dist/
• README.md
• config.sample.yaml

其中 build 只生成可发布的运行时代码；测试使用单独的 build:test，避免把测试产物混入最终 npm 包。