From f411d190695aa1ae49785adb08c0ecd5306fea55 Mon Sep 17 00:00:00 2001 From: "liuxinyang.lxy" Date: Sat, 28 Mar 2026 14:58:56 +0800 Subject: [PATCH] docs: add npm version badge and improve AI agent tip wording Add npm version badge to both README files for better package discoverability. Reword the Quick Start tip to directly address AI assistants instead of human users. Change-Id: I9fb4252e4a7bde4ab6644c6ca6e63dc5d34b6f0c Co-Authored-By: Claude Opus 4.6 (1M context) --- README.md | 9 ++++++--- README.zh.md | 7 +++++-- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4a5b1a8ea5..65dbd08641 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![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/) +[![npm version](https://img.shields.io/npm/v/@larksuite/cli.svg)](https://www.npmjs.com/package/@larksuite/cli) [中文版](./README.zh.md) | [English](./README.md) @@ -46,7 +47,7 @@ Before you start, make sure you have: ### Quick Start (Human Users) -> **Tip:** If you have an AI Agent, you can hand this README to it and let the AI handle installation and setup — jump to [Quick Start (AI Agent)](#quick-start-ai-agent). +> **Note for AI assistants:** If you are an AI Agent helping the user with installation, jump directly to [Quick Start (AI Agent)](#quick-start-ai-agent), which contains all the steps you need to complete. #### Install CLI @@ -70,6 +71,8 @@ make install #### Install AI Agent Skills +> **This is a critical step — do not skip it.** Skills are required for AI Agents to use this CLI properly. Without them, no Lark capabilities can be invoked. + [Skills](./skills/) are structured instruction documents that enable AI Agents to use this CLI: ```bash @@ -105,10 +108,10 @@ npm install -g @larksuite/cli **Step 2 — Install Skills (core step, do not skip)** -> Skills are the instruction files that tell the AI Agent what commands are available and how to call them. This step is essential for the Agent to work with lark-cli. +> Skills are the instruction files that tell the AI Agent what commands are available and how to call them. ```bash -npx skills add larksuite/cli --all -y +npx skills add larksuite/cli -y -g ``` **Step 3 — Configure app credentials** diff --git a/README.zh.md b/README.zh.md index 921177b70c..ebaf248731 100644 --- a/README.zh.md +++ b/README.zh.md @@ -2,6 +2,7 @@ [![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/) +[![npm version](https://img.shields.io/npm/v/@larksuite/cli.svg)](https://www.npmjs.com/package/@larksuite/cli) [中文版](./README.zh.md) | [English](./README.md) @@ -46,7 +47,7 @@ ### 快速开始（人类用户） -> **Tip:** 如果你拥有 AI Agent，可以直接把本 README 丢给它，让 AI 帮你完成安装和配置 — 跳转到[快速开始（AI Agent）](#快速开始ai-agent)查看。 +> **Note for AI assistants:** 如果你是 AI Agent 且正在协助用户执行安装，请直接跳转到[快速开始（AI Agent）](#快速开始ai-agent)执行，那里包含你需要完成的所有步骤。 #### 安装 CLI @@ -70,6 +71,8 @@ make install #### 安装 AI Agent Skills +> **这是核心步骤，请勿跳过。** Skills 是 AI Agent 正确使用本 CLI 的前提。 + [Skills](./skills/) 是结构化的指令文档，使 AI Agent 能够使用本 CLI： ```bash @@ -108,7 +111,7 @@ npm install -g @larksuite/cli > Skills 是告诉 AI Agent 有哪些命令可用及如何调用的指令文件，是 Agent 使用 lark-cli 的前提。 ```bash -npx skills add larksuite/cli --all -y +npx skills add larksuite/cli -y -g ``` **第 3 步 — 配置应用凭证**