lark-cli

中文版 | English

这是官方的 Lark/飞书 CLI 工具，由 larksuite 团队维护，专为人类用户和 AI Agent 设计。涵盖了包括即时消息、文档、多维表格 (Base)、电子表格 (Sheets)、日历、邮件、任务、会议等在内的核心业务领域，内置 200 多个命令和 19 个 AI Agent 技能 (Skills)。

安装与快速上手 · AI Agent 技能 · 认证 · 命令系统 · 高级用法 · 安全与风险提示 · 贡献指南

为什么选择 lark-cli？

• Agent 原生设计 — 开箱即用 19 个结构化的 Skills，兼容主流 AI 工具，Agent 无需额外配置即可操作飞书。
• 覆盖面广 — 涵盖 11 个业务领域，200 多个精选命令，以及 19 个 AI Agent 技能。
• AI 友好且优化 — 每个命令都经过真实 Agent 测试，提供简洁的参数、智能默认值和结构化输出，最大限度提高 Agent 的调用成功率。
• 开源，无门槛 — MIT 协议，即装即用，只需 npm install。
• 3 分钟快速上手 — 一键创建应用，交互式登录，从安装到首次 API 调用仅需 3 步。
• 安全可控 — 内置输入注入防护、终端输出过滤，并使用操作系统原生的钥匙串存储凭证。
• 三层架构 — 快捷指令（对人类和 AI 友好）→ API 命令（与平台同步）→ 原始 API（全覆盖），您可以根据需要选择合适的粒度。

功能特性

类别	功能概览
📅 日历	查看日程、创建会议、邀请参会人、查询忙闲状态、时间建议
💬 消息	发送/回复消息、创建和管理群聊、查看聊天记录与线程、搜索消息、下载媒体文件
📄 文档	创建、读取、更新和搜索文档，读写媒体和白板
📁 云盘	上传和下载文件，搜索文档与知识库，管理评论
📊 多维表格	创建和管理表格、字段、记录、视图、仪表盘、工作流、表单、角色权限、数据聚合分析
📈 电子表格	创建、读取、写入、追加、查找和导出表格数据
✅ 任务	创建、查询、更新和完成任务；管理任务清单、子任务、评论和提醒
📚 知识库	创建和管理知识空间、节点和文档
👤 通讯录	按姓名/邮箱/手机号搜索用户，获取用户个人资料
📧 邮件	浏览、搜索、阅读邮件，发送、回复、转发、管理草稿、监控新邮件
🎥 会议	搜索会议记录，查询会议纪要及录音

安装与快速上手

环境要求

开始之前，请确保具备以下环境：

• Node.js (npm/npx)
• Go v1.23+ 和 Python 3（仅在从源码构建时需要）

快速上手（人类用户）

AI 助手提示： 如果您是正在帮助用户安装的 AI Agent，请直接跳转至 快速上手 (AI Agent)，其中包含了您完成任务所需的所有步骤。

安装

请选择一种方式进行安装：

选项 1 — 通过 npm 安装（推荐）：

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

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

选项 2 — 从源码安装：

需要 Go v1.23+ 和 Python 3。

git clone https://github.com/larksuite/cli.git
cd cli
make install

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

配置与使用

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

# 2. 登录 (--recommend 会自动选择常用的权限范围)
lark-cli auth login --recommend

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

快速上手 (AI Agent)

以下步骤专门为 AI Agent 设计。部分步骤可能需要用户在浏览器中完成操作。

第一步 — 安装

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

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

第二步 — 配置应用凭证

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

lark-cli conf