feishu-docs

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Feishu Open Platform Docs

飞书开放平台文档

Read Feishu developer documentation directly from the terminal via

feishu-doc

CLI.

通过

feishu-doc

CLI直接在终端中查阅飞书开发者文档。

Prerequisites

前提条件

Install once (requires Node.js >= 18):

bash

npm install -g feishu-doc-cli

只需安装一次（要求Node.js >= 18）：

bash

npm install -g feishu-doc-cli

Commands

命令

bash

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

Add

--lang en

for English.

bash

feishu-doc search "<关键词>"     # 按标题搜索文档
feishu-doc read "<路径>"          # 阅读文档（输出Markdown格式内容）
feishu-doc tree --depth 2         # 浏览文档树
feishu-doc tree "<路径>"          # 浏览子文档树

添加

--lang en

参数可切换为英文版本。

Workflow

使用流程

Start with
search
to find relevant documents:
bash
```
feishu-doc search "知识库"
```

Read a document using the path from search results:

bash

feishu-doc read "/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-overview"

Follow links — document content contains links in various formats. Copy any link href and pass it directly to

read

bash

# 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"

Browse by category if you need to explore an area:

bash

feishu-doc tree "/uAjLw4CM/ukTMukTMukTM" --depth 2   # Server APIs

先使用
search
命令查找相关文档：
bash
```
feishu-doc search "知识库"
```

使用搜索结果中的路径阅读文档：

bash

feishu-doc read "/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-overview"

跟随链接 —— 文档内容包含多种格式的链接。直接复制链接的href并传入

read

命令即可：

bash

# 以下格式均支持 —— 直接原样复制href即可：
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"

若需要探索特定领域，可按分类浏览：

bash

feishu-doc tree "/uAjLw4CM/ukTMukTMukTM" --depth 2   # 服务端API

Top-level doc categories

顶级文档分类

Category	Tree path
Developer Guides	`/uAjLw4CM/ukzMukzMukzM`
Developer Tutorials	`/uAjLw4CM/uMzNwEjLzcDMx4yM3ATM`
Server API	`/uAjLw4CM/ukTMukTMukTM`
Client API	`/uAjLw4CM/uYjL24iN`
MCP	`/mcp_open_tools`

分类	文档树路径
开发者指南	`/uAjLw4CM/ukzMukzMukzM`
开发者教程	`/uAjLw4CM/uMzNwEjLzcDMx4yM3ATM`
服务端API	`/uAjLw4CM/ukTMukTMukTM`
客户端API	`/uAjLw4CM/uYjL24iN`
MCP	`/mcp_open_tools`