Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
31 changes: 24 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 (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.

# 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
```

Expand Down
31 changes: 24 additions & 7 deletions README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 有哪些命令可用及如何调用的指令文件,是 Agent 使用 lark-cli 的前提。

# 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
```

Expand Down