From 6817f64eae6add41ab60fc3feb3c39964e7f184e Mon Sep 17 00:00:00 2001 From: Kim Yongbeom Date: Tue, 7 Apr 2026 14:30:22 +0800 Subject: [PATCH 1/5] feat: add claude-plugin + README --- .claude-plugin/marketplace.json | 16 +++++++++++ .claude-plugin/plugin.json | 15 ++++++++++ README.md | 48 ++++++++++++++++++++++--------- README.zh.md | 50 +++++++++++++++++++++++---------- 4 files changed, 100 insertions(+), 29 deletions(-) create mode 100644 .claude-plugin/marketplace.json create mode 100644 .claude-plugin/plugin.json diff --git a/.claude-plugin/marketplace.json b/.claude-plugin/marketplace.json new file mode 100644 index 00000000..07f365fb --- /dev/null +++ b/.claude-plugin/marketplace.json @@ -0,0 +1,16 @@ +{ + "name": "larksuite-cli-marketplace", + "owner": { + "name": "larksuite" + }, + "metadata": { + "description": "Official Claude Code marketplace for the Lark CLI skill bundle." + }, + "plugins": [ + { + "name": "larksuite/cli", + "source": "./", + "description": "Official Claude Code plugin bundle for Lark CLI skills." + } + ] +} diff --git a/.claude-plugin/plugin.json b/.claude-plugin/plugin.json new file mode 100644 index 00000000..9ee0ef75 --- /dev/null +++ b/.claude-plugin/plugin.json @@ -0,0 +1,15 @@ +{ + "name": "larksuite/cli", + "version": "1.0.4", + "description": "The official CLI for Lark/Feishu open platform", + "author": "Lark Open Platform", + "homepage": "https://github.com/larksuite/cli", + "repository": "git+https://github.com/larksuite/cli.git", + "license": "MIT", + "keywords": [ + "claude-code", + "lark", + "feishu", + "skills" + ] +} diff --git a/README.md b/README.md index a01bcb96..ed334ec1 100644 --- a/README.md +++ b/README.md @@ -52,19 +52,22 @@ Before you start, make sure you have: #### Install -Choose **one** of the following methods: +Choose **one** CLI installation method, then install the Claude Code plugin. **Option 1 — From npm (recommended):** ```bash -# Install CLI npm install -g @larksuite/cli +``` + +**Option 2 — Install the Claude Code plugin (repo-first, recommended)** -# Install CLI SKILL (required) -npx skills add larksuite/cli -y -g +```bash +claude plugin marketplace add larksuite/cli +claude plugin install larksuite/cli@larksuite-cli-marketplace ``` -**Option 2 — From source:** +**Option 3 — From source:** Requires Go `v1.23`+ and Python 3. @@ -72,9 +75,14 @@ Requires Go `v1.23`+ and Python 3. git clone https://github.com/larksuite/cli.git cd cli make install +``` -# Install CLI SKILL (required) -npx skills add larksuite/cli -y -g +**Compatibility / fallback — install legacy standalone skills** + +Use this only if you cannot use the Claude plugin workflow yet. + +```bash +npx skills add larksuite/cli -g -y ``` #### Configure & Use @@ -94,17 +102,28 @@ 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** +**Step 1 — Install the Claude Code plugin (repo-first, recommended)** + +```bash +claude plugin marketplace add larksuite/cli +claude plugin install larksuite/cli@larksuite-cli-marketplace +``` + +**Step 2 — Install the CLI binary** ```bash -# Install CLI npm install -g @larksuite/cli +``` -# Install CLI SKILL (required) -npx skills add larksuite/cli -y -g +**Compatibility / fallback — install legacy standalone skills** + +Use this only if the Claude plugin workflow is not available yet. + +```bash +npx skills add larksuite/cli -g -y ``` -**Step 2 — Configure app credentials** +**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. @@ -112,7 +131,7 @@ npx skills add larksuite/cli -y -g lark-cli config init --new ``` -**Step 3 — Login** +**Step 4 — Login** > Same as above: run in the background, extract the authorization URL and send it to the user. @@ -120,10 +139,11 @@ lark-cli config init --new lark-cli auth login --recommend ``` -**Step 4 — Verify** +**Step 5 — Verify** ```bash lark-cli auth status +claude plugin validate . ``` ## Agent Skills diff --git a/README.zh.md b/README.zh.md index 8337d701..b204f964 100644 --- a/README.zh.md +++ b/README.zh.md @@ -52,19 +52,22 @@ #### 安装 -以下两种方式**任选其一**: +选择 **一种** CLI 安装方式,然后安装 Claude Code 插件。 **方式一 — 从 npm 安装(推荐):** ```bash -# 安装 CLI npm install -g @larksuite/cli +``` + +**方式二 — 安装 Claude Code 插件(repo-first,推荐)** -# 安装 CLI SKILL(必需) -npx skills add larksuite/cli -y -g +```bash +claude plugin marketplace add larksuite/cli +claude plugin install larksuite/cli@larksuite-cli-marketplace ``` -**方式二 — 从源码安装:** +**方式三 — 从源码安装:** 需要 Go `v1.23`+ 和 Python 3。 @@ -72,9 +75,14 @@ npx skills add larksuite/cli -y -g git clone https://github.com/larksuite/cli.git cd cli make install +``` -# 安装 CLI SKILL(必需) -npx skills add larksuite/cli -y -g +**兼容 / 回退方案 — 安装旧版 standalone skills** + +仅当暂时无法使用 Claude 插件工作流时再使用: + +```bash +npx skills add larksuite/cli -g -y ``` #### 配置与使用 @@ -90,21 +98,32 @@ lark-cli auth login --recommend lark-cli calendar +agenda ``` -### 快速开始(AI Agent) +## 快速开始(AI Agent) > 以下步骤面向 AI Agent,部分步骤需要用户在浏览器中配合完成。 -**第 1 步 — 安装** +**第 1 步 — 安装 Claude Code 插件(repo-first,推荐)** + +```bash +claude plugin marketplace add larksuite/cli +claude plugin install larksuite/cli@larksuite-cli-marketplace +``` + +**第 2 步 — 安装 CLI 二进制** ```bash -# 安装 CLI npm install -g @larksuite/cli +``` -# 安装 CLI SKILL(必需) -npx skills add larksuite/cli -y -g +**兼容 / 回退方案 — 安装旧版 standalone skills** + +仅当 Claude 插件工作流暂不可用时再使用: + +```bash +npx skills add larksuite/cli -g -y ``` -**第 2 步 — 配置应用凭证** +**第 3 步 — 配置应用凭证** > 在后台运行此命令,命令会输出一个授权链接,提取该链接并发送给用户,用户在浏览器中完成配置后命令会自动退出。 @@ -112,7 +131,7 @@ npx skills add larksuite/cli -y -g lark-cli config init --new ``` -**第 3 步 — 登录** +**第 4 步 — 登录** > 同上,后台运行,提取授权链接发给用户。 @@ -120,10 +139,11 @@ lark-cli config init --new lark-cli auth login --recommend ``` -**第 4 步 — 验证** +**第 5 步 — 验证** ```bash lark-cli auth status +claude plugin validate . ``` From 973997756dc3af84757025b7f6eff78c22ddd8be Mon Sep 17 00:00:00 2001 From: Kim Yongbeom Date: Tue, 7 Apr 2026 14:47:05 +0800 Subject: [PATCH 2/5] fix(docs): clarify plugin install and verification steps Separate CLI vs Claude plugin setup in the README and replace the invalid agent verification command with claude plugin list. --- README.md | 22 ++++++++++++---------- README.zh.md | 22 ++++++++++++---------- 2 files changed, 24 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index ed334ec1..da8abed7 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,9 @@ Before you start, make sure you have: #### Install -Choose **one** CLI installation method, then install the Claude Code plugin. +Install the CLI first. If you use Claude Code, then install the plugin. + +**Step 1 — Install the CLI (choose one):** **Option 1 — From npm (recommended):** @@ -60,14 +62,7 @@ Choose **one** CLI installation method, then install the Claude Code plugin. npm install -g @larksuite/cli ``` -**Option 2 — Install the Claude Code plugin (repo-first, recommended)** - -```bash -claude plugin marketplace add larksuite/cli -claude plugin install larksuite/cli@larksuite-cli-marketplace -``` - -**Option 3 — From source:** +**Option 2 — From source:** Requires Go `v1.23`+ and Python 3. @@ -77,6 +72,13 @@ cd cli make install ``` +**Step 2 — Install the Claude Code plugin (recommended for Claude Code users):** + +```bash +claude plugin marketplace add larksuite/cli +claude plugin install larksuite/cli@larksuite-cli-marketplace +``` + **Compatibility / fallback — install legacy standalone skills** Use this only if you cannot use the Claude plugin workflow yet. @@ -143,7 +145,7 @@ lark-cli auth login --recommend ```bash lark-cli auth status -claude plugin validate . +claude plugin list ``` ## Agent Skills diff --git a/README.zh.md b/README.zh.md index b204f964..36f01226 100644 --- a/README.zh.md +++ b/README.zh.md @@ -52,7 +52,9 @@ #### 安装 -选择 **一种** CLI 安装方式,然后安装 Claude Code 插件。 +先安装 CLI。如果你使用 Claude Code,再安装插件。 + +**第 1 步 — 安装 CLI(任选一种):** **方式一 — 从 npm 安装(推荐):** @@ -60,14 +62,7 @@ npm install -g @larksuite/cli ``` -**方式二 — 安装 Claude Code 插件(repo-first,推荐)** - -```bash -claude plugin marketplace add larksuite/cli -claude plugin install larksuite/cli@larksuite-cli-marketplace -``` - -**方式三 — 从源码安装:** +**方式二 — 从源码安装:** 需要 Go `v1.23`+ 和 Python 3。 @@ -77,6 +72,13 @@ cd cli make install ``` +**第 2 步 — 安装 Claude Code 插件(Claude Code 用户推荐):** + +```bash +claude plugin marketplace add larksuite/cli +claude plugin install larksuite/cli@larksuite-cli-marketplace +``` + **兼容 / 回退方案 — 安装旧版 standalone skills** 仅当暂时无法使用 Claude 插件工作流时再使用: @@ -143,7 +145,7 @@ lark-cli auth login --recommend ```bash lark-cli auth status -claude plugin validate . +claude plugin list ``` From c2ca7934bd047e80de086be480eb0f955c95fb8f Mon Sep 17 00:00:00 2001 From: Kim Yongbeom Date: Tue, 7 Apr 2026 15:08:01 +0800 Subject: [PATCH 3/5] docs: revert README --- README.md | 52 +++++++++++++++----------------------------------- README.zh.md | 54 ++++++++++++++++------------------------------------ 2 files changed, 31 insertions(+), 75 deletions(-) diff --git a/README.md b/README.md index da8abed7..dd9b1073 100644 --- a/README.md +++ b/README.md @@ -52,14 +52,16 @@ Before you start, make sure you have: #### Install -Install the CLI first. If you use Claude Code, then install the plugin. - -**Step 1 — Install the CLI (choose one):** +Choose **one** of the following methods: **Option 1 — From npm (recommended):** ```bash +# Install CLI npm install -g @larksuite/cli + +# Install CLI SKILL (required) +npx skills add larksuite/cli -y -g ``` **Option 2 — From source:** @@ -70,21 +72,9 @@ Requires Go `v1.23`+ and Python 3. git clone https://github.com/larksuite/cli.git cd cli make install -``` - -**Step 2 — Install the Claude Code plugin (recommended for Claude Code users):** - -```bash -claude plugin marketplace add larksuite/cli -claude plugin install larksuite/cli@larksuite-cli-marketplace -``` - -**Compatibility / fallback — install legacy standalone skills** - -Use this only if you cannot use the Claude plugin workflow yet. -```bash -npx skills add larksuite/cli -g -y +# Install CLI SKILL (required) +npx skills add larksuite/cli -y -g ``` #### Configure & Use @@ -104,28 +94,17 @@ 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 the Claude Code plugin (repo-first, recommended)** - -```bash -claude plugin marketplace add larksuite/cli -claude plugin install larksuite/cli@larksuite-cli-marketplace -``` - -**Step 2 — Install the CLI binary** +**Step 1 — Install** ```bash +# Install CLI npm install -g @larksuite/cli -``` - -**Compatibility / fallback — install legacy standalone skills** -Use this only if the Claude plugin workflow is not available yet. - -```bash -npx skills add larksuite/cli -g -y +# Install CLI SKILL (required) +npx skills add larksuite/cli -y -g ``` -**Step 3 — Configure app credentials** +**Step 2 — 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. @@ -133,7 +112,7 @@ npx skills add larksuite/cli -g -y lark-cli config init --new ``` -**Step 4 — Login** +**Step 3 — Login** > Same as above: run in the background, extract the authorization URL and send it to the user. @@ -141,11 +120,10 @@ lark-cli config init --new lark-cli auth login --recommend ``` -**Step 5 — Verify** +**Step 4 — Verify** ```bash lark-cli auth status -claude plugin list ``` ## Agent Skills @@ -308,4 +286,4 @@ When running, it calls Lark/Feishu Open Platform APIs. To use these APIs, you mu - [Feishu Privacy Policy](https://www.feishu.cn/privacy) - [Feishu Open Platform App Service Provider Security Management Specifications](https://open.feishu.cn/document/uAjLw4CM/uMzNwEjLzcDMx4yM3ATM/management-practice/app-service-provider-security-management-specifications) - [Lark User Terms of Service](https://www.larksuite.com/user-terms-of-service) -- [Lark Privacy Policy](https://www.larksuite.com/privacy-policy) +- [Lark Privacy Policy](https://www.larksuite.com/privacy-policy) \ No newline at end of file diff --git a/README.zh.md b/README.zh.md index 36f01226..9049d3d3 100644 --- a/README.zh.md +++ b/README.zh.md @@ -52,14 +52,16 @@ #### 安装 -先安装 CLI。如果你使用 Claude Code,再安装插件。 - -**第 1 步 — 安装 CLI(任选一种):** +以下两种方式**任选其一**: **方式一 — 从 npm 安装(推荐):** ```bash +# 安装 CLI npm install -g @larksuite/cli + +# 安装 CLI SKILL(必需) +npx skills add larksuite/cli -y -g ``` **方式二 — 从源码安装:** @@ -70,21 +72,9 @@ npm install -g @larksuite/cli git clone https://github.com/larksuite/cli.git cd cli make install -``` - -**第 2 步 — 安装 Claude Code 插件(Claude Code 用户推荐):** - -```bash -claude plugin marketplace add larksuite/cli -claude plugin install larksuite/cli@larksuite-cli-marketplace -``` - -**兼容 / 回退方案 — 安装旧版 standalone skills** - -仅当暂时无法使用 Claude 插件工作流时再使用: -```bash -npx skills add larksuite/cli -g -y +# 安装 CLI SKILL(必需) +npx skills add larksuite/cli -y -g ``` #### 配置与使用 @@ -100,32 +90,21 @@ lark-cli auth login --recommend lark-cli calendar +agenda ``` -## 快速开始(AI Agent) +### 快速开始(AI Agent) > 以下步骤面向 AI Agent,部分步骤需要用户在浏览器中配合完成。 -**第 1 步 — 安装 Claude Code 插件(repo-first,推荐)** - -```bash -claude plugin marketplace add larksuite/cli -claude plugin install larksuite/cli@larksuite-cli-marketplace -``` - -**第 2 步 — 安装 CLI 二进制** +**第 1 步 — 安装** ```bash +# 安装 CLI npm install -g @larksuite/cli -``` - -**兼容 / 回退方案 — 安装旧版 standalone skills** -仅当 Claude 插件工作流暂不可用时再使用: - -```bash -npx skills add larksuite/cli -g -y +# 安装 CLI SKILL(必需) +npx skills add larksuite/cli -y -g ``` -**第 3 步 — 配置应用凭证** +**第 2 步 — 配置应用凭证** > 在后台运行此命令,命令会输出一个授权链接,提取该链接并发送给用户,用户在浏览器中完成配置后命令会自动退出。 @@ -133,7 +112,7 @@ npx skills add larksuite/cli -g -y lark-cli config init --new ``` -**第 4 步 — 登录** +**第 3 步 — 登录** > 同上,后台运行,提取授权链接发给用户。 @@ -141,11 +120,10 @@ lark-cli config init --new lark-cli auth login --recommend ``` -**第 5 步 — 验证** +**第 4 步 — 验证** ```bash lark-cli auth status -claude plugin list ``` @@ -309,4 +287,4 @@ lark-cli schema im.messages.delete - [飞书隐私政策](https://www.feishu.cn/privacy) - [飞书开放平台独立软件服务商安全管理运营规范](https://open.feishu.cn/document/uAjLw4CM/uMzNwEjLzcDMx4yM3ATM/management-practice/app-service-provider-security-management-specifications) - [Lark User Terms of Service](https://www.larksuite.com/user-terms-of-service) -- [Lark Privacy Policy](https://www.larksuite.com/privacy-policy) +- [Lark Privacy Policy](https://www.larksuite.com/privacy-policy) \ No newline at end of file From 08b76e4fe957906e0f46248563cf6fb7d896bf0f Mon Sep 17 00:00:00 2001 From: Kim Yongbeom Date: Tue, 7 Apr 2026 15:10:27 +0800 Subject: [PATCH 4/5] docs: add Claude Code plugin installation instructions in both READMEs --- README.md | 12 ++++++++++++ README.zh.md | 12 ++++++++++++ 2 files changed, 24 insertions(+) diff --git a/README.md b/README.md index dd9b1073..c2800694 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,10 @@ npm install -g @larksuite/cli # Install CLI SKILL (required) npx skills add larksuite/cli -y -g + +# Another option, install Claude Code SKILL +claude plugin marketplace add larksuite/cli +claude plugin install larksuite/cli@larksuite-cli-marketplace ``` **Option 2 — From source:** @@ -75,6 +79,10 @@ make install # Install CLI SKILL (required) npx skills add larksuite/cli -y -g + +# Another option, install Claude Code SKILL +claude plugin marketplace add larksuite/cli +claude plugin install larksuite/cli@larksuite-cli-marketplace ``` #### Configure & Use @@ -102,6 +110,10 @@ npm install -g @larksuite/cli # Install CLI SKILL (required) npx skills add larksuite/cli -y -g + +# If you are Claude Code, you can install it directly +claude plugin marketplace add larksuite/cli +claude plugin install larksuite/cli@larksuite-cli-marketplace ``` **Step 2 — Configure app credentials** diff --git a/README.zh.md b/README.zh.md index 9049d3d3..81b1ba39 100644 --- a/README.zh.md +++ b/README.zh.md @@ -62,6 +62,10 @@ npm install -g @larksuite/cli # 安装 CLI SKILL(必需) npx skills add larksuite/cli -y -g + +# 或者,安装 Claude Code SKILL +claude plugin marketplace add larksuite/cli +claude plugin install larksuite/cli@larksuite-cli-marketplace ``` **方式二 — 从源码安装:** @@ -75,6 +79,10 @@ make install # 安装 CLI SKILL(必需) npx skills add larksuite/cli -y -g + +# 或者,安装 Claude Code SKILL +claude plugin marketplace add larksuite/cli +claude plugin install larksuite/cli@larksuite-cli-marketplace ``` #### 配置与使用 @@ -102,6 +110,10 @@ npm install -g @larksuite/cli # 安装 CLI SKILL(必需) npx skills add larksuite/cli -y -g + +# 如果你使用的是 Claude Code,可以直接安装 +claude plugin marketplace add larksuite/cli +claude plugin install larksuite/cli@larksuite-cli-marketplace ``` **第 2 步 — 配置应用凭证** From 84c32a63ca21e4003e5c00efa0014e2112555274 Mon Sep 17 00:00:00 2001 From: Kim Yongbeom Date: Tue, 7 Apr 2026 15:20:40 +0800 Subject: [PATCH 5/5] docs: clarify AI agent comment --- README.md | 2 +- README.zh.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c2800694..903abf7a 100644 --- a/README.md +++ b/README.md @@ -111,7 +111,7 @@ npm install -g @larksuite/cli # Install CLI SKILL (required) npx skills add larksuite/cli -y -g -# If you are Claude Code, you can install it directly +# If you are using Claude Code, you can install the plugin with the following commands: claude plugin marketplace add larksuite/cli claude plugin install larksuite/cli@larksuite-cli-marketplace ``` diff --git a/README.zh.md b/README.zh.md index 81b1ba39..d5aa356f 100644 --- a/README.zh.md +++ b/README.zh.md @@ -111,7 +111,7 @@ npm install -g @larksuite/cli # 安装 CLI SKILL(必需) npx skills add larksuite/cli -y -g -# 如果你使用的是 Claude Code,可以直接安装 +# 如果你使用的是 Claude Code,可以通过以下命令安装插件: claude plugin marketplace add larksuite/cli claude plugin install larksuite/cli@larksuite-cli-marketplace ```