背景需求
??最近所參與的項目即將結項,需要將飛書中的產品需求文檔(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獲取方式,如下圖所示