From 776803bdde3b9fff5e047bb2859c8aee9bab4f3c Mon Sep 17 00:00:00 2001 From: schumilin Date: Sat, 28 Mar 2026 14:40:53 +0800 Subject: [PATCH 1/3] docs: emphasize Skills installation as required step for AI Agents Split the AI Agent quick start from a single code block into separate labeled steps, and add a prominent note explaining that without Skills the Agent cannot discover available commands or parameters. Co-Authored-By: Claude Opus 4.6 (1M context) --- README.md | 31 ++++++++++++++++++++++++------- README.zh.md | 31 ++++++++++++++++++++++++------- 2 files changed, 48 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index ed2209d106..4f2c4354b2 100644 --- a/README.md +++ b/README.md @@ -97,22 +97,39 @@ lark-cli calendar +agenda > The following steps are for AI Agents. Some steps require the user to complete actions in a browser. +**Step 1 — Install CLI** + ```bash -# 1. Install CLI npm install -g @larksuite/cli +``` + +**Step 2 — Install Skills (REQUIRED)** + +> **Skills are structured instruction files that tell the AI Agent which commands exist and how to call them. Without Skills, the Agent does not know the available commands or their parameters — you MUST run this step.** -# 2. Install Skills (enables AI Agent to use this CLI) +```bash npx skills add larksuite/cli --all -y +``` + +**Step 3 — Configure app credentials** + +> Run this command in the background. It will output an authorization URL — extract it and send it to the user. The command exits automatically after the user completes the setup in the browser. -# 3. Configure app credentials -# Important: run this command in the background. It will output an authorization URL — extract it and send it to the user. The command exits automatically after the user completes the setup in browser. +```bash lark-cli config init --new +``` + +**Step 4 — Login** + +> Same as above: run in the background, extract the authorization URL and send it to the user. -# 4. Login -# Same as above: run in the background, extract the authorization URL and send it to the user. +```bash lark-cli auth login --recommend +``` -# 5. Verify +**Step 5 — Verify** + +```bash lark-cli auth status ``` diff --git a/README.zh.md b/README.zh.md index 811cf2949e..f8fb79f440 100644 --- a/README.zh.md +++ b/README.zh.md @@ -97,22 +97,39 @@ lark-cli calendar +agenda > 以下步骤面向 AI Agent，部分步骤需要用户在浏览器中配合完成。 +**第 1 步 — 安装 CLI** + ```bash -# 1. 安装 CLI npm install -g @larksuite/cli +``` + +**第 2 步 — 安装 Skills（必需）** + +> **Skills 是结构化的指令文件，告诉 AI Agent 有哪些命令可用以及如何调用。不安装 Skills，Agent 将无法知道可用的命令和参数——此步骤必须执行。** -# 2. 安装 Skills（使 AI Agent 能够使用本 CLI） +```bash npx skills add larksuite/cli --all -y +``` + +**第 3 步 — 配置应用凭证** + +> 在后台运行此命令，命令会输出一个授权链接，提取该链接并发送给用户，用户在浏览器中完成配置后命令会自动退出。 -# 3. 配置应用凭证 -# 重要：在后台运行此命令，命令会输出一个授权链接，提取该链接并发送给用户，用户在浏览器中完成配置后命令会自动退出。 +```bash lark-cli config init --new +``` + +**第 4 步 — 登录** + +> 同上，后台运行，提取授权链接发给用户。 -# 4. 登录 -# 同上，后台运行，提取授权链接发给用户 +```bash lark-cli auth login --recommend +``` -# 5. 验证 +**第 5 步 — 验证** + +```bash lark-cli auth status ``` From d7dec0805c545fe4b963511a7f641e1f3b721ff9 Mon Sep 17 00:00:00 2001 From: schumilin Date: Sat, 28 Mar 2026 14:41:43 +0800 Subject: [PATCH 2/3] docs: position Skills installation as the core step of the setup MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Reword the Skills step to convey that it is the most important part of the entire setup — the CLI is just a binary, Skills are what give the Agent the knowledge to operate Lark. Co-Authored-By: Claude Opus 4.6 (1M context) --- README.md | 4 ++-- README.zh.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4f2c4354b2..b925fab7eb 100644 --- a/README.md +++ b/README.md @@ -103,9 +103,9 @@ lark-cli calendar +agenda npm install -g @larksuite/cli ``` -**Step 2 — Install Skills (REQUIRED)** +**Step 2 — Install Skills (this is the core step)** -> **Skills are structured instruction files that tell the AI Agent which commands exist and how to call them. Without Skills, the Agent does not know the available commands or their parameters — you MUST run this step.** +> **This is the most important step in the entire setup.** Skills are the instruction files that teach the AI Agent what commands are available and how to call them. The CLI alone is just a binary — it is the Skills that give the Agent the knowledge to actually operate Lark. **Skipping this step means the Agent will not be able to use lark-cli at all.** ```bash npx skills add larksuite/cli --all -y diff --git a/README.zh.md b/README.zh.md index f8fb79f440..79a96f1afc 100644 --- a/README.zh.md +++ b/README.zh.md @@ -103,9 +103,9 @@ lark-cli calendar +agenda npm install -g @larksuite/cli ``` -**第 2 步 — 安装 Skills（必需）** +**第 2 步 — 安装 Skills（整个流程的核心步骤）** -> **Skills 是结构化的指令文件，告诉 AI Agent 有哪些命令可用以及如何调用。不安装 Skills，Agent 将无法知道可用的命令和参数——此步骤必须执行。** +> **这是整个安装流程中最关键的一步。** Skills 是教会 AI Agent 有哪些命令可用、如何调用的指令文件。CLI 本身只是一个二进制工具，真正让 Agent 具备操作飞书能力的是 Skills。**跳过此步骤，Agent 将完全无法使用 lark-cli。** ```bash npx skills add larksuite/cli --all -y From 8580ae942968fe9a73075de9cded7854a15adf80 Mon Sep 17 00:00:00 2001 From: schumilin Date: Sat, 28 Mar 2026 14:43:09 +0800 Subject: [PATCH 3/3] docs: tone down Skills step wording, keep it concise Co-Authored-By: Claude Opus 4.6 (1M context) --- README.md | 4 ++-- README.zh.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b925fab7eb..4a5b1a8ea5 100644 --- a/README.md +++ b/README.md @@ -103,9 +103,9 @@ lark-cli calendar +agenda npm install -g @larksuite/cli ``` -**Step 2 — Install Skills (this is the core step)** +**Step 2 — Install Skills (core step, do not skip)** -> **This is the most important step in the entire setup.** Skills are the instruction files that teach the AI Agent what commands are available and how to call them. The CLI alone is just a binary — it is the Skills that give the Agent the knowledge to actually operate Lark. **Skipping this step means the Agent will not be able to use lark-cli at all.** +> 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. ```bash npx skills add larksuite/cli --all -y diff --git a/README.zh.md b/README.zh.md index 79a96f1afc..921177b70c 100644 --- a/README.zh.md +++ b/README.zh.md @@ -103,9 +103,9 @@ lark-cli calendar +agenda npm install -g @larksuite/cli ``` -**第 2 步 — 安装 Skills（整个流程的核心步骤）** +**第 2 步 — 安装 Skills（核心步骤，请勿跳过）** -> **这是整个安装流程中最关键的一步。** Skills 是教会 AI Agent 有哪些命令可用、如何调用的指令文件。CLI 本身只是一个二进制工具，真正让 Agent 具备操作飞书能力的是 Skills。**跳过此步骤，Agent 将完全无法使用 lark-cli。** +> Skills 是告诉 AI Agent 有哪些命令可用及如何调用的指令文件，是 Agent 使用 lark-cli 的前提。 ```bash npx skills add larksuite/cli --all -y