飞书文档导出服务安装和配置指南

飞书文档导出服务安装和配置指南

feishu-doc-export 项目地址: https://gitcode.com/gh_mirrors/fe/feishu-doc-export

1. 项目基础介绍和主要编程语言

项目基础介绍

feishu-doc-export 是一个开源项目，旨在提供一个简单易用的工具，帮助用户将飞书知识库中的文档一键导出到本地电脑。该项目支持Windows、Mac和Linux系统，支持导出markdown、docx和pdf三种格式。

主要编程语言

该项目主要使用C#语言进行开发。

2. 项目使用的关键技术和框架

关键技术

• .NET Core: 该项目基于.NET Core框架开发，支持跨平台运行。
• 飞书API: 使用飞书提供的API进行文档的获取和导出。

框架

• .NET Core: 提供了跨平台的开发和运行环境。

3. 项目安装和配置的准备工作和详细安装步骤

准备工作

1. 安装.NET Core SDK: 确保你的系统上已经安装了.NET Core SDK。你可以从.NET Core官网下载并安装。
2. 获取飞书开发者权限: 你需要在飞书开发者后台创建一个企业自建应用，并获取AppId和AppSecret。

详细安装步骤

步骤1：下载项目

1. 打开终端或命令提示符。
2. 使用以下命令克隆项目到本地：

   git clone https://github.com/xhnbzdl/feishu-doc-export.git
   

步骤2：配置飞书开发者权限

1. 进入飞书开发者后台，创建一个企业自建应用。
2. 在应用的后台管理页，打开权限管理，开通以下权限：
   • 查看新版文档
   • 查看、评论和下载云空间中所有文件
   • 查看、评论和导出文档
   • 查看、评论、编辑和管理云空间中所有文件
   • 查看、评论、编辑和管理多维表格
   • 查看、编辑和管理知识库
   • 查看、评论、编辑和管理电子表格
   • 导出云文档
3. 在添加应用能力中，添加机器人。
4. 在版本管理与发布中创建一个版本，并申请发布上线。
5. 等待企业管理员审核通过。

步骤3：获取AppId和AppSecret

1. 在飞书开发者后台，打开凭证与基础信息，获取App ID和App Secret。

步骤4：配置项目

1. 打开项目目录，找到appsettings.json文件。
2. 在文件中添加以下配置：

   {
     "AppId": "你的AppId",
     "AppSecret": "你的AppSecret",
     "ExportPath": "导出文档的目录路径"
   }
   

步骤5：运行项目

1. 在终端或命令提示符中，导航到项目目录。
2. 使用以下命令运行项目：

   dotnet run
   

步骤6：导出文档

1. 项目运行后，程序会自动根据配置导出飞书知识库中的文档到指定目录。
2. 你可以通过修改appsettings.json中的ExportPath来更改导出目录。

注意事项

• 在Mac和Linux系统上，首次运行时需要将文件授权为可执行文件：

  sudo chmod +x /path/to/feishu-doc-export
  

• 在Mac系统上，可能会出现不受信任的执行程序，需要手动覆盖“隐私与安全性”设置中的设置。

通过以上步骤，你就可以成功安装和配置feishu-doc-export项目，并开始导出飞书文档了。

feishu-doc-export 项目地址: https://gitcode.com/gh_mirrors/fe/feishu-doc-export