Wsine / feishu2md

一键命令下载飞书文档为 Markdown
https://feishu2md.onrender.com/
MIT License
1.19k stars 123 forks source link
feishu lark markdown

feishu2md

Golang - feishu2md Unittest Release Docker - feishu2md Render - feishu2md Last Review

这是一个下载飞书文档为 Markdown 文件的工具,使用 Go 语言实现。

请看这里:招募有需求和有兴趣的开发者,共同探讨开发维护,有兴趣请联系。

动机

《一日一技 | 我开发的这款小工具,轻松助你将飞书文档转为 Markdown》

获取 API Token

配置文件需要填写 APP ID 和 APP SECRET 信息,请参考 飞书官方文档 获取。推荐设置为

如何使用

注意:飞书旧版文档的下载工具已决定不再维护,但分支 v1_support 仍可使用,对应的归档为 v1.4.0,请知悉。

命令行版本 借助 Go 语言跨平台的特性,已编译好了主要平台的可执行文件,可以在 [Release](https://github.com/Wsine/feishu2md/releases) 中下载,并将相应平台的 feishu2md 可执行文件放置在 PATH 路径中即可。 **查阅帮助文档** ```bash $ 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] 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 ` 直接下载,文档链接可以通过 **分享 > 开启链接分享 > 互联网上获得链接的人可阅读 > 复制链接** 获得。 示例: ```bash $ feishu2md dl "https://domain.feishu.cn/docx/docxtoken" ``` **批量下载某文件夹内的全部文档为 Markdown** 此功能暂时不支持Docker版本 通过`feishu2md dl --batch ` 直接下载,文件夹链接可以通过 **分享 > 开启链接分享 > 互联网上获得链接的人可阅读 > 复制链接** 获得。 示例: ```bash $ feishu2md dl --batch -o output_directory "https://domain.feishu.cn/drive/folder/foldertoken" ``` **批量下载某知识库的全部文档为 Markdown** 通过`feishu2md dl --wiki ` 直接下载,wiki settings链接可以通过 打开知识库设置获得。 示例: ```bash $ 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: ```yml # docker-compose.yml version: '3' services: feishu2md: image: wwwsine/feishu2md environment: FEISHU_APP_ID: FEISHU_APP_SECRET: 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/ 粘贴文档链接即可,文档链接可以通过 **分享 > 开启链接分享 > 复制链接** 获得。

感谢