lark-cli安装使用

安装nodejs

nodejs-release镜像-nodejs-release镜像下载安装-开源镜像站-阿里云

下载地址nodejs-release-v25.0.0安装包下载-开源镜像站-阿里云

验证安装

安装完成后，打开命令提示符（Command Prompt）或PowerShell，输入以下命令验证Node.js和NPM是否成功安装

node -v

npm -v

如果安装成功，你将会看到Node.js和NPM的版本号。

配置NPM镜像（可选）

由于NPM默认使用的是国外的镜像源，可以通过以下命令将镜像源切换为国内镜像，提高下载速度：

npm config set registry https://mirrors.aliyun.com/nodejs-release/

安装lark-cli

项目地址https://github.com/larksuite/cli

项目Readme文档cli/README.zh.md at main · larksuite/cli

从 npm 安装（推荐）：

# 安装 CLI
npm install -g @larksuite/cli

# 安装 CLI SKILL（必需）
npx skills add larksuite/cli -y -g

以下内容从Github复制过来。

配置与使用

# 1. 配置应用凭证（仅需一次，交互式引导完成）
lark-cli config init

# 2. 登录授权（--recommend 自动选择常用权限）
lark-cli auth login --recommend

# 3. 开始使用
lark-cli calendar +agenda

快速开始（AI Agent）

以下步骤面向 AI Agent，部分步骤需要用户在浏览器中配合完成。

第 1 步 — 安装

# 安装 CLI
npm install -g @larksuite/cli

# 安装 CLI SKILL（必需）
npx skills add larksuite/cli -y -g

第 2 步 — 配置应用凭证

在后台运行此命令，命令会输出一个授权链接，提取该链接并发送给用户，用户在浏览器中完成配置后命令会自动退出。

lark-cli config init --new

第 3 步 — 登录

同上，后台运行，提取授权链接发给用户。

lark-cli auth login --recommend

第 4 步 — 验证

lark-cli auth status

Agent Skills

Skill	说明
`lark-shared`	应用配置、认证登录、身份切换、权限管理、安全规则（所有其他 skill 自动加载）
`lark-calendar`	日历日程、议程查看、忙闲查询、时间建议
`lark-im`	发送/回复消息、群聊管理、消息搜索、上传下载图片与文件、表情回复
`lark-doc`	创建、读取、更新、搜索文档（基于 Markdown）
`lark-drive`	上传、下载文件，管理权限与评论
`lark-markdown`	创建、读取、覆盖更新 Drive 中的原生 Markdown 文件
`lark-sheets`	创建、读取、写入、追加、查找、导出电子表格
`lark-slides`	创建和管理演示文稿、读取演示文稿内容，以及新增或删除幻灯片页面
`lark-base`	多维表格、字段、记录、视图、仪表盘、数据聚合分析
`lark-task`	任务、任务清单、子任务、提醒、成员分配
`lark-mail`	浏览、搜索、阅读邮件，发送、回复、转发，草稿管理，监听新邮件
`lark-contact`	按姓名/邮箱/手机号搜索用户，获取用户信息
`lark-wiki`	知识空间、节点、文档
`lark-event`	实时事件订阅（WebSocket），支持正则路由与 Agent 友好格式
`lark-vc`	搜索会议记录、查询会议纪要产物（总结、待办、逐字稿）
`lark-whiteboard`	画板/图表 DSL 渲染
`lark-minutes`	妙记元数据与 AI 产物（总结、待办、章节）
`lark-openapi-explorer`	从官方文档探索底层 API
`lark-skill-maker`	自定义 skill 创建框架
`lark-attendance`	查询个人考勤打卡记录
`lark-approval`	审批任务查询、同意/拒绝/转交审批任务、撤回与抄送审批实例
`lark-workflow-meeting-summary`	工作流：会议纪要汇总与结构化报告
`lark-workflow-standup-report`	工作流：日程待办摘要
`lark-okr`	查询、创建、更新 OKR，管理目标、关键结果、对齐、指标和进展记录

认证

命令	说明
`auth login`	OAuth 登录，支持交互式选择或命令行参数指定 scope
`auth logout`	登出并删除已存储的凭证
`auth status`	查看当前登录状态和已授权的 scope
`auth check`	校验指定 scope（exit 0 = 有权限，1 = 缺失）
`auth scopes`	列出应用的所有可用 scope
`auth list`	列出所有已认证的用户

# 交互式登录（TUI 引导选择业务域和权限级别）
lark-cli auth login

# 按域筛选
lark-cli auth login --domain calendar,task

# 推荐的自动审批 scopes
lark-cli auth login --recommend

# 精确 scope
lark-cli auth login --scope "calendar:calendar:read"

# Agent 模式：立即返回验证 URL，不阻塞
lark-cli auth login --domain calendar --no-wait
# 稍后恢复轮询
lark-cli auth login --device-code <DEVICE_CODE>

# 身份切换：以用户或机器人身份执行命令
lark-cli calendar +agenda --as user
lark-cli im +messages-send --as bot --chat-id "oc_xxx" --text "Hello"

三层命令调用

CLI 提供三种粒度的调用方式，覆盖从快速操作到完全自定义的全部场景：

1. 快捷命令（Shortcuts）

以 + 为前缀，对人类与 AI 友好化封装，内置智能默认值、表格输出和 dry-run 预览。

lark-cli calendar +agenda
lark-cli im +messages-send --chat-id "oc_xxx" --text "Hello"
lark-cli docs +create --api-version v2 --doc-format markdown --content $'<title>周报</title>\n# 本周进展\n- 完成了 X 功能'

运行 lark-cli <service> --help 查看所有快捷命令。

2. API 命令

从飞书 OAPI 元数据自动生成，经过评测与准入筛选，100+ 精选命令与平台端点一一对应。

lark-cli calendar calendars list
lark-cli calendar events instance_view --params '{"calendar_id":"primary","start_time":"1700000000","end_time":"1700086400"}'

3. 通用 API 调用

直接调用任意飞书开放平台端点，覆盖 2500+ API。

lark-cli api GET /open-apis/calendar/v4/calendars
lark-cli api POST /open-apis/im/v1/messages --params '{"receive_id_type":"chat_id"}' --data '{"receive_id":"oc_xxx","msg_type":"text","content":"{\"text\":\"Hello\"}"}'

进阶用法

输出格式

--format json      # 完整 JSON 响应（默认）
--format pretty    # 人性化格式输出
--format table     # 易读表格
--format ndjson    # 换行分隔 JSON（适合管道处理）
--format csv       # 逗号分隔值

分页

--page-all                  # 自动翻页获取所有数据
--page-limit 5              # 最多获取 5 页
--page-delay 500            # 每页请求间隔 500ms

Dry Run

对可能产生副作用的命令，建议先用 --dry-run 预览请求：

lark-cli im +messages-send --chat-id oc_xxx --text "hello" --dry-run

Schema 自省

使用 schema 查看任意 API 方法的参数、请求体、响应结构、支持身份和 scopes：

lark-cli schema
lark-cli schema calendar.events.instance_view
lark-cli schema im.messages.delete