lark-markdown

Name: lark-markdown
Author: larksuite

295kinstalls1.1kforks

How to install lark-markdown?

larksuite/cli/lark-markdown

$npx -y skills add larksuite/cli --skill lark-markdown

Installs into the current project.

Summary

飞书 Markdown：查看、创建、上传、编辑和比较 Markdown 文件。当用户需要创建或编辑 Markdown 文件、读取、修改、局部 patch 或比较差异时使用。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。

Files · 1

View on GitHub

SKILL.md

1	# markdown (v1)
2
3	CRITICAL — 开始前 MUST 先用 Read 工具读取 [`../lark-shared/SKILL.md`](../lark-shared/SKILL.md)，其中包含认证、权限处理
4
5	## 快速决策
6
7	- 身份：Markdown 文件通常属于用户云空间资源，优先使用 `--as user`。如为自动化场景，或应用已创建并持有目标文件权限，可按场景使用 `--as bot`。首次以 `user` 身份访问前执行 `lark-cli auth login`
8	- `markdown +create` / `+overwrite` 失败时，先判断是不是身份和权限问题：`bot` 更常见的是 app scope 或目标目录 ACL，`user` 更常见的是用户授权或用户 ACL；不要不加判断地来回切身份重试。
9
10	- 用户要上传、创建一个原生 `.md` 文件，使用 `lark-cli markdown +create`
11	- 用户要比较原生 `.md` 文件的历史版本差异，或比较远端 Markdown 与本地草稿，使用 `lark-cli markdown +diff`
12	- 用户要读取 Drive 里某个 `.md` 文件内容，使用 `lark-cli markdown +fetch`
13	- 用户要对 Markdown 文件做局部文本替换 / 正则替换，优先使用 `lark-cli markdown +patch`
14	- 用户要覆盖更新 Drive 里某个 `.md` 文件内容，使用 `lark-cli markdown +overwrite`
15	- 用户要先拿 Markdown 文件的历史版本号，再做比较/下载/回滚，先用 [`lark-drive`](../lark-drive/SKILL.md) 的 `lark-cli drive +version-history`
16	- 用户要把本地 Markdown 导入成在线新版文档（docx），不要用本 skill，改用 [`lark-drive`](../lark-drive/SKILL.md) 的 `lark-cli drive +import --type docx`
17	- 用户要对 Markdown 文件做rename / move / delete / 搜索 / 权限 / 评论等云空间（云盘/云存储）操作，不要留在本 skill，切到 [`lark-drive`](../lark-drive/SKILL.md)
18	- `markdown +create` / `+overwrite` 命中 `missing scope`、`permission denied`、`not found`、`quota_exceeded`、`version limit` 时，默认停止重试并按报错 hint 处理；只有 `rate_limit`、`server_error` 或临时网络错误才做有限退避重试。
19	- `markdown +create` 的目标参数不要猜：Drive 文件夹用 `--folder-token`，Wiki 节点用 `--wiki-token`。如果用户给的是 URL，可以直接传完整 URL；CLI 会归一成 token。不要把 doc/sheet/wiki URL 放进 `--folder-token` 试错。
20
21	## 核心边界
22
23	- 本 skill 处理的是 Drive 中作为普通文件存储的 Markdown，不是 docx 文档
24	- `--name` 和本地 `--file` 文件名都必须显式带 `.md` 后缀；不满足时 shortcut 会直接报错
25	- `--content` 支持：
26	- 直接传字符串
27	- `@file` 从本地文件读取内容
28	- `-` 从 stdin 读取内容
29	- `markdown +patch` 的内部语义是：先完整下载 Markdown，再本地替换，再整文件覆盖上传
30	- `markdown +patch` 不是服务端原子 patch；它是 CLI 侧编排出来的局部更新能力
31	- `markdown +patch` 当前只支持单组 `--pattern` / `--content`
32	- `markdown +patch` 替换后的最终内容不能为空；CLI 会拒绝上传空文件，因为 Drive 不支持零字节 Markdown，且空文件通常是误操作
33	- `--file` 只接受本地 `.md` 文件路径
34
35	正则替换时要特别注意 `--pattern` 的转义：
36
37	```bash
38	# BAD: 未转义正则特殊字符，可能匹配到错误位置
39	lark-cli markdown +patch --file-token boxcnxxxx --regex --pattern "version (1.0)" --content "version (2.0)"
40
41	# GOOD: 显式转义括号和点号
42	lark-cli markdown +patch --file-token boxcnxxxx --regex --pattern "version \\(1\\.0\\)" --content "version (2.0)"
43	```
44
45	## Shortcuts（推荐优先使用）
46
47	Shortcut 是对常用操作的高级封装（`lark-cli markdown +<verb> [flags]`）。有 Shortcut 的操作优先使用。
48
49	\| Shortcut \| 说明 \|
50	\|----------\|------\|
51	\| [`+create`](references/lark-markdown-create.md) \| Create a Markdown file in Drive \|
52	\| [`+diff`](references/lark-markdown-diff.md) \| Compare two remote Markdown versions, or compare remote Markdown against a local file \|
53	\| [`+fetch`](references/lark-markdown-fetch.md) \| Fetch a Markdown file from Drive \|
54	\| [`+patch`](references/lark-markdown-patch.md) \| Patch a Markdown file in Drive via fetch-local-replace-overwrite \|
55	\| [`+overwrite`](references/lark-markdown-overwrite.md) \| Overwrite an existing Markdown file in Drive \|
56
57	## 参考
58
59	- [lark-shared](../lark-shared/SKILL.md) — 认证和全局参数
60	- [lark-drive](../lark-drive/SKILL.md) — Drive 文件管理、导入 docx、move/delete/search 等

People who liked this also viewed

6 picks

Type

lark-markdown

295kinstalls1.1kforks

View on GitHub

How to install lark-markdown?

larksuite/cli/lark-markdown

$npx -y skills add larksuite/cli --skill lark-markdown

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# markdown (v1)
2
3	CRITICAL — 开始前 MUST 先用 Read 工具读取 [`../lark-shared/SKILL.md`](../lark-shared/SKILL.md)，其中包含认证、权限处理
4
5	## 快速决策
6
7	- 身份：Markdown 文件通常属于用户云空间资源，优先使用 `--as user`。如为自动化场景，或应用已创建并持有目标文件权限，可按场景使用 `--as bot`。首次以 `user` 身份访问前执行 `lark-cli auth login`
8	- `markdown +create` / `+overwrite` 失败时，先判断是不是身份和权限问题：`bot` 更常见的是 app scope 或目标目录 ACL，`user` 更常见的是用户授权或用户 ACL；不要不加判断地来回切身份重试。
9
10	- 用户要上传、创建一个原生 `.md` 文件，使用 `lark-cli markdown +create`
11	- 用户要比较原生 `.md` 文件的历史版本差异，或比较远端 Markdown 与本地草稿，使用 `lark-cli markdown +diff`
12	- 用户要读取 Drive 里某个 `.md` 文件内容，使用 `lark-cli markdown +fetch`
13	- 用户要对 Markdown 文件做局部文本替换 / 正则替换，优先使用 `lark-cli markdown +patch`
14	- 用户要覆盖更新 Drive 里某个 `.md` 文件内容，使用 `lark-cli markdown +overwrite`
15	- 用户要先拿 Markdown 文件的历史版本号，再做比较/下载/回滚，先用 [`lark-drive`](../lark-drive/SKILL.md) 的 `lark-cli drive +version-history`
16	- 用户要把本地 Markdown 导入成在线新版文档（docx），不要用本 skill，改用 [`lark-drive`](../lark-drive/SKILL.md) 的 `lark-cli drive +import --type docx`
17	- 用户要对 Markdown 文件做rename / move / delete / 搜索 / 权限 / 评论等云空间（云盘/云存储）操作，不要留在本 skill，切到 [`lark-drive`](../lark-drive/SKILL.md)
18	- `markdown +create` / `+overwrite` 命中 `missing scope`、`permission denied`、`not found`、`quota_exceeded`、`version limit` 时，默认停止重试并按报错 hint 处理；只有 `rate_limit`、`server_error` 或临时网络错误才做有限退避重试。
19	- `markdown +create` 的目标参数不要猜：Drive 文件夹用 `--folder-token`，Wiki 节点用 `--wiki-token`。如果用户给的是 URL，可以直接传完整 URL；CLI 会归一成 token。不要把 doc/sheet/wiki URL 放进 `--folder-token` 试错。
20
21	## 核心边界
22
23	- 本 skill 处理的是 Drive 中作为普通文件存储的 Markdown，不是 docx 文档
24	- `--name` 和本地 `--file` 文件名都必须显式带 `.md` 后缀；不满足时 shortcut 会直接报错
25	- `--content` 支持：
26	- 直接传字符串
27	- `@file` 从本地文件读取内容
28	- `-` 从 stdin 读取内容
29	- `markdown +patch` 的内部语义是：先完整下载 Markdown，再本地替换，再整文件覆盖上传
30	- `markdown +patch` 不是服务端原子 patch；它是 CLI 侧编排出来的局部更新能力
31	- `markdown +patch` 当前只支持单组 `--pattern` / `--content`
32	- `markdown +patch` 替换后的最终内容不能为空；CLI 会拒绝上传空文件，因为 Drive 不支持零字节 Markdown，且空文件通常是误操作
33	- `--file` 只接受本地 `.md` 文件路径
34
35	正则替换时要特别注意 `--pattern` 的转义：
36
37	```bash
38	# BAD: 未转义正则特殊字符，可能匹配到错误位置
39	lark-cli markdown +patch --file-token boxcnxxxx --regex --pattern "version (1.0)" --content "version (2.0)"
40
41	# GOOD: 显式转义括号和点号
42	lark-cli markdown +patch --file-token boxcnxxxx --regex --pattern "version \\(1\\.0\\)" --content "version (2.0)"
43	```
44
45	## Shortcuts（推荐优先使用）
46
47	Shortcut 是对常用操作的高级封装（`lark-cli markdown +<verb> [flags]`）。有 Shortcut 的操作优先使用。
48
49	\| Shortcut \| 说明 \|
50	\|----------\|------\|
51	\| [`+create`](references/lark-markdown-create.md) \| Create a Markdown file in Drive \|
52	\| [`+diff`](references/lark-markdown-diff.md) \| Compare two remote Markdown versions, or compare remote Markdown against a local file \|
53	\| [`+fetch`](references/lark-markdown-fetch.md) \| Fetch a Markdown file from Drive \|
54	\| [`+patch`](references/lark-markdown-patch.md) \| Patch a Markdown file in Drive via fetch-local-replace-overwrite \|
55	\| [`+overwrite`](references/lark-markdown-overwrite.md) \| Overwrite an existing Markdown file in Drive \|
56
57	## 参考
58
59	- [lark-shared](../lark-shared/SKILL.md) — 认证和全局参数
60	- [lark-drive](../lark-drive/SKILL.md) — Drive 文件管理、导入 docx、move/delete/search 等

People who liked this also viewed

6 picks

Type