思源笔记命令行工具,提供便捷的命令行操作方式,支持笔记本管理、文档操作、内容搜索等功能
提供 AI Agent 可快速接入思源笔记的 skill 方案 为 AI Agent 团队提供统一、结构化、可检索的共享知识库
✅ 团队规范、项目知识、可复用技能 ✅ 需要多 Agent 共享的知识 ✅ 需要长期存储和检索的内容
❌ 日常互动记录、个人学习反思 ❌ 临时笔记、代码版本管理 ❌ 实时协作编辑
必须使用 CLI 命令来操作思源笔记 禁止自动修改配置文件与本技能相关环境变量配置 禁止直接调用 API 禁止使用脚本调用、引用 index.js 禁止使用脚本调用、引用指令文件
# 方式 1:进入技能目录运行
cd <skills-directory>/siyuan-skill
node siyuan.js <command>
# 方式 2:使用 npm link 全局安装(推荐)
npm link -g
siyuan <command>
# 方式 3:直接指定路径运行
node <skills-directory>/siyuan-skill/siyuan.js <command>
# 查看所有可用命令
siyuan help
# 查看特定命令的详细帮助
siyuan help search
siyuan help create
使用 siyuan help 查看所有可用命令和详细说明。
常用命令:
nb - 获取笔记本列表new - 创建文档edit - 更新文档rm - 删除文档find - 搜索内容(支持向量搜索)mv - 移动文档path - 转换 ID 和路径index - 索引文档到向量数据库nlp - NLP 文本分析详细命令文档请查看 doc/commands/ 目录。
export SIYUAN_BASE_URL="http://127.0.0.1:6806"
export SIYUAN_TOKEN="your-api-token"
export SIYUAN_DEFAULT_NOTEBOOK="your-notebook-id"
export SIYUAN_PERMISSION_MODE="all"
export SIYUAN_NOTEBOOK_LIST="notebook-id1,notebook-id2"
编辑 config.json 文件:
{
"baseURL": "http://127.0.0.1:6806",
"token": "your-api-token",
"defaultNotebook": "your-notebook-id",
"permissionMode": "all"
}
获取配置信息:
siyuan notebooks 获取笔记本 IDall(无限制)/ whitelist(白名单)/ blacklist(黑名单)--force-refresh 强制刷新index 命令默认启用增量索引,只索引有变化的文档;使用 --force 强制重建或 --no-incremental 禁用增量ZIP package — ready to use