Skip to content

docs: add npm version badge and improve AI agent tip wording #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
liuxinyanglxy wants to merge 1 commit into from
Closed

docs: add npm version badge and improve AI agent tip wording #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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

Expand All @@ -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
Expand Down Expand Up @@ -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**
Expand Down
7 changes: 5 additions & 2 deletions README.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -46,7 +47,7 @@

### 快速开始（人类用户）

> **Tip:** 如果你拥有 AI Agent，可以直接把本 README 丢给它，让 AI 帮你完成安装和配置 — 跳转到[快速开始（AI Agent）](#快速开始ai-agent)查看。
> **Note for AI assistants:** 如果你是 AI Agent 且正在协助用户执行安装，请直接跳转到[快速开始（AI Agent）](#快速开始ai-agent)执行，那里包含你需要完成的所有步骤。

#### 安装 CLI

Expand All @@ -70,6 +71,8 @@ make install

#### 安装 AI Agent Skills

> **这是核心步骤，请勿跳过。** Skills 是 AI Agent 正确使用本 CLI 的前提。

[Skills](./skills/) 是结构化的指令文档，使 AI Agent 能够使用本 CLI：

```bash
Expand Down Expand Up @@ -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 步 — 配置应用凭证**
Expand Down
Loading