Siyuan Skill

运行要求: Node.js >= 14.0.0, 思源笔记 >= 3.6.0 安装: 从 ClawHub 下载

快速开始

node {baseDir}/scripts/<command>.js [options]
node {baseDir}/scripts/<command>.js --help  # 查看命令帮助

场景化快速开始

💡 根据你的任务场景，快速找到对应的命令和工作流

我要...

📋 更多场景：troubleshooting.md

命令列表

笔记本/文档操作

块操作

搜索/索引

关键规则

ID 区分

• 文档操作 (update/delete/move/rename) 接受文档 ID（部分命令也支持路径）
• 块操作 (block-update/block-delete 等) 只接受块 ID
• 混用会导致错误, 详见 快速参考

删除保护

• 默认禁止删除文档, 需用户手动在 config.json 中启用
• 保护层级: 全局安全模式 → 文档保护标记 → 删除确认机制
• Agent 禁止自动修改删除配置
• 详见 安全文档

权限验证

• 支持 permissionMode: all(默认) / whitelist / blacklist
• 写入操作 (create/update/delete/move 等) 会检查笔记本权限
• 通过 SIYUAN_NOTEBOOK_LIST 环境变量配置笔记本列表

格式规范（重要）

写入思源笔记时必须遵循以下格式：

📋 完整规范：format-standard.md | 快速参考：quick-reference.md

搜索模式

向量搜索需配置 QDRANT_URL + OLLAMA_BASE_URL

标准工作流

创建: exists 检查 → create (或 --force)
修改: content 获取 → 判断范围 → update (全文) 或 block-update (单块)
搜索: search 查询 → content 查看 → update/block-update 修改
删除: protect 检查 → delete

📋 完整工作流示例见 examples/basic-usage.md

参考文档

📋 必读文档

🔧 配置与权限

🚀 进阶功能

📖 示例文档

🎯 快速导航

• 遇到问题：troubleshooting.md
• 查看命令：quick-reference.md
• 格式规范：format-standard.md
• 规范索引：spec-index.md

🔧 遇到问题？

如果在使用过程中遇到任何问题，请按以下步骤排查：

1. 查看错误信息

错误信息中通常会包含：

• 错误原因
• 解决方案提示
• 相关文档链接

2. 查阅问题解决索引

📋 troubleshooting.md - 按错误信息和任务场景组织的完整问题索引

3. 查看快速参考

📋 quick-reference.md - 命令决策表和常见错误预防

4. 查看详细文档

5. 查看示例

• 基础用法示例
• 文档工作流
• 块操作指南

💡 快速链接：规范索引 | 问题解决索引