feishu2md Download - feishu2md Source code download

feishu2md

其他源碼

v2.4.0

下載

feishu2md

這是一個下載飛書文檔為Markdown 檔案的工具，使用Go 語言實作。

請看這裡：招募有需求、有興趣的開發者，共同探討開發維護，有興趣請聯絡。

動機

《一日一技| 我開發的這款小工具，輕鬆助你將飛書文檔轉為Markdown》

取得API Token

配置檔案需要填寫APP ID 和APP SECRET 信息，請參考飛書官方文件獲取。推薦設定為

進入飛書開發者後台
創建企業自建應用程式（個人版），資訊隨意填寫
（重要）開啟權限管理，開啟下列必要的權限（可點選以下連結參考API 偵錯台->權限配置欄位）
- 取得文件基本訊息，「檢視新版文件」權限docx:document:readonly
- 取得文件所有區塊，「檢視新版文件」權限docx:document:readonly
- 下載素材，「下載雲端文件中的圖片與配件」權限docs:document.media:download
- 取得資料夾中的檔案清單，「檢視、評論、編輯和管理雲端空間中所有檔案」權限drive:file:readonly
- 取得知識空間節點信息，「查看知識庫」權限wiki:wiki:readonly
開啟憑證與基礎訊息，取得App ID 和App Secret

如何使用

注意：飛書舊版文件的下載工具已決定不再維護，但分支v1_support 仍可使用，對應的歸檔為v1.4.0，請知悉。

命令列版本

借助Go 語言跨平台的特性，已編譯好了主要平台的可執行文件，可以在Release 中下載，並將相應平台的feishu2md 可執行文件放置在PATH 路徑中即可。

查閱幫助文檔

$ feishu2md -h
NAME:
  feishu2md - Download feishu/larksuite document to markdown file

USAGE:
  feishu2md [global options] command [command options] [arguments...]

VERSION:
  v2-0e25fa5

COMMANDS:
  config        Read config file or set field(s) if provided
  download, dl  Download feishu/larksuite document to markdown file
  help, h       Shows a list of commands or help for one command

GLOBAL OPTIONS:
  --help, -h     show help (default: false)
  --version, -v  print the version (default: false)

$ feishu2md config -h
NAME:
   feishu2md config - Read config file or set field(s) if provided

USAGE:
   feishu2md config [command options] [arguments...]

OPTIONS:
   --appId value      Set app id for the OPEN API
   --appSecret value  Set app secret for the OPEN API
   --help, -h         show help (default: false)

$ feishu2md dl -h
NAME:
  feishu2md download - Download feishu/larksuite document to markdown file

USAGE:
  feishu2md download [command options] < url >

OPTIONS:
  --output value, -o value  Specify the output directory for the markdown files (default: " ./ " )
  --dump                    Dump json response of the OPEN API (default: false)
  --batch                   Download all documents under a folder (default: false)
  --wiki                    Download all documents within the wiki. (default: false)
  --help, -h                show help (default: false)

產生設定檔

透過feishu2md config --appId --appSecret 指令即可產生該工具的設定檔。

透過feishu2md config指令可以查看設定檔路徑以及是否成功設定。

更多的配置選項請手動開啟設定檔變更。

下載單一文檔為Markdown

透過feishu2md dl 直接下載，文件連結可以透過分享> 開啟連結分享> 在網路上取得連結的人可閱讀> 複製連結取得。

範例：

$ feishu2md dl " https://domain.feishu.cn/docx/docxtoken "

批次下載某資料夾內的全部文件為Markdown

此功能暫時不支援Docker版本

透過feishu2md dl --batch 直接下載，資料夾連結可以透過分享> 開啟連結分享> 在網路上取得連結的人可閱讀> 複製連結取得。

範例：

$ feishu2md dl --batch -o output_directory " https://domain.feishu.cn/drive/folder/foldertoken "

批量下載某知識庫的全部文件為Markdown

透過feishu2md dl --wiki 直接下載，wiki settings連結可以透過開啟知識庫設定來獲得。

範例：

$ feishu2md dl --wiki -o output_directory " https://domain.feishu.cn/wiki/settings/123456789101112 "

Docker版本

Docker 映像：https://hub.docker.com/r/wwwsine/feishu2md

Docker 指令： docker run -it --rm -p 8080:8080 -e FEISHU_APP_ID= -e FEISHU_APP_SECRET= -e GIN_MODE=release wwwsine/feishu2md

Docker Compose:

 # docker-compose.yml
version : ' 3 '
services :
  feishu2md :
    image : wwwsine/feishu2md
    environment :
      FEISHU_APP_ID : 
      FEISHU_APP_SECRET : 
      GIN_MODE : release
    ports :
      - " 8080:8080 "