diff --git a/README.md b/README.md index aacf745c0..9e4c1813d 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,14 @@ [中文版](./README.zh.md) | [English](./README.md) -The official [Lark/Feishu](https://www.larksuite.com/) CLI tool, maintained by the [larksuite](https://github.com/larksuite) team — built for humans and AI Agents. Covers core business domains including Messenger, Docs, Base, Sheets, Calendar, Mail, Tasks, Meetings, and more, with 200+ commands and 19 AI Agent [Skills](./skills/). +The official [Lark/Feishu](https://www.larksuite.com/) CLI tool, maintained by the [larksuite](https://github.com/larksuite) team — built for humans and AI Agents. Covers core business domains including Messenger, Docs, Base, Sheets, Calendar, Mail, Tasks, Meetings, and more, with 200+ commands and 20 AI Agent [Skills](./skills/). [Install](#installation--quick-start) · [AI Agent Skills](#agent-skills) · [Auth](#authentication) · [Commands](#three-layer-command-system) · [Advanced](#advanced-usage) · [Security](#security--risk-warnings-read-before-use) · [Contributing](#contributing) ## Why lark-cli? -- **Agent-Native Design** — 19 structured [Skills](./skills/) out of the box, compatible with popular AI tools — Agents can operate Lark with zero extra setup -- **Wide Coverage** — 11 business domains, 200+ curated commands, 19 AI Agent [Skills](./skills/) +- **Agent-Native Design** — 20 structured [Skills](./skills/) out of the box, compatible with popular AI tools — Agents can operate Lark with zero extra setup +- **Wide Coverage** — 12 business domains, 200+ curated commands, 20 AI Agent [Skills](./skills/) - **AI-Friendly & Optimized** — Every command is tested with real Agents, featuring concise parameters, smart defaults, and structured output to maximize Agent call success rates - **Open Source, Zero Barriers** — MIT license, ready to use, just `npm install` - **Up and Running in 3 Minutes** — One-click app creation, interactive login, from install to first API call in just 3 steps @@ -22,19 +22,20 @@ The official [Lark/Feishu](https://www.larksuite.com/) CLI tool, maintained by t ## Features -| Category | Capabilities | -| ------------- | ----------------------------------------------------------------------------------- | -| 📅 Calendar | View agenda, create events, invite attendees, check free/busy status, time suggestions | -| 💬 Messenger | Send/reply messages, create and manage group chats, view chat history & threads, search messages, download media | -| 📄 Docs | Create, read, update, and search documents, read/write media & whiteboards | -| 📁 Drive | Upload and download files, search docs & wiki, manage comments | +| Category | Capabilities | +| ------------- |-----------------------------------------------------------------------------------------------------------------------------------| +| 📅 Calendar | View agenda, create events, invite attendees, check free/busy status, time suggestions | +| 💬 Messenger | Send/reply messages, create and manage group chats, view chat history & threads, search messages, download media | +| 📄 Docs | Create, read, update, and search documents, read/write media & whiteboards | +| 📁 Drive | Upload and download files, search docs & wiki, manage comments | | 📊 Base | Create and manage tables, fields, records, views, dashboards, workflows, forms, roles & permissions, data aggregation & analytics | -| 📈 Sheets | Create, read, write, append, find, and export spreadsheet data | -| ✅ Tasks | Create, query, update, and complete tasks; manage task lists, subtasks, comments & reminders | -| 📚 Wiki | Create and manage knowledge spaces, nodes, and documents | -| 👤 Contact | Search users by name/email/phone, get user profiles | -| 📧 Mail | Browse, search, read emails, send, reply, forward, manage drafts, watch new mail | -| 🎥 Meetings | Search meeting records, query meeting minutes & recordings | +| 📈 Sheets | Create, read, write, append, find, and export spreadsheet data | +| ✅ Tasks | Create, query, update, and complete tasks; manage task lists, subtasks, comments & reminders | +| 📚 Wiki | Create and manage knowledge spaces, nodes, and documents | +| 👤 Contact | Search users by name/email/phone, get user profiles | +| 📧 Mail | Browse, search, read emails, send, reply, forward, manage drafts, watch new mail | +| 🎥 Meetings | Search meeting records, query meeting minutes & recordings | +| ✍️ Approval | Query approval tasks, approve/reject/transfer tasks, cancel and CC instances | ## Installation & Quick Start @@ -127,27 +128,28 @@ lark-cli auth status ## Agent Skills -| Skill | Description | -| ------------------------------- | ------------------------------------------------------------------------------------- | +| Skill | Description | +| ------------------------------- |----------------------------------------------------------------------------------------------------------------| | `lark-shared` | App config, auth login, identity switching, scope management, security rules (auto-loaded by all other skills) | -| `lark-calendar` | Calendar events, agenda view, free/busy queries, time suggestions | -| `lark-im` | Send/reply messages, group chat management, message search, upload/download images & files, reactions | -| `lark-doc` | Create, read, update, search documents (Markdown-based) | -| `lark-drive` | Upload, download files, manage permissions & comments | -| `lark-sheets` | Create, read, write, append, find, export spreadsheets | -| `lark-base` | Tables, fields, records, views, dashboards, data aggregation & analytics | -| `lark-task` | Tasks, task lists, subtasks, reminders, member assignment | -| `lark-mail` | Browse, search, read emails, send, reply, forward, draft management, watch new mail | -| `lark-contact` | Search users by name/email/phone, get user profiles | -| `lark-wiki` | Knowledge spaces, nodes, documents | -| `lark-event` | Real-time event subscriptions (WebSocket), regex routing & agent-friendly format | -| `lark-vc` | Search meeting records, query meeting minutes (summary, todos, transcript) | -| `lark-whiteboard` | Whiteboard/chart DSL rendering | -| `lark-minutes` | Minutes metadata & AI artifacts (summary, todos, chapters) | -| `lark-openapi-explorer` | Explore underlying APIs from official docs | -| `lark-skill-maker` | Custom skill creation framework | -| `lark-workflow-meeting-summary` | Workflow: meeting minutes aggregation & structured report | -| `lark-workflow-standup-report` | Workflow: agenda & todo summary | +| `lark-calendar` | Calendar events, agenda view, free/busy queries, time suggestions | +| `lark-im` | Send/reply messages, group chat management, message search, upload/download images & files, reactions | +| `lark-doc` | Create, read, update, search documents (Markdown-based) | +| `lark-drive` | Upload, download files, manage permissions & comments | +| `lark-sheets` | Create, read, write, append, find, export spreadsheets | +| `lark-base` | Tables, fields, records, views, dashboards, data aggregation & analytics | +| `lark-task` | Tasks, task lists, subtasks, reminders, member assignment | +| `lark-mail` | Browse, search, read emails, send, reply, forward, draft management, watch new mail | +| `lark-contact` | Search users by name/email/phone, get user profiles | +| `lark-wiki` | Knowledge spaces, nodes, documents | +| `lark-event` | Real-time event subscriptions (WebSocket), regex routing & agent-friendly format | +| `lark-vc` | Search meeting records, query meeting minutes (summary, todos, transcript) | +| `lark-whiteboard` | Whiteboard/chart DSL rendering | +| `lark-minutes` | Minutes metadata & AI artifacts (summary, todos, chapters) | +| `lark-openapi-explorer` | Explore underlying APIs from official docs | +| `lark-skill-maker` | Custom skill creation framework | +| `lark-approval` | query Approval tasks, approve/reject/transfer tasks, cancel and CC instances | +| `lark-workflow-meeting-summary` | Workflow: meeting minutes aggregation & structured report | +| `lark-workflow-standup-report` | Workflow: agenda & todo summary | ## Authentication diff --git a/README.zh.md b/README.zh.md index e23fb8465..8337d7013 100644 --- a/README.zh.md +++ b/README.zh.md @@ -6,14 +6,14 @@ [中文版](./README.zh.md) | [English](./README.md) -飞书官方 CLI 工具，由 [larksuite](https://github.com/larksuite) 团队维护 — 让人类和 AI Agent 都能在终端中操作飞书。覆盖消息、文档、多维表格、电子表格、日历、邮箱、任务、会议等核心业务域，提供 200+ 命令及 19 个 AI Agent [Skills](./skills/)。 +飞书官方 CLI 工具，由 [larksuite](https://github.com/larksuite) 团队维护 — 让人类和 AI Agent 都能在终端中操作飞书。覆盖消息、文档、多维表格、电子表格、日历、邮箱、任务、会议等核心业务域，提供 200+ 命令及 20 个 AI Agent [Skills](./skills/)。 [安装](#安装与快速开始) · [AI Agent Skills](#agent-skills) · [认证](#认证) · [命令](#三层命令调用) · [进阶用法](#进阶用法) · [安全](#安全与风险提示使用前必读) · [贡献](#贡献) ## 为什么选 lark-cli？ - **为 Agent 原生设计** — [Skills](./skills/) 开箱即用，适配主流 AI 工具，Agent 无需额外适配即可操作飞书 -- **覆盖面广** — 11 大业务域、200+ 精选命令、 19 个 AI Agent [Skills](./skills/) +- **覆盖面广** — 12 大业务域、200+ 精选命令、 20 个 AI Agent [Skills](./skills/) - **AI 友好调优** — 每条命令经过 Agent 实测验证，提供更友好的参数、智能默认值和结构化输出，大幅提升 Agent 调用成功率 - **开源零门槛** — MIT 协议，开箱即用，`npm install` 即可使用 - **三分钟上手** — 一键创建应用、交互式登录授权，从安装到第一次 API 调用只需三步 @@ -22,19 +22,20 @@ ## 功能 -| 类别 | 能力 | -| ------------- | --------------------------------------------------------------------------- | -| 📅 日历 | 查看日程、创建日程、邀请参会人、查询忙闲状态、时间建议 | -| 💬 即时通讯 | 发送/回复消息、创建和管理群聊、查看聊天记录与话题、搜索消息、下载媒体文件 | -| 📄 云文档 | 创建、读取、更新文档、搜索文档、读写素材与画板 | -| 📁 云空间 | 上传和下载文件、搜索文档与知识库、管理评论 | +| 类别 | 能力 | +| ------------- |--------------------------------------------| +| 📅 日历 | 查看日程、创建日程、邀请参会人、查询忙闲状态、时间建议 | +| 💬 即时通讯 | 发送/回复消息、创建和管理群聊、查看聊天记录与话题、搜索消息、下载媒体文件 | +| 📄 云文档 | 创建、读取、更新文档、搜索文档、读写素材与画板 | +| 📁 云空间 | 上传和下载文件、搜索文档与知识库、管理评论 | | 📊 多维表格 | 创建和管理数据表、字段、记录、视图、仪表盘、自动化流程、表单、角色权限，数据聚合分析 | -| 📈 电子表格 | 创建、读取、写入、追加、查找和导出表格数据 | -| ✅ 任务 | 创建、查询、更新和完成任务；管理任务清单、子任务、评论与提醒 | -| 📚 知识库 | 创建和管理知识空间、节点和文档 | -| 👤 通讯录 | 按姓名/邮箱/手机号搜索用户、获取用户信息 | -| 📧 邮箱 | 浏览、搜索、阅读邮件，发送、回复、转发邮件，管理草稿，监听新邮件 | -| 🎥 视频会议 | 搜索会议记录、查询会议纪要与录制 | +| 📈 电子表格 | 创建、读取、写入、追加、查找和导出表格数据 | +| ✅ 任务 | 创建、查询、更新和完成任务；管理任务清单、子任务、评论与提醒 | +| 📚 知识库 | 创建和管理知识空间、节点和文档 | +| 👤 通讯录 | 按姓名/邮箱/手机号搜索用户、获取用户信息 | +| 📧 邮箱 | 浏览、搜索、阅读邮件，发送、回复、转发邮件，管理草稿，监听新邮件 | +| 🎥 视频会议 | 搜索会议记录、查询会议纪要与录制 | +| ✍️ 审批 | 查询审批任务、同意/拒绝/转交审批任务、撤回与抄送审批实例 | ## 安装与快速开始 @@ -128,27 +129,28 @@ lark-cli auth status ## Agent Skills -| Skill | 说明 | -| --------------------------------- | ----------------------------------------------------------------------------- | +| Skill | 说明 | +| --------------------------------- |-------------------------------------------| | `lark-shared` | 应用配置、认证登录、身份切换、权限管理、安全规则（所有其他 skill 自动加载） | -| `lark-calendar` | 日历日程、议程查看、忙闲查询、时间建议 | -| `lark-im` | 发送/回复消息、群聊管理、消息搜索、上传下载图片与文件、表情回复 | -| `lark-doc` | 创建、读取、更新、搜索文档（基于 Markdown） | -| `lark-drive` | 上传、下载文件，管理权限与评论 | -| `lark-sheets` | 创建、读取、写入、追加、查找、导出电子表格 | -| `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-workflow-meeting-summary` | 工作流：会议纪要汇总与结构化报告 | -| `lark-workflow-standup-report` | 工作流：日程待办摘要 | +| `lark-calendar` | 日历日程、议程查看、忙闲查询、时间建议 | +| `lark-im` | 发送/回复消息、群聊管理、消息搜索、上传下载图片与文件、表情回复 | +| `lark-doc` | 创建、读取、更新、搜索文档（基于 Markdown） | +| `lark-drive` | 上传、下载文件，管理权限与评论 | +| `lark-sheets` | 创建、读取、写入、追加、查找、导出电子表格 | +| `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-approval` | 审批任务查询、同意/拒绝/转交审批任务、撤回与抄送审批实例 | +| `lark-workflow-meeting-summary` | 工作流：会议纪要汇总与结构化报告 | +| `lark-workflow-standup-report` | 工作流：日程待办摘要 | ## 认证 diff --git a/internal/registry/service_descriptions.json b/internal/registry/service_descriptions.json index 799aca1eb..d401586c4 100644 --- a/internal/registry/service_descriptions.json +++ b/internal/registry/service_descriptions.json @@ -1,7 +1,7 @@ { "approval": { - "en": { "title": "Approval API", "description": "Approval instance, and task management" }, - "zh": { "title": "审批 API", "description": "审批实例、审批任务管理" } + "en": { "title": "Approval", "description": "Approval instance, and task management" }, + "zh": { "title": "审批", "description": "审批实例、审批任务管理" } }, "base": { "en": { "title": "Base", "description": "Table, field, record, view, dashboard, workflow, form, role & permission management" },