背景需求
最近所参与的项目即将结项,需要将飞书中的产品需求文档(PRD)交付给甲方,由于文档较多,大概有两百多个,一个一个的下载导出,太麻烦了(PS:本人比较懒),所以想着怎么样能够批量下载,于是乎,就网上资料查阅进行解决。(PS:本文章是基于参考资料进行内容完善的)
资料参考
- 基于.Net Core实现的飞书所有文档一键导出服务(支持多系统)
- Github——xhnbzdl/feishu-doc-export
解决方案
前提条件
在开展实操步骤讲解前,先把一些先决条件跟大家罗列一下,免得浪费大家时间(PS:我的是苹果电脑,下列操作是根据苹果电脑的操作进行讲解的)。
- 拥有需要导出的文件夹的管理权限。
- 飞书企业用户。(可以自己创建一个不需要认证的企业,再将文件夹的管理权限授予给该企业下用户)
实操步骤
- 创建应用机器人
在飞书应用平台首页点击“创建应用”按钮,进入到“应用创建”页面,点击“创建企业自建应用”按钮,进入到“创建企业自建应用”页面,进行应用基本信息填写,填写完成后,点击“创建”按钮,进入到“应用设置”页面,按顺序执行4.1添加应用能力——机器人;4.2权限管理——API权限:云文档(通过搜索如下权限项进行权限开通操作:查看新版文档, 查看、评论和下载云空间中所有文件,查看、评论和导出文档,查看、评论、编辑和管理云空间中所有文件, 查看、评论、编辑和管理多维表格,查看、评论、编辑和管理电子表格,查看、编辑和管理知识库,导出云文档);4.3 版本管理与发布——点击“创建版本”按钮,填写版本信息,进行保存发布;4.4凭证与基础信息——应用凭证,获取App ID和App Secret信息,用于后续脚本配置。可根据如下图例进行操作。
2.文件夹授权给应用机器人
通过飞书客户端创建一个群组,把应用机器人添加到群组中,然后再将对应的文件夹分享给该群组并授予管理权限。可根据如下图例进行操作。
- 脚本执行
- 点击上述参考资料“Github——xhnbzdl/feishu-doc-export”的链接,下载脚本应用,windows环境,下载feishu-doc-export-win-x64.zip;mac环境,下载feishu-doc-export-mac-osx-x64.zip;linux环境,下载feishu-doc-export-linux-x64.zip。
- 解压对应的压缩包,获得一个文件名为“feishu-doc-export”文件。
- linux环境和mac环境,需要先通过终端,执行命令语句:
cd .....
,"…"表示“feishu-doc-export”文件存储的位置 ,再执行如下命令:sudo chmod +x ./feishu-doc-export
,在输入电脑开机密码,回车键确认,使“feishu-doc-export”文件变成可执行文件。执行完成后,再双击“feishu-doc-export”文件,会弹出终端命令执行窗口,进行脚本运行。 - 脚本运行成功后,再在终端窗口中执行如下命令:
sudo ./feishu-doc-export --appId=xxx --appSecret=xxx --saveType=pdf --exportPath=E:\temp\test --type=cloudDoc --folderToken=xxx
appId 飞书自建应用的AppId.
appSecret 飞书自建应用的AppSecret.
saveType 文档保存的格式类型,可选值有md
,pdf
,docx
,如果参数不传,或值为空,或值为不存在的格式,则默认导出为docx
exportPath 文档导出的目录位置.
type 选择导出知识库或个人空间云文档,可选值:cloudDoc
、wiki
.
folderToken 当type=cloudDoc
时,需要填写--folderToken
参数,type=wiki
或空,则不需要填写。终端命令执行顺序和folderToken获取方式,如下图所示