yuque-dl 是一个将语雀知识库下载为本地 Markdown 文件的 Node.js 工具,支持保留目录结构、图片下载等功能。
主要特点
- 完整下载:将语雀知识库完整下载为本地 Markdown 文件
- 图片下载:可选择将图片也下载到本地
- 私有支持:支持下载私有知识库内容
- 断点续传:支持下载中断后继续
- Web预览:内置 Web 服务可快速预览下载内容
安装方法
npm i -g yuque-dl
需要 Node.js 18.4 或更高版本。
基本使用方法
下载公开知识库
yuque-dl "https://www.yuque.com/yuque/thyzgp"
下载私有知识库
需要提供 token:
yuque-dl "https://www.yuque.com/yuque/thyzgp" -t "your_token_value"
常用选项
-d, --dist-dir <dir>:指定下载目录(默认:download)-i, --ignore-img:忽略图片不下载-k, --key <key>:指定 cookie key(默认"_yuque_session")-t, --token <token>:指定 cookie 值--toc:输出文档 TOC 目录
高级使用
启动本地 Web 服务预览
yuque-dl server ./download/知识库/
企业版语雀使用
对于企业私有服务(非 yuque.com 域名),需要指定 token key:
yuque-dl "https://yuque.antfin.com/r/zone" -k "your_key" -t "your_token"
获取 Token 的方法
- 登录语雀网页版
- 打开开发者工具(F12)
- 进入 Application > Cookies
- 查找
_yuque_session或其他相关 cookie 的值
注意事项
- 如果 token 包含特殊字符,使用
-t="value"形式 - 下载附件需要登录 token
- 网络中断后可重新运行命令继续下载
这个工具非常适合需要备份语雀内容、迁移到其他平台或离线查看文档的场景。