如何使用飞书 CLI?图文教程

feishu-cli 是一个功能完整的飞书开放平台命令行工具。它的核心作用,是将飞书复杂的 API 操作,封装成一行行简洁的命令,让我们可以在终端里直接管理飞书的各项事务。

用 Apifox,节省研发团队的每一分钟

如何使用飞书 CLI?图文教程

免费使用 Apifox

相关推荐

最新文章

API

一体化协作平台

API 设计

API 文档

API 调试

自动化测试

API Mock

API Hub

立即体验 Apifox
目录

feishu-cli 是一个功能完整的飞书开放平台命令行工具。

 

它的核心作用,是将飞书复杂的 API 操作,封装成一行行简洁的命令,让我们可以在终端里直接管理飞书的各项事务。

 

其中最亮眼的功能,是实现了 Markdown 与飞书文档的双向无损转换。

 

这种转换支持标题、列表、代码块、表格、图片等超过 40 种内容块,基本实现了「无损」转换,确保了内容的完整性。

 

AI Coding 交流群

如果你也在用 AI 写代码,或者正在研究 Cursor、Claude Code 这些工具,欢迎加入以下交流群。群里平时会聊一些 AI 编程的实际用法、开发工作流,还有各种新工具和新玩法。

 

从零开始的安装与配置

要使用这个工具,需要先完成一些基础的准备工作。

 

第一步是安装。

 

无论是首次安装还是后续更新,feishu-cli 都提供了一键安装脚本,可以自动识别操作系统并完成安装。

 

在系统终端运行以下命令,或者把命令丢给 AI,让 AI 给你安装:

curl -fsSL https://raw.githubusercontent.com/riba2534/feishu-cli/main/install.sh | bash
使用飞书 CLI

 

安装完成后,需要一个飞书应用来获取操作凭证。

 

这需要在「飞书开放平台」创建一个企业自建应用,地址:https://open.feishu.cn/app。

使用飞书 CLI

创建成功后,就能在应用详情页找到关键的 App ID 和 App Secret。

使用飞书 CLI

拿到凭证后,需要让 feishu-cli 知道它们。

 

推荐的方式是使用环境变量,在终端中执行以下命令:

export FEISHU_APP_ID="cli_xxx"export FEISHU_APP_SECRET="xxx"

另一种方式是通过配置文件。

   

执行 feishu-cli config init 会在本地生成一个配置文件,将凭证填入即可。

     

接下来是为应用配置权限。

 

应用能做什么,完全取决于我们赋予它哪些权限,在「权限管理」中开通即可。

使用飞书 CLI

feishu-cli 的文档提供了详细的权限列表,可以根据需要添加。例如,文档读写需要 docx:document 权限,发送消息需要 im:message 权限。

   

所有准备工作就绪后,可以运行一条简单的命令来测试配置是否成功。

feishu-cli doc create --title "Hello Feishu"

 

如果命令返回了一个文档 ID,就说明我们的 feishu-cli 已经可以正常工作了。

使用飞书 CLI

   

强大的文档处理能力

feishu-cli 在处理 Markdown 文档时,远不止是简单的文本转换。

 

它能智能地处理图表。

 

当 Markdown 文件中包含 Mermaid 或 PlantUML 代码块时,工具会自动将它们转换为飞书中的「画板」。

flowchart TD  A[开始] --> B{判断}  B -->|是| C[处理]  B -->|否| D[结束]

   

导入的图表不再是静态的截图,而是可以在飞书里直接编辑的矢量图形,支持流程图、时序图、类图等多种类型。

 

对于表格,feishu-cli 同样考虑周到。

 

它会根据内容智能计算列宽,并且当表格行数过多(飞书 API 限制为 9 行)时,会自动拆分成多个表格,并贴心地保留表头。

 

在处理包含大量图表和表格的大型文档时,为了最大化效率,feishu-cli 采用了三阶段并发管道架构。

 

这个架构会先按顺序创建所有基础内容块,然后并发处理耗时较长的图表和表格任务,最后再处理失败的图表,将其降级为代码块以保证导入的完整性。

   

我们还可以通过参数调整并发数。

feishu-cli doc import large-doc.md --title "大文档" \--diagram-workers 5 --table-workers 3 --verbose

解锁 AI 的力量:集成 Claude Code

feishu-cli 最大的惊喜,在于它为 AI Agent 铺平了道路。

 

它为 Claude Code 这一先进的 AI 编程助手,提供了 11 个开箱即用的「技能」文件。

   

这些技能文件本质上是 feishu-cli 命令的封装,让 Claude 能够理解并执行操作飞书的指令。

 

安装这些技能非常简单,只需要一条命令。

npx skills add riba2534/feishu-cli --global --yes --agent claude-code --copy

 

安装完成后,就可以用自然语言来指挥 Claude 操作飞书了。

 

比如,可以对 Claude 说:「帮我创建一个新的飞书文档,标题是‘周会纪要’」,它会调用 feishu-cli-write 技能来完成。

使用飞书 CLI

或者,「把这个飞书文档的链接分享给张三」,它会调用 feishu-cli-perm 技能来管理权限(需要先完成 OAuth 用户授权)。

   

甚至可以发出更复杂的指令,比如「读取这个飞书文档的内容,优化一下当前的内容并写回去」,AI 会调用 feishu-cli-toolkit 来实现。

使用飞书 CLI

从读写文档到发送消息,再到绘制图表,AI Agent 摇身一变成为了我们的飞书专属助理。

 

完整的飞书生态控制

feishu-cli 的能力覆盖了飞书的绝大部分核心功能。

 

除了文档,它还提供了 wiki(知识库)、sheet(电子表格)、msg(消息)、chat(群聊)、calendar(日历)、task(任务)等一系列命令。

 

这意味着无论是管理知识库节点,还是读写电子表格数据,或是创建日历日程,都可以通过命令行完成自动化。

 

某些功能,如搜索个人云空间中的文档或消息,需要以用户身份进行操作。

 

为此,feishu-cli 提供了 OAuth 用户授权流程。首先需要在飞书开放平台的应用安全设置中,配置一个重定向 URL:http://127.0.0.1:9768/callback。

 

然后执行 feishu-cli auth login 命令,工具会自动打开浏览器引导我们完成登录授权。

 

授权成功后,feishu-cli 就能获得一个 User Access Token,从而可以执行搜索等需要用户身份的敏感操作,真正实现了对飞书生态的全面操控。

   

快去玩玩吧!

开发必备:API 全流程管理神器 Apifox

介绍完上文的内容,我想额外介绍一个对开发者同样重要的效率工具 —— Apifox。作为一个集 API 文档、调试、设计、测试、Mock、自动化测试于一体的工具,Apifox 是目前提升研发效率的首选。

如果你正在开发项目,不妨试试其极其友好的界面设计,它完全兼容 Postman 和 Swagger 数据格式,导入数据非常方便,,即使是新手也能很快上手,点击这里即可注册使用

Apifox

值得一提的是,除了个人和常规团队使用,针对有高安全合规要求、或需要在内网环境协作的企业,Apifox 还提供了深度定制的私有化部署方案

获取专属报价与部署方案

icon 详细的私有化部署系统架构与安全白皮书
icon 针对您公司规模的专属报价单
icon 免费的 1v1 专属产品演示 (Demo) 机会
获取部署方案
* 提交后,我们的客户经理将在 1 个工作日内与您联系
林俊锋 企业微信
@Apifox 专属顾问
扫码备注: 私有化 + 公司名