From 7a0a2de57df2215be77ce58188a584263ebf5048 Mon Sep 17 00:00:00 2001 From: yangr-happy Date: Wed, 2 Sep 2026 14:43:12 +0800 Subject: [PATCH] docs: normalize cli heading --- README.md | 43 +++++++++++++++++++++++++++++++++++-------- 1 file changed, 35 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0d6fc24c22..338d82fbc1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# lark-cli +# lark-CLI [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Go Version](https://img.shields.io/badge/go-%3E%3D1.23-blue.svg)](https://go.dev/) @@ -8,7 +8,7 @@ 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, Slides, Calendar, Mail, Tasks, Meetings, Markdown, and more, with 200+ commands and 26 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) +[Install](#installation--quick-start) · [AI Agent Skills](#agent-skills) · [Auth](#authentication) · [Commands](#three-layer-command-system) · [Advanced](#advanced-usage) · [Enterprise](#personal-or-enterprise) · [Security](#security--risk-warnings-read-before-use) · [Contributing](#contributing) ## Why lark-cli? @@ -20,6 +20,15 @@ The official [Lark/Feishu](https://www.larksuite.com/) CLI tool, maintained by t - **Secure & Controllable** — Input injection protection, terminal output sanitization, OS-native keychain credential storage - **Three-Layer Architecture** — Shortcuts (human & AI friendly) → API Commands (platform-synced) → Raw API (full coverage), choose the right granularity +## Personal or Enterprise? + +| You are... | Recommended path | +| ---------- | ---------------- | +| **An individual developer** — using lark-cli in your terminal or with your own AI Agent | Follow the [Quick Start](#installation--quick-start) below | +| **Enterprise IT / ISV** — embedding lark-cli into your own Agent or platform, with centralized credentials (database / Vault / config center), unified audit logging, and a restricted command surface | Read [Embed lark-cli in your Agent](https://open.larksuite.com/document/mcp_open_tools/feishu-cli/embed-feishu-cli-in-agent) and the [`extension/`](./extension/) packages — extend via a wrapper `main`, no need to modify CLI source | + +> 💡 **For AI Agents:** append `.md` to any Open Platform doc URL to fetch it as raw Markdown, e.g. [`embed-feishu-cli-in-agent.md`](https://open.larksuite.com/document/mcp_open_tools/feishu-cli/embed-feishu-cli-in-agent.md). + ## Features | Category | Capabilities | @@ -36,7 +45,7 @@ The official [Lark/Feishu](https://www.larksuite.com/) CLI tool, maintained by t | 📚 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 artifacts and recordings | +| 🎥 Meetings | Search live and historical meetings, inspect participants and artifacts, analyze transcripts, manage Minutes, and assist in meetings | | 🕐 Attendance | Query personal attendance check-in records | | ✍️ Approval | Query approval tasks, approve/reject/transfer tasks, cancel and CC instances | | 🎯 OKR | Query, create, update OKRs; manage objective & key results, alignments, indicators and progress. | @@ -142,9 +151,8 @@ lark-cli auth status | `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-meeting` | Search live or historical meetings, inspect participants and artifacts, analyze transcripts, manage Minutes, and assist in meetings | | `lark-whiteboard` | Whiteboard/chart DSL rendering | -| `lark-minutes` | Minutes metadata & AI artifacts (summary, todos, chapters); upload audio/video to create minutes, download media | | `lark-openapi-explorer` | Explore underlying APIs from official docs | | `lark-skill-maker` | Custom skill creation framework | | `lark-attendance` | Query personal attendance check-in records | @@ -285,11 +293,30 @@ To reduce these risks, the tool enables default security protections at multiple We recommend using the Lark/Feishu bot integrated with this tool as a private conversational assistant. Do not add it to group chats or allow other users to interact with it, to avoid abuse of permissions or data leakage. -Please fully understand all usage risks. By using this tool, you are deemed to voluntarily assume all related responsibilities. +To reduce the security risks associated with access token theft, the CLI sends a minimal set of risk-control signals with OpenAPI requests made to exact official Feishu/Lark HTTPS domains. These signals are used to help identify anomalous API activity. This protection is enabled by default. The information sent is limited to: + +- Operating system type: macOS, Windows, or Linux +- Device hardware model: for example, Mac17,9 + +To disable this protection for the current workspace, run: + +```bash +lark-cli config risk-control off +``` -## Star History +To enable this protection for the current workspace, run: -[![Star History Chart](https://api.star-history.com/svg?repos=larksuite/cli&type=Date)](https://star-history.com/#larksuite/cli&Date) +```bash +lark-cli config risk-control on +``` + +To restore the default policy for the current workspace, run: + +```bash +lark-cli config risk-control default +``` + +Please fully understand all usage risks. By using this tool, you are deemed to voluntarily assume all related responsibilities. ## Contributing