lark-shared
GitHub定义lark-cli共享底座规则,涵盖身份认证、输出契约及安全操作。指导Agent处理登录态管理、权限诊断、二维码生成及高风险写入确认,确保命令执行规范与数据安全。
Trigger Scenarios
Install
npx skills add larksuite/cli --skill lark-shared -g -y
SKILL.md
Frontmatter
{
"name": "lark-shared",
"version": "1.1.0",
"metadata": {
"requires": {
"bins": [
"lark-cli"
]
}
},
"description": "Use for lark-cli setup\/auth tasks: auth login\/status\/logout, user vs bot identity, business-domain permissions (--domain, including all\/docs\/drive), missing scopes, revoking authorization, or handling _notice JSON."
}
lark-cli 共享规则
所有 lark-* skill 共享的底座:身份、认证、输出契约与高风险操作。
通用准则
-
调用前先确认用法:执行前读对应 reference 或跑
--help,别猜 flag 盲调。 -
身份决定你代表谁操作:
--as user代表用户本人(能看到、也能操作其日历、云空间/云盘/云存储等个人资源),--as bot代表应用自己,应用级操作,只能访问bot自己的资源,bot 查用户资源会返回空成功而非报错。动手前先搞清楚身份identity。身份模型和权限管理 →lark-shared-identity-and-permissions.md。 -
授权 / 配置类 URL 必须配二维码:当命令输出
verification_url、verification_uri_complete、console_url等 URL 字段时,必须用lark-cli auth qrcode生成并在回复中展示,URL 在前二维码在后;优先生成 PNG(--output),仅当用户明确要求时才使用 ASCII(--ascii)。URL 原样转发——不编解码、不加标点、不重拼 query,二维码和链接请一起展示给用户。 -
--format json(默认)下,判断成功用ok == true(或进程退出码 0),不要用code == 0:成功信封没有顶层code/msg字段,code只出现在错误信封的error内。按 OpenAPI 老格式{"code": 0, "msg": "ok"}判断会把所有成功调用误判为失败——封装写入类命令时尤其危险。JSON 输出契约 →lark-shared-output-contract.md。
安全规则
-
禁止输出密钥(appSecret、accessToken等)到终端明文。
-
写入/删除操作前必须确认用户意图。
-
目标命令支持
--dry-run时,用--dry-run预览危险请求。 -
退出码 10 是高风险确认门禁(
risk: "high-risk-write"),不是错误:停下 → 向用户确认(展示action、risk和关键参数)→ 取得用户显式同意后,将hint指出的确认 flag 追加到你原始 argv 的末尾后重试;绝不静默加确认 flag 绕过 →lark-shared-high-risk-approval.md。 -
文件路径只接受相对路径:
--file、--output、--output-dir、@file等路径参数只接受 cwd 下的相对路径,传绝对路径会报unsafe file path。数据输入(@file、大 JSON)优先用 stdin 传入,避免路径和转义问题。
Reference 强触发索引
命中任一触发条件时,MUST 在执行下一步前读取对应 reference。命中多条时按表中顺序读取,同一reference只读取一次。
| 强触发条件(命中任一即必读) | Reference |
|---|---|
查看自己是谁(user/bot)、获取当前身份详细字段信息、身份诊断、--as选择逻辑、身份延续、登录态、认证、scope、授权和权限管理、missing_scopes 或 console_url、Agent 准备发起或完成 auth login |
lark-shared-identity-and-permissions.md |
| 需要依赖 JSON 输出契约判断成功 / 失败、读取 stdout / stderr,或为命令编写脚本与封装 | lark-shared-output-contract.md |
准备执行high-risk-write(高风险操作)、判断命令风险等级、遇到退出码 exit 10、confirmation_required、确认后重试 |
lark-shared-high-risk-approval.md |
首次使用CLI需运行 lark-cli config init 完成应用配置、或 CLI 明确提示 config init --new |
lark-shared-config-init.md |
用户询问 notice、CLI版本更新、或输出含 _notice(升级 / skills 落后 / 废弃命令提示) |
lark-shared-update-notice.md |
Version History
-
755daa4
Current 2026-08-20 01:55
重构为精简核心加引用文件结构,优化高风险审批退出码10的处理逻辑,增强安全规则分组。
- a7865cd 2026-07-25 08:03


