关于 feishu-doc-reader
feishu-doc-reader 是一项命令行技能,通过官方 Open API 提取飞书和 Lark 文档内容。它支持 wiki 链接与令牌,并可按服务区域配置。
主要功能
- 01将 Docx 内容提取为 Markdown
- 02读取旧版 Doc 和 Sheet 内容
- 03解析 wiki 链接与令牌
- 04获取原始文档块
- 05配置飞书或 Lark API 访问
适用场景
- 01提取飞书或 Lark Docx 内容
- 02读取 Sheet 中的表格数据
- 03将 wiki 页面解析为对应文档
- 04检查文档的原始内容块
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ zhangyongcun/ feishu-doc-reader --skill feishu-doc-reader安装后在 Claude Code 中输入/feishu-doc-reader确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
README.md.gitignoreCONTRIBUTING.mdrequirements.txtUSAGE_EXAMPLES.mdINTEGRATION.mdtest_optimization.pyreference/feishu_config_sample.jsonscripts/get_blocks.shpackage_skill.pyget_feishu_doc_blocks.pyread_doc.shtest_blocks_integration.pytest_auth.pyread_feishu_doc.py详细介绍
飞书/Lark 文档读取器
使用官方 Open API 读取并提取飞书(飞书)和 Lark 文档内容。支持中国飞书(open.feishu.cn)和国际版 Lark(open.larksuite.com)。
配置
设置凭据
- 根据示例创建
./reference/feishu_config.json:
{
"app_id": "your_feishu_app_id",
"app_secret": "your_feishu_app_secret",
"api_base": "https://open.larksuite.com"
}
将 api_base 设置为:
https://open.feishu.cn— 中国飞书https://open.larksuite.com— 国际版 Lark
- 保护文件:
chmod 600 ./reference/feishu_config.json
也可以使用环境变量:FEISHU_APP_ID、FEISHU_APP_SECRET、FEISHU_API_BASE。
用法
读取文档
主脚本接受知识库 URL、知识库令牌或文档令牌:
# Wiki URL (auto-extracts token and resolves to document)
python scripts/read_feishu_doc.py "https://tenant.larksuite.com/wiki/XYZ123"
# Wiki token (auto-resolves)
python scripts/read_feishu_doc.py "XYZ123"
# Document token (direct)
python scripts/read_feishu_doc.py "docx_AbCdEfGh"
# Simplified Markdown output
python scripts/read_feishu_doc.py "docx_AbCdEfGh" --format simple
# Read a spreadsheet
python scripts/read_feishu_doc.py "sheet_token" --type sheet
获取原始文档块
python scripts/get_feishu_doc_blocks.py "docx_AbCdEfGh"
Shell 封装脚本
./scripts/read_doc.sh "docx_token"
./scripts/get_blocks.sh "docx_token"
测试身份验证
python scripts/test_auth.py "app_id" "app_secret" "https://open.larksuite.com"
支持的文档类型
- Docx(新文档):完整提取为 Markdown,包含表格、标题、代码和列表
- Doc(旧版):基本元数据和内容
- Sheet:提取电子表格数据
- Wiki:通过 wiki API 自动解析为底层文档类型
所需 API 权限
docx:document:readonly— 读取文档内容wiki:wiki:readonly— 读取知识库页面(支持知识库 URL/令牌)sheets:spreadsheet:readonly— 读取电子表格(可选)
错误处理
- 401:检查 App ID / App Secret
- 403:授予 API 权限;确保文档已与应用共享
- 404:验证文档令牌
- 区域错误:国际版 Lark 请使用
open.larksuite.com
安全
- 切勿提交
reference/feishu_config.json(已列入.gitignore) - 对凭据文件使用
chmod 600 - 访问令牌仅缓存在内存中
评论
支持 Markdown