开始使用

本指南使用 Markdown DB Engine 0.3.0 创建本地 Runtime Database，并通过 Web UI 查看和管理内容。需要 Node.js 22 或更高版本。

启动 Local Server

无需全局安装即可启动：

npx md-db-engine@0.3.0 serve ./content.mddb --open

第一次打开空 Database 时，终端只显示一次自动生成的 Owner Credential。把 owner:secret 形式的值粘贴到 Web UI 登录页。Database 保存在 ./content.mddb，停止 Server 不会删除数据。

如果希望固定端口：

npx md-db-engine@0.3.0 serve ./content.mddb --port 4100 --open

长期使用可以全局安装：

npm install --global md-db-engine@0.3.0
md-db-engine --version
md-db-engine --help

理解三个目录

• Runtime Database，例如 ./content.mddb：应用查询和事务的正式数据，由一个 Writer Host 管理。
• Workspace，例如 ./obsidian-workspace：人、Obsidian 和 Agent 可以自由编辑的 Markdown 副本。
• Migration Review，例如 ./migration-review：一次性保存 Scan 报告、Config 和 Preview Plan，必须位于待迁移文件夹外部。

不要把 Runtime Database 目录直接作为 Obsidian Vault。Obsidian 应该打开迁移后或导出的 Workspace。

查询正在运行的 Server

Server 持有 Writer Lock 时，其他进程需要通过 Remote 接口访问：

md-db-engine query \
  --endpoint http://127.0.0.1:3000 \
  --credentials 'owner:replace-with-your-secret' \
  --collection documents \
  --limit 20 \
  --json

如果 Server 没有运行，单个 CLI 进程可以使用 --database ./content.mddb 以 Embedded 方式打开 Database。

下一步

• 已有 Obsidian Vault：阅读迁移 Obsidian Vault。
• 希望在 Obsidian 中日常编辑：阅读Workspace 协作。
• 希望查询数据并搭建网站：阅读搭建应用。
• 需要备份或处理 Writer Lock：阅读运维指南。