关于 feishu-docs
feishu-docs 是一项通过 feishu-doc CLI 在终端搜索和阅读飞书开发者文档的技能,也支持浏览文档树并以 Markdown 输出内容。
主要功能
- 01按标题搜索文档
- 02以 Markdown 阅读文档
- 03浏览文档树
- 04按路径查看子树
- 05使用 --lang en 获取英文内容
适用场景
- 01查找飞书 API 参考文档
- 02在终端阅读开发指南
- 03按类别浏览文档
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ m1heng/ feishu-doc-cli --skill feishu-docs安装后在 Claude Code 中输入/feishu-docs确认已加载。
详细介绍
飞书开放平台文档
通过 feishu-doc CLI 直接在终端中阅读飞书开发者文档。
前提条件
安装一次即可(需要 Node.js >= 18):
npm install -g feishu-doc-cli
命令
feishu-doc search "<keyword>" # Search docs by title
feishu-doc read "<path>" # Read a document (outputs Markdown)
feishu-doc tree --depth 2 # Browse the doc tree
feishu-doc tree "<path>" # Browse a subtree
添加 --lang en 以使用英文。
工作流
-
从
search开始,查找相关文档:feishu-doc search "知识库" -
使用搜索结果中的路径阅读文档:
feishu-doc read "/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-overview" -
跟进链接——文档内容包含各种格式的链接。复制任意链接 href 并直接传给
read:# All these formats work — just copy the href as-is: feishu-doc read "/ssl:ttdoc/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/list" feishu-doc read "https://open.feishu.cn/document/client-docs/intro" feishu-doc read "https://open.larkoffice.com/document/client-docs/bot-v3/bot-overview" -
按类别浏览,以探索某个领域:
feishu-doc tree "/uAjLw4CM/ukTMukTMukTM" --depth 2 # Server APIs
顶级文档类别
| 类别 | 树路径 |
|---|---|
| 开发者指南 | /uAjLw4CM/ukzMukzMukzM |
| 开发者教程 | /uAjLw4CM/uMzNwEjLzcDMx4yM3ATM |
| 服务端 API | /uAjLw4CM/ukTMukTMukTM |
| 客户端 API | /uAjLw4CM/uYjL24iN |
| MCP | /mcp_open_tools |
评论
支持 Markdown