飞书 CLI 画板功能:功能全景图

以下内容是用飞书 CLI 制作完成的飞书命令行工具完整使用手册,覆盖快速开始、常用模块、画板能力、权限和 FAQ。
一、快速开始
1.1 安装
npm install -g @larksuite/cli
npx skills add https://github.com/larksuite/cli -y -g1.2 初始化配置
lark-cli config init --new打开生成的链接,在飞书开发者后台完成应用配置。
1.3 用户登录
lark-cli auth login --domain calendar --domain im --domain docs1.4 身份切换
| 身份 | 标识 | 适用场景 |
|---|---|---|
| 用户身份 | --as user | 访问用户个人资源(日历、云空间等) |
| 应用身份 | --as bot | 应用级操作,访问 bot 自己的资源 |
二、19 个 Skills 功能模块
2.1 lark-doc — 云文档管理
核心功能:创建和编辑飞书文档、搜索云空间、插入媒体文件。
| 命令 | 说明 |
|---|---|
| docs +create | 创建新文档 |
| docs +fetch | 获取文档内容 |
| docs +update | 更新文档内容 |
| docs +search | 搜索云空间文档/表格 |
| docs +media-insert | 插入图片或文件 |
| docs +media-download | 下载文档媒体 |
示例:
# 创建文档
lark-cli docs +create --title "我的文档" --as user
# 搜索文档
lark-cli docs +search --query "项目计划" --as user2.2 lark-sheets — 电子表格
核心功能:创建和操作电子表格,读写数据,导出文件。
| 命令 | 说明 |
|---|---|
| sheets +create | 创建表格 |
| sheets +info | 获取表格信息 |
| sheets +read | 读取单元格 |
| sheets +write | 写入单元格 |
| sheets +append | 追加行数据 |
| sheets +find | 查找内容 |
| sheets +export | 导出表格 |
# 读取表格数据
lark-cli sheets +read --spreadsheet <token> --range "A1:D10" --as user2.3 lark-base — 多维表格
核心功能:管理多维表格,数据分析,工作流配置。
| 命令 | 说明 |
|---|---|
| base +table-list | 列出数据表 |
| base +field-list | 列出字段 |
| base +record-list | 列出记录 |
| base +record-upsert | 创建/更新记录 |
| base +data-query | 聚合分析查询 |
| base +workflow-create | 创建工作流 |
# 数据聚合分析
lark-cli base +data-query --base-token <token> --table-id <id> --json {...}2.4 lark-im — 即时通讯
核心功能:发送消息,管理群聊,搜索聊天记录。
| 命令 | 说明 |
|---|---|
| im +messages-send | 发送消息 |
| im +messages-reply | 回复消息 |
| im +messages-search | 搜索消息 |
| im +chat-create | 创建群聊 |
| im +chat-search | 搜索群聊 |
# 发送文本消息
lark-cli im +messages-send --chat-id <id> --text "Hello!" --as bot2.5 lark-calendar — 日历管理
核心功能:日程管理,忙闲查询,智能推荐会议时间。
| 命令 | 说明 |
|---|---|
| calendar +agenda | 查看日程安排 |
| calendar +create | 创建日程 |
| calendar +freebusy | 查询忙闲状态 |
| calendar +suggestion | 推荐空闲时段 |
# 查看今日日程
lark-cli calendar +agenda --as user
# 创建会议
lark-cli calendar +create --summary "项目评审" --start "2026-03-30T10:00:00+08:00" --end "2026-03-30T11:00:00+08:00" --as user2.6 lark-task — 任务管理
核心功能:创建任务,管理清单,分配成员。
| 命令 | 说明 |
|---|---|
| task +create | 创建任务 |
| task +update | 更新任务 |
| task +complete | 完成任务 |
| task +get-my-tasks | 获取我的任务 |
| task +tasklist-create | 创建任务清单 |
| task +assign | 分配成员 |
# 获取我的任务
lark-cli task +get-my-tasks --as user2.7 lark-mail — 邮箱管理
核心功能:收发邮件,管理草稿,处理附件。
| 命令 | 说明 |
|---|---|
| mail +triage | 查看收件箱摘要 |
| mail +message | 读取邮件 |
| mail +send | 发送邮件/保存草稿 |
| mail +reply | 回复邮件 |
| mail +forward | 转发邮件 |
# 查看收件箱
lark-cli mail +triage --as user2.8 lark-drive — 云空间
核心功能:文件上传下载,权限管理,评论。
| 命令 | 说明 |
|---|---|
| drive +upload | 上传文件 |
| drive +download | 下载文件 |
| drive +add-comment | 添加评论 |
2.9 lark-contact — 通讯录
核心功能:搜索用户,获取组织架构。
| 命令 | 说明 |
|---|---|
| contact +search-user | 搜索用户 |
| contact +get-user | 获取用户信息 |
# 获取当前用户信息
lark-cli contact +get-user --as user
# 搜索用户
lark-cli contact +search-user --query "张三" --as user2.10 lark-vc — 视频会议
核心功能:搜索会议记录,获取会议纪要。
| 命令 | 说明 |
|---|---|
| vc +search | 搜索历史会议 |
| vc +notes | 获取会议纪要 |
2.11 lark-minutes — 妙记
核心功能:获取妙记信息(标题、封面、时长)。
lark-cli minutes minutes get --params '{"minute_token": "<token>"}'2.12 lark-wiki — 知识库
核心功能:管理知识空间和文档节点。
lark-cli wiki spaces get_node --params '{"token":"<wiki_token>"}'2.13 lark-whiteboard — 画板
核心功能:绘制架构图、流程图、思维导图等。
支持图表类型:
- 架构图、组织架构图
- 流程图、时序图
- 思维导图、鱼骨图
- 柱状图、折线图、漏斗图
三、测试案例汇总
案例 1:查看今日日程
lark-cli calendar +agenda --as user结果:成功获取今日日程列表,包含会议主题、时间、参会人等信息。
案例 2:获取个人信息
lark-cli contact +get-user --as user结果:
{
"name": "AJ",
"open_id": "ou_cdac69cfe18cff7cd7122464207908b9"
}案例 3:获取我的任务
lark-cli task +get-my-tasks --as user结果:成功获取 26 条待办任务,包含任务标题、创建时间、截止日期等。
四、权限说明
使用不同功能需要相应的 scope 权限:
| 模块 | 常用权限 |
|---|---|
| 日历 | calendar:calendar:read, calendar:calendar.event:create |
| 消息 | im:message:readonly, im:chat:read |
| 文档 | docs:document:readonly, docx:document:create |
| 任务 | task:task:read, task:task:write |
| 通讯录 | contact:user.base:readonly |
五、常见问题
Q:遇到权限不足怎么办?
# 增量授权
lark-cli auth login --scope "calendar:calendar:read"Q:如何切换 user/bot 身份?
# 使用用户身份
lark-cli calendar +agenda --as user
# 使用应用身份
lark-cli im +messages-send --as botQ:Wiki 链接如何处理?
Wiki 链接需要先查询真实 token:
lark-cli wiki spaces get_node --params '{"token":"<wiki_token>"}'更多详情请参考:https://github.com/larksuite/cli
本文内容来源于飞书知识库。详细信息请参阅 原文链接。