feishu2md

使用指南

获取 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

如何使用

查阅帮助文档

$ 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 helpfor 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 <your_id> --appSecret <your_secret> 命令即可生成该工具的配置文件。

通过 feishu2md config 命令可以查看配置文件路径以及是否成功配置。

更多的配置选项请手动打开配置文件更改。

下载单个文档为 Markdown

通过 feishu2md dl <your feishu docx url> 直接下载，文档链接可以通过 分享 > 开启链接分享 > 互联网上获得链接的人可阅读 > 复制链接 获得。

示例：

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

批量下载某文件夹内的全部文档为 Markdown

此功能暂时不支持Docker版本

通过feishu2md dl --batch <your feishu folder url> 直接下载，文件夹链接可以通过 分享 > 开启链接分享 > 互联网上获得链接的人可阅读 > 复制链接 获得。

示例：

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

批量下载某知识库的全部文档为 Markdown

通过feishu2md dl --wiki <your feishu wiki setting url> 直接下载，wiki settings链接可以通过 打开知识库设置获得。

示例：

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

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

Docker 命令：docker run -it --rm -p 8080:8080 -e FEISHU_APP_ID=<your id> -e FEISHU_APP_SECRET=<your secret> -e GIN_MODE=release wwwsine/feishu2md

Docker Compose:

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

启动服务 docker compose up -d

然后访问 https://127.0.0.1:8080 粘贴文档链接即可，文档链接可以通过 分享 > 开启链接分享 > 复制链接 获得。

我使用个人的测试 API Token 部署了一个 Unstable 版本在 Render 平台上，该版本不会保存任何的文档资料和图片在容器中，直接通过 HTTP 从内存中返回压缩包文件，但是 Render 平台的 Log 可能会记录一些 HTTP 信息。

在版本仅供不在意隐私或懒于配置的用户临时使用，也可用于测试对比是否自己的 Token 权限配置有问题。Render 平台使用免费配额，仅有 512M 内存，不保证高可用性，信任链全靠开源代码，请自行斟酌。

访问 https://feishu2md.onrender.com/ 粘贴文档链接即可，文档链接可以通过 分享 > 开启链接分享 > 复制链接 获得。