lark-markdown

作者: larksuite

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

npx skills add https://github.com/larksuite/cli --skill lark-markdown

markdown (v1)

CRITICAL — 开始前 MUST 先用 Read 工具读取 ../lark-shared/SKILL.md,其中包含认证、权限处理

快速决策

  • 身份:Markdown 文件通常属于用户云空间资源,优先使用 --as user。如为自动化场景,或应用已创建并持有目标文件权限,可按场景使用 --as bot。首次以 user 身份访问前执行 lark-cli auth login

  • markdown +create / +overwrite 失败时,先判断是不是身份和权限问题:bot 更常见的是 app scope 或目标目录 ACL,user 更常见的是用户授权或用户 ACL;不要不加判断地来回切身份重试。

  • 用户要上传、创建一个原生 .md 文件,使用 lark-cli markdown +create

  • 用户要比较原生 .md 文件的历史版本差异,或比较远端 Markdown 与本地草稿,使用 lark-cli markdown +diff

  • 用户要读取 Drive 里某个 .md 文件内容,使用 lark-cli markdown +fetch

  • 用户要对 Markdown 文件做局部文本替换 / 正则替换,优先使用 lark-cli markdown +patch

  • 用户要覆盖更新 Drive 里某个 .md 文件内容,使用 lark-cli markdown +overwrite

  • 用户要先拿 Markdown 文件的历史版本号,再做比较/下载/回滚,先用 lark-drivelark-cli drive +version-history

  • 用户要把本地 Markdown 导入成在线新版文档(docx),不要用本 skill,改用 lark-drivelark-cli drive +import --type docx

  • 用户要对 Markdown 文件做rename / move / delete / 搜索 / 权限 / 评论等云空间(云盘/云存储)操作,不要留在本 skill,切到 lark-drive

  • markdown +create / +overwrite 命中 missing scopepermission deniednot foundversion limit 时,默认停止重试并按报错 hint 处理;只有 rate limit 或临时网络错误才做有限重试。

核心边界

  • 本 skill 处理的是 Drive 中作为普通文件存储的 Markdown,不是 docx 文档
  • --name 和本地 --file 文件名都必须显式带 .md 后缀;不满足时 shortcut 会直接报错
  • --content 支持:
    • 直接传字符串
    • @file 从本地文件读取内容
    • - 从 stdin 读取内容
  • markdown +patch 的内部语义是:先完整下载 Markdown,再本地替换,再整文件覆盖上传
  • markdown +patch 不是服务端原子 patch;它是 CLI 侧编排出来的局部更新能力
  • markdown +patch 当前只支持单组 --pattern / --content
  • markdown +patch 替换后的最终内容不能为空;CLI 会拒绝上传空文件,因为 Drive 不支持零字节 Markdown,且空文件通常是误操作
  • --file 只接受本地 .md 文件路径

正则替换时要特别注意 --pattern 的转义:

# BAD: 未转义正则特殊字符,可能匹配到错误位置
lark-cli markdown +patch --file-token boxcnxxxx --regex --pattern "version (1.0)" --content "version (2.0)"

# GOOD: 显式转义括号和点号
lark-cli markdown +patch --file-token boxcnxxxx --regex --pattern "version \\(1\\.0\\)" --content "version (2.0)"

Shortcuts(推荐优先使用)

Shortcut 是对常用操作的高级封装(lark-cli markdown +<verb> [flags])。有 Shortcut 的操作优先使用。

Shortcut说明
+createCreate a Markdown file in Drive
+diffCompare two remote Markdown versions, or compare remote Markdown against a local file
+fetchFetch a Markdown file from Drive
+patchPatch a Markdown file in Drive via fetch-local-replace-overwrite
+overwriteOverwrite an existing Markdown file in Drive

参考

  • lark-shared — 认证和全局参数
  • lark-drive — Drive 文件管理、导入 docx、move/delete/search 等

來自 larksuite 的更多技能

lark-doc
larksuite
飛書雲文檔 / Docx / 知識庫 Wiki 文檔(v2):建立、開啟、讀取、取得、檢視、總結、整理、改寫、翻譯、審閱和編輯飛書文檔內容。當使用者提供飛書文檔 URL/token,或要求檢視/讀取/開啟某個文檔、提取文檔內容、總結文檔、生成/建立文檔、追加/取代/刪除/移動內容、調整排版、插入或下載文檔圖片/附件/素材/畫板縮圖時使用。文檔內容中出現嵌入試算表、多維表格、需要將重要資訊視覺化為畫板(含 SVG 畫板)、引用或同步區塊時,也先使用本 skill 讀取和提取 token,再切換至對應 skill 深入處理。使用本 skill 時,docs +create、docs +fetch、docs +update 必須攜帶 --api-version v2;預設使用 DocxXML,也
documentapiproductivity
lark-im
larksuite
飛書即時通訊:收發訊息和管理群聊。發送和回覆訊息、搜尋聊天記錄、管理群聊成員、上傳下載圖片和檔案(支援大檔案分片下載)、管理表情回覆。當用戶需要發訊息、查看或搜尋聊天記錄、下載聊天中的檔案、查看群成員、搜尋群、建立群聊或話題群、管理標記資料時使用。
communicationproductivityapi
lark-shared
larksuite
首次設定 lark-cli、執行 auth login、切換使用者/機器人身份(--as)、處理權限拒絕或範圍錯誤、需要更新 lark-cli,或是在 JSON 輸出中看到 _notice 時使用。
developmentapicommunication
lark-base
larksuite
當需要用 lark-cli 操作飛書多維表格(Base)時調用:搜尋 Base、建表、欄位管理、記錄讀寫、記錄分享連結、檢視配置、歷史查詢,以及角色/表單/儀表板管理/工作流程;也適用於把舊的 +table / +field / +record 寫法改成當前命令寫法。涉及欄位設計、公式欄位、查找引用、跨表計算、行級派生指標、資料分析需求時也必須使用本 skill。
databasedata-analysisapi
lark-drive
larksuite
飛書雲空間:管理雲端空間中的檔案與資料夾。可上傳與下載檔案、建立資料夾、複製/移動/刪除檔案、檢視檔案元資料、管理文件評論、管理文件權限、訂閱使用者評論變更事件、修改檔案標題(docx、sheet、bitable、file、folder、wiki);同時也負責將本機的 Word/Markdown/Excel/CSV 以及 Base 快照(.base)匯入為飛書線上雲端文件(docx、sheet、bitable)。當使用者需要上傳或下載檔案、整理雲端空間目錄、檢視檔案詳細資訊、管理評論、管理文件權限、修改檔案標題、訂閱使用者評論變更事件,或將本機檔案匯入為新版文件、電子表格、多維表格/Base 時使用。
documentproductivityapi
lark-whiteboard
larksuite
飛書畫板:查詢和編輯飛書雲文檔中的畫板。支援匯出畫板為預覽圖片、匯出原始節點結構、使用多種格式更新畫板內容。當用戶需要查看畫板內容、匯出畫板圖片、編輯畫板時使用此 skill。不負責:飛書雲文檔內容編輯(lark-doc)、文檔內嵌電子表格/Base(lark-sheets / lark-base)。
documentcreativeproductivity
lark-mail
larksuite
飛書郵箱 — 起草、撰寫、發送、回覆、轉發、閱讀及搜尋郵件;管理草稿、資料夾、標籤、聯絡人、附件及郵件規則。當使用者提及 起草郵件、寫一封郵件、擬郵件、草稿、發通知郵件、發送郵件、發郵件、回覆郵件、轉發郵件、查看郵件、看郵件、讀郵件、搜尋郵件、查郵件、收件箱、郵件會話、編輯草稿、管理草稿、下載附件、郵件資料夾、郵件標籤、郵件聯絡人、監聽新郵件、收信規則、郵件規則、draft、compose、send email、reply、forward、inbox、mail thread、mail rules 時使用。
communicationproductivityapi
lark-workflow-meeting-summary
larksuite
會議紀要整理工作流:彙總指定時間範圍內的會議紀要並生成結構化報告。當用戶需要整理會議紀要、生成會議週報、回顧一段時間內的會議內容時使用。
productivitydocumentcommunication