概述lark-cli是飞书/Lark 开放平台的官方命令行工具提供对日历、消息、联系人、文档、云文档、多维表格、任务、视频会议、邮件等核心能力的命令行操作支持。官方仓库: https://github.com/larksuite/cli安装通过 npm 安装npm install -g larksuite/cli验证安装lark-cli --version lark-cli --help快速开始1. 初始化配置# 交互式初始化 lark-cli config init # 或通过环境变量/ stdin 传入 app credentials2. 身份认证# Device Flow 授权登录 lark-cli auth login # 查看当前认证状态 lark-cli auth status # 查看已登录用户列表 lark-cli auth list # 登出 lark-cli auth logout3. 健康检查# 检查配置、认证和网络连接 lark-cli doctor # 离线检查跳过网络检测 lark-cli doctor --offline核心命令通用参数参数说明--as type身份类型:user(用户) /bot(机器人) /auto(自动)--format fmt输出格式:json(默认) /ndjson/table/csv/pretty--params jsonURL 查询参数 (JSON 格式)--data json请求体 (POST/PATCH/PUT/DELETE)--page-all自动翻页获取所有数据--page-size N每页数量--page-limit N最大页数限制 (默认 10, 0 为无限制)--page-delay MS翻页间隔毫秒 (默认 200)--dry-run仅打印请求不执行-o, --output path输出文件路径 (用于二进制响应)日历 (calendar)日历快捷命令# 查看今日日程 lark-cli calendar agenda # 创建日程 lark-cli calendar create --params {title:会议} # 查询用户忙闲 lark-cli calendar freebusy --params {user_ids:[user_id]} # 智能推荐会议时间 lark-cli calendar suggestion --params {user_ids:[user_id],duration:3600}日历子命令lark-cli calendar calendars # 日历管理 lark-cli calendar events # 日程管理 lark-cli calendar event.attendees # 参会人管理 lark-cli calendar freebusys # 忙闲查询日程 CRUD# 创建日程 lark-cli calendar events create --params {} --data { calendar_id: primary, summary: 会议标题, description: 会议描述, start_time: {timestamp: 1699999999}, end_time: {timestamp: 1700003599} } # 获取日程 lark-cli calendar events get --params {calendar_id:primary,event_id:xxx} # 更新日程 lark-cli calendar events patch --params {calendar_id:primary,event_id:xxx} --data {} # 删除日程 lark-cli calendar events delete --params {calendar_id:primary,event_id:xxx} # 搜索日程 lark-cli calendar events search --params {query:关键词} # 查询日程实例重复日程 lark-cli calendar events instance_view --params {calendar_id:primary,event_id:xxx}消息 (im)消息快捷命令# 创建群聊 lark-cli im chat-create --params {name:群名称,user_ids:[user_id]} # 搜索群聊 lark-cli im chat-search --params {query:群名称} # 更新群聊信息 lark-cli im chat-update --params {chat_id:xxx} --data {name:新名称} # 列出消息 lark-cli im chat-messages-list --params {chat_id:xxx} # 发送消息 lark-cli im messages-send --params {receive_id:user_id,msg_type:text} --data {content:{\text\:\消息内容\}} # 回复消息 lark-cli im messages-reply --params {message_id:xxx} --data {content:{\text\:\回复\},msg_type:text} # 搜索消息 lark-cli im messages-search --params {query:关键词} # 批量获取消息 lark-cli im messages-mget --params {message_ids:[om_xxx]} # 下载消息资源 lark-cli im messages-resources-download --params {message_id:xxx,file_key:xxx} # 列出线程消息 lark-cli im threads-messages-list --params {thread_id:xxx}消息子命令lark-cli im chats # 群聊管理 lark-cli im chat.members # 群成员管理 lark-cli im messages # 消息管理 lark-cli im images # 图片管理 lark-cli im pins # 置顶管理 lark-cli im reactions # 表情管理消息操作# 撤回消息 lark-cli im messages delete --params {message_id:om_xxx} # 转发消息 lark-cli im messages forward --params {message_id:om_xxx,chat_id:xxx} # 合并转发 lark-cli im messages merge_forward --params {message_ids:[om_xxx],chat_id:xxx} # 查询已读用户 lark-cli im messages read_users --params {message_id:om_xxx}联系人 (contact)联系人快捷命令# 获取用户信息不传 user_id 获取自身信息 lark-cli contact get-user --params {user_id:ou_xxx} # 搜索用户 lark-cli contact search-user --params {query:姓名关键词}文档 (docs)文档快捷命令# 创建文档 lark-cli docs create # 获取文档内容 lark-cli docs fetch --params {document_id:xxx} # 搜索文档 lark-cli docs search --params {query:关键词} # 更新文档 lark-cli docs update --params {document_id:xxx} --data {} # 文档媒体下载 lark-cli docs media-download --params {file_key:xxx,token:xxx} # 文档媒体插入 lark-cli docs media-insert --params {document_id:xxx} --data {file_path:./image.png} # 白板更新 lark-cli docs whiteboard-update --params {document_id:xxx}云文档/网盘 (drive)云文档快捷命令# 添加评论 lark-cli drive add-comment --params {file_token:xxx} --data {content:评论内容} # 下载文件 lark-cli drive download --params {file_token:xxx} -o ./output # 上传文件 lark-cli drive upload --params {file_name:test.txt,parent_type:explorer,parent_node:xxx} -o ./test.txt云文档子命令lark-cli drive files # 文件管理 lark-cli drive metas # 元数据管理 lark-cli drive user # 用户操作 lark-cli drive permission.members # 权限管理 lark-cli drive file.comments # 评论管理 lark-cli drive file.comment.replys # 评论回复多维表格 (base)多维表格快捷命令# 创建多维表格 lark-cli base base-create # 获取多维表格 lark-cli base base-get --params {scope_type:bitable,scope_id:xxx} # 复制多维表格 lark-cli base base-copy --params {bitable_id:xxx} # 数据查询 lark-cli base data-query --params {bitable_id:xxx,table_id:tbl_xxx} --data {}表格操作# 列出表格 lark-cli base table-list --params {bitable_id:xxx} # 创建表格 lark-cli base table-create --params {bitable_id:xxx} --data {fields:[{field_name:名称}]} # 获取表格 lark-cli base table-get --params {bitable_id:xxx,table_id:tbl_xxx} # 更新表格 lark-cli base table-update --params {bitable_id:xxx,table_id:tbl_xxx} --data {} # 删除表格 lark-cli base table-delete --params {bitable_id:xxx,table_id:tbl_xxx}字段操作# 列出字段 lark-cli base field-list --params {bitable_id:xxx,table_id:tbl_xxx} # 创建字段 lark-cli base field-create --params {bitable_id:xxx,table_id:tbl_xxx} --data {field_name:新字段,type:1} # 获取字段 lark-cli base field-get --params {bitable_id:xxx,table_id:tbl_xxx,field_id:fld_xxx} # 更新字段 lark-cli base field-update --params {bitable_id:xxx,table_id:tbl_xxx,field_id:fld_xxx} --data {} # 删除字段 lark-cli base field-delete --params {bitable_id:xxx,table_id:tbl_xxx,field_id:fld_xxx} # 搜索选项 lark-cli base field-search-options --params {bitable_id:xxx,table_id:tbl_xxx,field_id:fld_xxx}记录操作# 列出记录 lark-cli base record-list --params {bitable_id:xxx,table_id:tbl_xxx} # 获取记录 lark-cli base record-get --params {bitable_id:xxx,table_id:tbl_xxx,record_id:rec_xxx} # 创建/更新记录 lark-cli base record-upsert --params {bitable_id:xxx,table_id:tbl_xxx} --data {fields:{名称:值}} # 删除记录 lark-cli base record-delete --params {bitable_id:xxx,table_id:tbl_xxx,record_id:rec_xxx} # 上传附件 lark-cli base record-upload-attachment --params {bitable_id:xxx,table_id:tbl_xxx,record_id:rec_xxx,field_id:fld_xxx} # 记录历史 lark-cli base record-history-list --params {bitable_id:xxx,table_id:tbl_xxx,record_id:rec_xxx}视图操作# 列出视图 lark-cli base view-list --params {bitable_id:xxx,table_id:tbl_xxx} # 创建视图 lark-cli base view-create --params {bitable_id:xxx,table_id:tbl_xxx} --data {view_name:新视图,view_type:1} # 获取视图 lark-cli base view-get --params {bitable_id:xxx,table_id:tbl_xxx,view_id:viw_xxx} # 重命名视图 lark-cli base view-rename --params {bitable_id:xxx,table_id:tbl_xxx,view_id:viw_xxx} # 删除视图 lark-cli base view-delete --params {bitable_id:xxx,table_id:tbl_xxx,view_id:viw_xxx} # 获取/设置视图过滤、排序、分组等配置 lark-cli base view-get-filter lark-cli base view-set-filter lark-cli base view-get-sort lark-cli base view-set-sort lark-cli base view-get-group lark-cli base view-set-group lark-cli base view-get-card lark-cli base view-set-card lark-cli base view-get-timebar lark-cli base view-set-timebarDashboard 操作lark-cli base dashboard-list --params {bitable_id:xxx} lark-cli base dashboard-get --params {bitable_id:xxx,dashboard_id:xxx} lark-cli base dashboard-create --params {bitable_id:xxx} lark-cli base dashboard-update --params {bitable_id:xxx,dashboard_id:xxx} lark-cli base dashboard-delete --params {bitable_id:xxx,dashboard_id:xxx} lark-cli base dashboard-block-list --params {bitable_id:xxx,dashboard_id:xxx} lark-cli base dashboard-block-get --params {bitable_id:xxx,dashboard_id:xxx,block_id:xxx} lark-cli base dashboard-block-create --params {bitable_id:xxx,dashboard_id:xxx} lark-cli base dashboard-block-update --params {bitable_id:xxx,dashboard_id:xxx,block_id:xxx} lark-cli base dashboard-block-delete --params {bitable_id:xxx,dashboard_id:xxx,block_id:xxx}表单操作lark-cli base form-list --params {bitable_id:xxx,table_id:tbl_xxx} lark-cli base form-get --params {bitable_id:xxx,table_id:tbl_xxx,form_id:xxx} lark-cli base form-create --params {bitable_id:xxx,table_id:tbl_xxx} lark-cli base form-update --params {bitable_id:xxx,table_id:tbl_xxx,form_id:xxx} lark-cli base form-delete --params {bitable_id:xxx,table_id:tbl_xxx,form_id:xxx} lark-cli base form-questions-list --params {bitable_id:xxx,table_id:tbl_xxx,form_id:xxx} lark-cli base form-questions-create --params {bitable_id:xxx,table_id:tbl_xxx,form_id:xxx} lark-cli base form-questions-update --params {bitable_id:xxx,table_id:tbl_xxx,form_id:xxx,question_id:xxx} lark-cli base form-questions-delete --params {bitable_id:xxx,table_id:tbl_xxx,form_id:xxx,question_id:xxx}工作流操作lark-cli base workflow-list --params {bitable_id:xxx} lark-cli base workflow-get --params {bitable_id:xxx,workflow_id:xxx} lark-cli base workflow-create --params {bitable_id:xxx} lark-cli base workflow-update --params {bitable_id:xxx,workflow_id:xxx} lark-cli base workflow-enable --params {bitable_id:xxx,workflow_id:xxx} lark-cli base workflow-disable --params {bitable_id:xxx,workflow_id:xxx}权限与角色# 高级权限 lark-cli base advperm-enable --params {bitable_id:xxx} lark-cli base advperm-disable --params {bitable_id:xxx} # 角色管理 lark-cli base role-list --params {bitable_id:xxx} lark-cli base role-get --params {bitable_id:xxx,role_id:xxx} lark-cli base role-create --params {bitable_id:xxx} --data {role_name:新角色} lark-cli base role-update --params {bitable_id:xxx,role_id:xxx} --data {} lark-cli base role-delete --params {bitable_id:xxx,role_id:xxx}表格 (sheets)表格快捷命令# 创建表格 lark-cli sheets create # 获取表格信息 lark-cli sheets info --params {spreadsheet_token:xxx} # 读取数据 lark-cli sheets read --params {spreadsheet_token:xxx,range:Sheet1!A1:C10} # 写入数据 lark-cli sheets write --params {spreadsheet_token:xxx,range:Sheet1!A1} --data {values:[[值1,值2]]} # 追加行 lark-cli sheets append --params {spreadsheet_token:xxx,range:Sheet1!A1} --data {values:[[值]]} # 查找 lark-cli sheets find --params {spreadsheet_token:xxx} --data {value:搜索内容} # 导出 lark-cli sheets export --params {token:xxx}表格子命令lark-cli sheets spreadsheets # 表格管理 lark-cli sheets spreadsheet.sheets # 工作表管理 lark-cli sheets spreadsheet.sheet.filters # 筛选管理任务 (task)任务快捷命令# 获取我的任务 lark-cli task get-my-tasks # 创建任务 lark-cli task create --data { title: 任务标题, due: {timestamp: 1699999999} } # 完成任务 lark-cli task complete --params {task_id:xxx} # 重新打开任务 lark-cli task reopen --params {task_id:xxx} # 更新任务 lark-cli task update --params {task_id:xxx} --data {title:新标题} # 指派成员 lark-cli task assign --params {task_id:xxx} --data {members:[{id:user_id,type:user}]} # 添加关注者 lark-cli task followers --params {task_id:xxx} --data {followers:[{id:user_id,type:user}]} # 添加评论 lark-cli task comment --params {task_id:xxx} --data {content:评论内容} # 设置提醒 lark-cli task reminder --params {task_id:xxx} --data {is_reminder:true,due_at:1699999999} # 创建任务清单 lark-cli task tasklist-create --data {name:清单名称} # 任务清单添加任务 lark-cli task tasklist-task-add --params {tasklist_id:xxx,task_id:xxx} # 管理任务清单成员 lark-cli task tasklist-members --params {tasklist_id:xxx} --data {}任务子命令lark-cli task tasks # 任务管理 lark-cli task tasklists # 任务清单管理 lark-cli task subtasks # 子任务管理 lark-cli task members # 成员管理Wiki# Wiki 空间管理 lark-cli wiki spaces视频会议 (vc)视频会议快捷命令# 搜索会议 lark-cli vc search --params {query:关键词} # 获取会议纪要 lark-cli vc notes --params {meeting_id:xxx}视频会议子命令lark-cli vc meeting # 会议管理邮件 (mail)邮件快捷命令# 发送邮件 lark-cli mail send --params {receive_id:userexample.com} --data {subject:标题,content:正文} # 回复邮件 lark-cli mail reply --params {message_id:xxx} # 回复全部 lark-cli mail reply-all --params {message_id:xxx} # 转发邮件 lark-cli mail forward --params {message_id:xxx,receive_id:userexample.com} # 创建草稿 lark-cli mail draft-create --data {subject:标题} # 编辑草稿 lark-cli mail draft-edit --params {draft_id:xxx} # 读取邮件 lark-cli mail message --params {message_id:xxx} # 批量读取邮件 lark-cli mail messages --params {message_ids:[xxx]} # 读取邮件线程 lark-cli mail thread --params {thread_id:xxx} # 邮件列表/搜索 lark-cli mail triage --params {query:关键词} # 监听新邮件 lark-cli mail watch邮件子命令lark-cli mail user_mailbox.drafts # 草稿管理 lark-cli mail user_mailbox.folders # 文件夹管理 lark-cli mail user_mailbox.labels # 标签管理 lark-cli mail user_mailbox.messages # 消息管理 lark-cli mail user_mailbox.threads # 线程管理 lark-cli mail user_mailbox.mail_contacts # 邮件联系人 lark-cli mail user_mailbox.message.attachments # 附件管理 lark-cli mail user_mailbox.event # 事件订阅 lark-cli mail user_mailboxes # 邮箱管理会议纪要 (minutes)lark-cli minutes minutes事件订阅 (event)# 订阅飞书事件 (WebSocket) lark-cli event subscribe通用 API 调用# GET 请求 lark-cli api GET /open-apis/calendar/v4/calendars # POST 请求 lark-cli api POST /open-apis/im/v1/messages --data {receive_id:user_id,msg_type:text,content:{\text\:\hi\}} # 带参数 lark-cli api GET /open-apis/contact/v3/users --params {user_id_type:open_id}Schema 查看# 查看 API 方法参数和类型 lark-cli schema calendar.events.create --format pretty # 格式: json 或 pretty配置管理# 初始化配置 lark-cli config init # 显示当前配置 lark-cli config show # 设置默认身份类型 lark-cli config default-as user # 或 bot 或 auto # 移除配置 lark-cli config removeAI Agent Skillslark-cli 配套 AI Agent Skills可在 Claude Code 等 AI 编程工具中使用。# 安装所有 skills npx skills add larksuite/cli --all -y # 安装特定领域的 skill npx skills add larksuite/cli -s lark-calendar -y npx skills add larksuite/cli -s lark-im -y典型使用场景场景 1: 自动化消息推送# 发送文本消息 lark-cli im messages-send \ --params {receive_id:ou_xxx,msg_type:text} \ --data {content:{\text\:\告警通知服务异常\}} # 发送富文本消息 lark-cli im messages-send \ --params {receive_id:oc_xxx,msg_type:post} \ --data {content:{\post\:{\zh_cn\:{\title\:\标题\,\content\:[[{\tag\:\text\,\text\:\内容\}]]}}}}场景 2: 日历会议管理# 创建一个包含参会人的会议 lark-cli calendar create --data { summary: 技术方案评审, start_time: {timestamp: 1700000000}, end_time: {timestamp: 1700003600}, attendees: [{type: user, user_id: ou_xxx}] } # 查询某人的忙闲 lark-cli calendar freebusy --params {user_ids:[ou_xxx,ou_yyy],start_time:{timestamp:1700000000},end_time:{timestamp:1700086400}}场景 3: 文档与文件操作# 上传文件到云盘 lark-cli drive upload --params {file_name:report.pdf,parent_type:explorer,parent_node:根目录ID} -o ./report.pdf # 下载云盘文件 lark-cli drive download --params {file_token:xxx,file_name:report.pdf} -o ./output/ # 搜索文档 lark-cli docs search --params {query:架构设计,count:10}场景 4: 多维表格数据操作# 创建记录 lark-cli base record-upsert \ --params {bitable_id:xxx,table_id:tbl_xxx} \ --data {fields:{名称:项目A,状态:进行中,负责人:张三}} # 批量导入数据 lark-cli base record-upsert \ --params {bitable_id:xxx,table_id:tbl_xxx} \ --data {fields:{名称:项目B,状态:已完成}}场景 5: 自动化工作流触发# 配合 CI/CD 自动发送部署通知 lark-cli im chat-messages-list --params {chat_id:oc_xxx} | \ jq .data.items[0].chat_id | \ xargs -I {} lark-cli im messages-send \ --params {receive_id:{},msg_type:text} \ --data {content:{\text\:\ 部署完成环境production\}}错误排查常见问题问题解决方案401 Unauthorized执行lark-cli auth login重新认证403 Forbidden检查应用权限 (scopes) 是否包含对应 API404 Not Found检查资源 ID 是否正确翻页获取失败使用--page-delay增加间隔调试# 查看详细请求 lark-cli api GET /open-apis/xxx --dry-run # 健康检查 lark-cli doctor命令索引命令说明lark-cli api通用 API 调用lark-cli auth认证管理lark-cli base多维表格lark-cli calendar日历lark-cli config配置管理lark-cli contact联系人lark-cli docs文档lark-cli doctor健康检查lark-cli drive云盘lark-cli event事件订阅lark-cli im消息lark-cli mail邮件lark-cli minutes会议纪要lark-cli schema查看 API schemalark-cli sheets表格lark-cli task任务lark-cli vc视频会议lark-cli wikiWiki文档版本: v1.0最后更新: 2026-03-31