New to Claude Skills? Learn how to install them →

larksuite on GitHub

Lark Sheets

Free

Create and manage spreadsheets with Lark Suite.

by larksuite16.3k stars on larksuite/cli
1 views
Updated Aug 10, 2026
Get this skill

Free · Opens the source repo

What Lark Sheets does

Lark Sheets is a powerful tool designed for creating and manipulating spreadsheets within the Lark Suite ecosystem. It allows users to perform a variety of operations such as creating new spreadsheets, managing the structure of worksheets, and reading and writing cell data, including values, formulas, styles, and comments. The skill supports batch updates and provides functionalities for statistical analysis and data visualization through charts, pivot tables, and conditional formatting. This makes it particularly useful for users who need to manage financial models, perform data analysis, or enhance the aesthetic presentation of their spreadsheets.

The skill emphasizes best practices for spreadsheet management, ensuring that changes are made with minimal disruption to existing data. Users are guided to maintain the integrity of their spreadsheets by following strict editing guidelines, such as ensuring that only necessary cells are modified and that any updates are verified through read-back checks. This helps prevent errors and ensures that the data remains accurate and reliable.

Lark Sheets is ideal for developers and data analysts who frequently work with spreadsheets and require a robust set of tools for data manipulation and visualization. Its capabilities extend to complex tasks like formula translation and verification, making it suitable for users transitioning from other spreadsheet applications like Excel. The skill also provides a structured approach to managing data, ensuring that users can efficiently handle large datasets without compromising on quality or accuracy.

Whether you need to create a new workbook, update existing data, or generate reports, Lark Sheets offers a comprehensive suite of commands that streamline these processes. Its focus on data integrity and user-friendly operations makes it a valuable addition for anyone looking to enhance their productivity within the Lark Suite environment.

When to use it

Use Lark Sheets when you need to create, update, or analyze spreadsheets within the Lark Suite, especially for financial modeling or data visualization tasks.

When not to use it

This skill is not suitable for users looking to search for files in cloud storage; for that, use the Lark Drive skill instead.

What you can build with it

Creating a New Spreadsheet

Use Lark Sheets to create a new spreadsheet and define its structure, including rows and columns.

Updating Existing Data

Efficiently update values, formulas, and styles in an existing spreadsheet while maintaining data integrity.

Generating Charts and Pivot Tables

Utilize Lark Sheets to create visual representations of your data through charts and pivot tables for analysis.

How to install Lark Sheets

View source

1. Install with the skills CLI

npx skills add larksuite/cli/lark-sheets --agent claude-code

2. Or install it manually

Download the skill folder and drop it into ~/.claude/skills/ for all projects, or .claude/skills/ to scope it to one repo. Restart Claude Code so it picks up the new skill.

Anthropic's agentic coding CLI, and the reference implementation of Agent Skills. Drop a skill folder into ~/.claude/skills and Claude Code loads it automatically whenever a task matches the skill's description. Claude Code docs

Inside SKILL.md

Written by larksuite

sheets

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

术语约定

同一对象的交替说法,按此映射解析用户口语:工作表(sheet)= 子表 / tab / 标签页(sheet_id 是稳定标识);电子表格(spreadsheet)= 工作簿 / 表格(顶层容器,由 --url--spreadsheet-token 定位);reference_id = 表内对象的稳定标识,即各对象主键 flag 接受的值(与 --image-uri 图片上传句柄不是一回事)。

每类对象用各自的主键 flag 定位(命名不统一,按此表对照,不要凭直觉拼):

对象主键 flag对象主键 flag
工作表 sheet--sheet-id条件格式规则--rule-id
图表 chart--chart-id筛选视图--view-id
透视表 pivot--pivot-table-id迷你图(按组)--group-id
浮动图片--float-image-id

飞书表格编辑准则(动手前必守,所有编辑类任务一律生效)

下列准则横切所有任务,动手前先过一遍——被索引直接路由进某个工具参考也一律生效;展开与边界见括注的 reference。

  1. 最小改动:除任务要改的单元格 / 列外,原表其它单元格、行列结构、Sheet 名、合并区、格式 1:1 保持;中间结果放原数据右侧或新建空白 Sheet,禁止删 / 改名 / 隐藏 / 移动已存在 Sheet;改写类任务精确圈定行列,不该转的原值 1:1 保留。
  2. 真实写回 + 回读校验:交付必须是对在线表格的真实写入,写完用 +csv-get / +cells-get / +<对象>-list 回读确认实际生效——写操作返回 ok 只代表请求被接受、不代表结果符合预期;写公式后查错误码、筛选 / 排序后核对前几行、删除 / 清空后确认已空。禁止只在文本里声称"已完成"。
  3. 读全再写:批量填充 / 补齐 / 修正类任务先确认真实数据末行再写,只探前 N 行会漏写表尾(确定末行流程见 lark-sheets-read-data)。
  4. 公式优先于硬编码:能用公式表达的计算(总计 / 占比 / 提取 / 查找)一律写公式而非静态值——凡可由表内其它单元格推导的派生值默认用公式,即使用户没说"联动";写公式前先读 lark-sheets-formula-translation公式落表后收尾必跑 +formula-verify 直到 status='success'
  5. 续写 / 扩展继承样式:续写、补齐、复制区块、新增行列时禁止只读值只写值,必须连带 cell_styles + border_styles + 合并 + 行高一起继承(清单见 lark-sheets-write-cells,四边框最易漏)。
  6. 多步写入分流:美化收尾(样式 / 合并 / 行高列宽 / 冻结的任意组合)→ 一次 +styles-put 声明式规格交付(见 lark-sheets-styles-put);同一个写操作打多个区域 → 用该命令自身的复数形态(--ranges / map 入参);只有跨类型、有顺序依赖的操作链(如插列 → 写表头 → 回填数据)才用 +batch-update(high-risk-write:按下方审批协议先获用户同意再带 --yes;fail-fast 不回滚,语义见 lark-sheets-batch-update)。
  7. 分组汇总用透视表:"按 X 统计 Y / 分组汇总 / 各类数量金额"用 +pivot-{create|update|delete},禁止用 SUMIF / 本地脚本拼一张假透视表。
  8. 拆成可验证 checklist:落地前把指令拆成所有"独立可验证子要点",逐点 assert 全过才交付(多维排序每维一点、多目标每目标一点、范围类核起 / 末 / 边界);只做第一个要点属违规。
  9. 全量处理前置断言条数:翻译 / 打标 / 批量公式落地等逐条任务,先把预期条数硬编码再 assert actual == expected,禁止输出"已完成前 N 条,剩余继续"的半成品。
  10. 缺失值不编造:补齐 / 扩展 / 按原表格式续填时,查不到或无法确定的值一律留空 + 备注注明("暂未发布 / 未知 / 待核实"),禁止用推算值 / 估算值 / 凭空数据充数;原表若已示范缺失值写法(空值 + 备注),照抄该约定。宁可留空标注,不填不可靠的数。

端到端工作流:了解结构(scripts/lark_inspect_workbook.py / +workbook-info)→ 读数据 → 理解语义 → 原生工具优先 → 写入 → 回读验证;实操展开见下方「执行要点」。

场景 → 命令速查(拿不准命令名先查这里,别按直觉拼)

把高频意图映射到真实存在的 shortcut / flag(agent 常从 Excel / Google Sheets / OpenAPI 误迁移命令名)。选定命令后先读「动手前读」列指向的 reference 再动手——命令名对得上不代表用法对。

你要做的事✅ 正确写法动手前读❌ 不存在(会被 cobra 拒)
读数据(纯值 / CSV)+csv-get--range 可省略 = 读整个子表,无需先探行列;限定范围才传)lark-sheets-read-data+get-range+range-get+cells-read
读值 + 公式 / 样式 / 批注+cells-get --include value,formula,style,comment,data_validationlark-sheets-read-data+get-cell+cell-get--with-styles--with-merges--include-merged-cells
写纯文本值(整块 CSV 平铺;列里没有需字面保真的编号 / 点分日期)+csv-put(定位用 --start-cell 左上角锚点格,也接受 --range 别名)lark-sheets-write-cells把含点分日期(12.10)/编号(001)的列裸灌 +csv-put——会被数值化(12.1012.10011),改用 +table-put 声明 dtypes:object
写带类型的数据到已有表(列里有数字 / 金额 / 百分比 / 日期等量值——不看当下要不要排序求和,量值一律走这里)+table-put --sheets '{"sheets":[{"name":…,"columns":[…],"dtypes":{…},"formats":{…},"data":[[…]]}]}'(不存在的 sheet 名自动建子表;同时美化加 --styles 一步带样式,详见 write-cells)lark-sheets-write-cells在本地把数字拼成 "$1,234" / "30.5%" 字符串再 +csv-put(落成文本、丢计算能力,见下方 ⚠️)
新建电子表格并写带类型的数据(类型保真需求同上,但目标表还不存在)+workbook-create --sheets(协议与 +table-put 同构、一步建表 + typed 写入,无需先建空表再 +table-put;date / number 不丢;--styles 同样可在建表同一步带全套样式,详见 workbook)lark-sheets-workbook--values 灌日期 / 数字(会落成文本、丢类型)
写公式 / 富写入(样式 · 批注 · 图片 · 富文本),或需精确矩形定位的值+cells-set(单区域 --range+--cells散布多处 / 跨表用 --writes 一次批量交付,每项自带 sheet_name;公式落表后继续 +formula-verify 收尾)lark-sheets-write-cells
插图:图片绑定到某条记录、随行走(凭证 / 证件照 / 商品图 / 头像 / 二维码 / 每行配图)+cells-set-image(单格 --range,嵌入单元格内)lark-sheets-write-cells
插图:自由摆放、不绑数据的装饰 / 标识(logo / 水印 / 封面大图 / banner)+float-image-create(浮动图片,自由定位 + 尺寸 + 层级)lark-sheets-float-image
查找 / 替换文本+cells-search(找,关键字用 --find)、+cells-replace(替换)lark-sheets-search-replace+cells-find+find--query
看子表结构(合并 / 行高列宽 / 冻结 / 隐藏)+sheet-infolark-sheets-sheet-structure+sheet-get+structure-get+sheet-structure-get
看工作簿 / 子表清单+workbook-infolark-sheets-workbook+sheet-list+workbook-get+workbook-list
复核某次(AI)编辑改了什么 / 取两个版本间的变更+changeset-get --start-revision <编辑前版本>(省略 --end-revision 取到最新;版本差 ≤ 20)lark-sheets-changeset
取当前文档 revision(版本号)+revision-getlark-sheets-workbook
导出 xlsx / 单表 csv+workbook-exportlark-sheets-workbook
导入本地 xlsx/xls/csv 文件为飞书电子表格+workbook-import --file ./x.xlsx(仅要导成多维表格 bitable 时才用 drive +import --type bitablelark-sheets-workbookdrive +import(绕路)、本地读 .xlsx 再 +workbook-create 重灌(多此一举)、想并入已有工作簿却用它(import 只会另起新表,加子表走 +sheet-copy / +sheet-create
参考某个已有在线表、把多份数据各作为一张子表追加进去+workbook-info+sheet-copy 复制模板子表(公式 / 合并 / 底色 / 列宽全继承)再 +cells-* 只改数据;无模板可继承时 +sheet-create + +table-put --sheets/--styleslark-sheets-workbook+workbook-import / +workbook-create 另起独立新表(这两条只产新表、不接受已有表定位)
已有表美化收尾(样式 / 边框 / 合并 / 行高列宽 / 冻结的任意组合,单表或多表)+styles-put --styles '{"styles":[{"name":…,"cell_styles":[…],"cell_merges":[…],"row_sizes":[…],"col_sizes":[…],"freeze":{…}}]}'(一份规格一次交付,词汇同 +table-put --styleslark-sheets-styles-put+batch-update--operations 子操作数组做美化、逐区域多次 +cells-set-style
清除内容 / 格式+cells-clear(high-risk-write 需用户确认后带 --yes;范围维度用 --scope,取值 content / formats / all)lark-sheets-range-operations--type
批量清除多区域+cells-batch-clear(high-risk-write 需用户确认后带 --yes--scopelark-sheets-batch-update--target
调整列宽 / 行高+cols-resize / +rows-resize(行、列是两个独立命令;连同样式一起调时并入 +styles-putrow_sizes / col_sizeslark-sheets-range-operations--dimension(无此 flag)
分组汇总 / 透视+pivot-create(默认不传落点 flag → 自动新建子表,零覆盖)lark-sheets-pivot-table用 SUMIF / 本地脚本拼一张假透视表
画图表 / 可视化(柱 / 折线 / 饼 / 条 / 散点 / 组合…)+chart-create(先 +chart-create --print-example <column|bar|line|pie|combo…> 本地拿最小可用 --properties 模板,改 refs / index 即可用)lark-sheets-chartmatplotlib / 本地画图再贴图(原生图表可交互、随数据更新)
条件高亮 / 数据条 / 色阶 / 重复值标记+cond-format-createlark-sheets-conditional-format+highlight+conditional-format、逐格 +cells-set-style 硬凑
筛选 / 只看符合条件的行+filter-createlark-sheets-filterpandas filter 后覆盖写回(会毁原数据;要保存多份筛选状态用 +filter-view-create

⚠️ 动手前的触发式必读(按动作判定,不看主场景):动作里含样式 / 美化(底色 / 边框 / 字号 / 对齐 / 数字格式 / 配色 / 列宽行高)→ 先读 lark-sheets-visual-standards要写飞书公式 → 先读 lark-sheets-formula-translation,写完跑 +formula-verify 收尾(见 lark-sheets-formula-verify)。主任务是建表 / 录入也一样适用。 ⚠️ 两种图片别选错:图绑定某条记录、随行走(凭证 / 证件照 / 每行配图)→ +cells-set-image;自由摆放的装饰(logo / 水印 / 封面)→ +float-image-create。别因「浮动图更熟」默认选浮动图。 ⚠️ 纯文本还是数值语义(看数据本质,不看当下用途):金额 / 百分比 / 日期 / 计数等量值一律数值写入——常规二维表用 +table-putdtypes + formats),宽表 / 合并表头版式用 +cells-set 传数字(百分比传小数 0.4)+ number_format。只有编号 / 身份证等标识符+csv-put 平铺。"只是展示不用算 / 样式以后再刷"不构成把量值写成字符串的理由——类型不能后补。判据见 lark-sheets-write-cells「数字还是文本」。 ⚠️ 要新建子表 / 整表美化 → 别「+csv-put 写值再事后刷样式」+table-put / +workbook-create--styles 在写数据同一步带全套样式(底色 / 边框 / 列宽行高 / 合并 / 冻结),payload 里不存在的 sheet 名自动建子表,纯文本表同样适用;比事后多次刷样式少好几次调用。存量表事后美化则一次 +styles-put 交付(同一份 --styles 词汇)。 ⚠️ 定位 flag+cells-get / +cells-set / +csv-get--range+csv-put--start-cell(也接受 --range 别名,区间取左上角)。 ⚠️ 读取附加信息一律走 +cells-get --include …(无 --with-styles 这类 flag);看合并单元格+sheet-infomerged_cells

💡 高频写命令签名(照抄改参即可;各命令 --help 的 Tips 段有同款示例)

lark-cli sheets +cells-set --url <U> --sheet-name S1 --range A1:B1 --cells '[[{"value":"名称"},{"formula":"=SUM(B2:B9)"}]]'  # --cells 恒为二维数组 [[…]],单格也是 [[{…}]]
lark-cli sheets +cells-set-style --url <U> --sheet-name S1 --range A1:D1 --font-weight bold --background-color "#F0F0F0" --horizontal-alignment center
lark-cli sheets +styles-put --url <U> --styles - <<'JSON'
{"styles":[{"name":"S1","cell_styles":[{"range":"A1:D1","font_weight":"bold","background_color":"#F0F0F0"}],"col_sizes":[{"range":"A:D","type":"pixel","size":120}],"freeze":{"rows":1}}]}
JSON
lark-cli sheets +batch-update --url <U> --dry-run --operations - <<'JSON'   # high-risk:先 --dry-run 给用户看,同意后原样重发并追加 --yes
[{"shortcut":"+cells-set","input":{"sheet_name":"S1","range":"A1","cells":[[{"value":"x"}]]}}]
JSON
lark-cli sheets +dim-freeze --url <U> --sheet-name S1 --rows 1 --cols 2  # 一次给全;冻结是整份状态覆盖,没写的轴即为不冻结
lark-cli sheets +dim-insert --url <U> --sheet-name S1 --position 3 --count 2 --inherit-style before  # 行/列由 --position 决定:数字=行、字母=列,无 --dimension
lark-cli sheets +cols-resize --url <U> --sheet-name S1 --range A:C --width 120  # 像素;分列不同宽用 --widths '{"A":80,"C:E":120}'
lark-cli sheets +sheet-copy --url <U> --sheet-name 源表名 --title 副本名  # --sheet-name=源表、--title=新表名

执行要点(读取 / 原生工具 / 陷阱)

读取:按需求选路径(细则见 lark-sheets-read-data

用户需求读取路径
"完善 / 补齐 / 修正所有 XX"、分析 / 清洗 / 大数据scripts/lark_profile_table.py 确认目标区域与字段画像,再原生优先(公式 / +pivot / +filter);表达不了再分批 +csv-get 导出 + 脚本处理 + 分批回写(默认覆盖所有对应数据行)
"查一下 / 统计 / 汇总"等只读小表 +csv-get 读到上下文;大表先 +workbook-info + 小窗口 +csv-get 定边界,再对未截断窗口跑 scripts/lark_detect_subtables.py / scripts/lark_profile_table.py
需要公式 / 样式 / 批注+cells-get
续写 / 扩展已有内容+csv-get 看结构 + +cells-get 读源区样式 + +sheet-info --include row_heights,merges(见准则 5)

"补齐 / 填空"类只探前 10 行就写会漏写表尾——先按 lark-sheets-read-data 确认真实数据末行(准则 3)。

计算:原生工具优先,代码兜底(强化准则 7)

用户需求用原生禁止的替代
按 X 统计 Y、分组汇总+pivot-{create|update|delete}pandas groupby → 写值
求和 / 计数 / 平均 / 占比公式Python 算 → 写静态值
图表 / 可视化+chart-*matplotlib
条件高亮 / 色阶+cond-format-*逐格设样式
筛选+filter-*pandas filter → 覆盖写入
文本提取 / 转换 / 查找公式(REGEXEXTRACT / TEXT / VLOOKUP 等)Python → 写静态值

只有多步清洗、统计建模、公式试错 3 次仍失败时才用代码。

用脚本配合 CLI 时

  • 只读 stdout:CLI 数据走 stdout、诊断走 stderr;解析 JSON 别 2>&1(警告混入会解析失败),用管道或单独重定向 stdout。
  • 读表理解优先用 scripts/lark_*.py(若可用)lark_inspect_workbook.py / lark_detect_subtables.py / lark_profile_table.py 是只读脚本,用来把在线表格整理成结构摘要。可选增强,不是必经步骤——scripts/ 只随仓库版 skill 分发,二进制内嵌版没有这些文件;本地不存在时直接用 CLI 等价路径(对照表见 lark-sheets-read-data+workbook-info / +sheet-info / 小窗口 +csv-get)。它们不替代写入类 shortcut;确认目标区域后,写入仍按对应 reference 执行。
  • 喂 CLI 的 CSV / JSON 用 UTF-8 无 BOM;临时文件放系统临时目录、勿落项目目录。
  • 命令失败先读 stderr 再调整,别原样重发。
  • 回写纯单元格值:剥离 值(V-Align: bottom) 这类"值(样式)"串与残留引号再写;排序优先 +range-sort 原生工具,别"读出本地排完再整列写回"。

易漏陷阱

  • +dim-insert 不继承行高:只继承值 / 公式 / 边框;插行填长文本前读相邻行 row_height,用 +batch-update+rows-resize 补齐。
  • 公式容错:日期 / 查找 / 转换公式用 IFERROR 包裹;写完查首末各 5 行错误码,再跑 +formula-verifystatus='success';同一方案试错上限 3 次。
  • 循环引用:聚合公式引用范围不能含目标 cell 自身或其传递依赖。
  • 隐藏行列+csv-get 默认含隐藏行列;--skip-hidden=true 只看可见,真实行号会跳空——禁止按返回数组下标推导行号,用 annotated_csv[row=N]row_indices
  • 跨 sheet 对象:图表 / 条件格式 / 透视表 / 浮动图片可能分布在多个子表,先 +workbook-info 掌握全局。
  • NLP 任务分批:语义理解 / 翻译 / 打标用 NLP 处理(代码只做分批 / 行号映射 / 写回);大数据量分批(约 30 行 / 批)即时写回,多批用 +batch-update

References

reference 分两组:先读通用方法与规范(横切所有任务的样式 / 公式规则),再按操作对象进入工具参考查具体 shortcut。编辑类任务务必先过通用方法与规范,连同上方「飞书表格编辑准则」对所有工具参考一律生效。

通用方法与规范(先读,横切所有任务,不含具体 shortcut)

Reference描述
飞书表格样式与配色规范飞书表格样式与配色规范:表头/数据区/汇总行的颜色、字号、对齐、边框、数字格式等取值标准,以及从零新建表格的版式美化、新增汇总行、追加行列继承原表风格、已有区域美化等典型场景的决策流程与样式要点。工具调用参数细节请参考对应的 lark-sheets-write-cells / lark-sheets-range-operations / lark-sheets-batch-update。条件格式(高亮、标红、数据条、色阶)请使用 lark-sheets-conditional-format。
飞书表格公式生成规则Excel 公式到飞书表格公式的迁移与生成规则。核心目标不是保留 Excel 原语法,而是按飞书表格可执行规则重写公式,并在结果上尽量对齐 Excel。当用户要求把 Excel 公式改写成飞书表格公式,或需要生成飞书公式(尤其涉及 ARRAYFORMULA、原生数组函数、INDEX/OFFSET、MAP/LAMBDA、日期差、多层范围结果与二次展开)时使用。本文只负责把公式写对,落表后的强制收尾请接 lark-sheets-formula-verify

按对象的工具参考(含 shortcut)

Reference描述
Lark Sheet Formula Verify公式写入 / 批量填充 / --copy-to-range 扩展 / 导入含公式工作簿后的强制自检入口。对指定子表(或整本工作簿)扫描公式与单元格值,聚合所有 Excel 错误(#REF! / #DIV/0! / #VALUE! / #NAME? / #NULL! / #NUM! / #N/A),同时合并最近一次写入留下的编译失败(formula_errors),输出统一 JSON 让 AI 一次拿到完整健康度报告。只要任务涉及写公式,落表后就应调用 +formula-verify 收敛到 zero-error;status='errors_found'status='partial' 时禁止把链路标为完成。
Lark Sheet Workbook管理飞书表格的工作簿结构(子表列表及元数据)。当用户提到"看看这个表格有什么"、"表格结构"、"有哪些 sheet"、"新建一个 sheet"、"删除这个工作表"、"重命名"、"复制一份"、"移动到前面"时使用。
Lark Sheet Sheet Structure管理飞书表格的子表结构与布局。适用场景:查看行高、列宽、隐藏行列、合并单元格等布局信息,以及"插入一行"、"删除这列"、"隐藏行"、"冻结表头"、行列分组(大纲折叠/展开)等操作。行列大纲仅在用户明确提到"行分组"、"列分组"、"大纲"、"outline"时才触发,"按XXX分组"等数据分组场景请使用 lark-sheets-pivot-table。如需在表尾追加数据,应先通过此 skill 插入行,再通过 lark-sheets-write-cells 写入。
Lark Sheet Read Data读取飞书表格中的单元格数据。当用户需要"看看数据"、"分析数据"、"统计/汇总"时使用;也适用于需要查看公式、样式、批注等详细信息的场景。
Lark Sheet Search & Replace在飞书表格中搜索和替换文本,支持限定范围、大小写匹配、精确匹配、正则表达式。当用户需要"查找"、"搜索"、"定位"某个值,或"替换"、"批量修改文本"、"把 A 改成 B"时使用。不要用于理解表格结构(应读取数据)、不要用于数据分析(应读取数据后计算)、不要把用户操作动作中的关键词(如"汇总金额""统计数量")当作搜索词。
Lark Sheet Write Cells向飞书表格的指定区域批量写入值、公式、样式、批注或单元格图片。适用场景:填写数据、设置公式、修改格式、添加批注、嵌入单元格图片(如需操作浮动图片,请使用 lark-sheets-float-image);若只需把一块 CSV 批量铺到表格上(值或公式,不带样式/批注),直接使用 +csv-put 更短更快。追加数据需先通过 lark-sheets-sheet-structure 插入行列。只要这次写入真实落了公式,收尾默认继续执行 lark-sheets-formula-verify
Lark Sheet Range Operations对飞书表格中指定区域执行结构性操作(不涉及写入单元格数据值)。适用场景:清除内容或格式("清空"、"删除内容"、"去掉格式")、合并/取消合并单元格、调整行高列宽("加宽列"、"自适应列宽")、移动/复制/填充/排序数据("移动数据"、"复制到"、"自动填充"、"按某列排序")。写入单元格数据请使用 lark-sheets-write-cells。
Lark Sheet Styles Put把一份声明式视觉规格(样式/边框/合并/行高列宽/冻结)一次性应用到已有飞书表格的多个子表,整份规格一次提交。当任务是对存量表做美化收尾、批量刷样式、统一版式时使用。样式取值标准见 lark-sheets-visual-standards;建新表带样式走 lark-sheets-workbook(+workbook-create --styles)、写数据同步带样式走 lark-sheets-write-cells(+table-put --styles),三者共用同一份 --styles 词汇。仅针对飞书表格。
Lark Sheet Batch Update将多个飞书表格写入操作合并为一次批量执行,按顺序依次完成。适合需要连续执行多个写入操作的场景(如先修改结构再写入数据)。
Lark Sheet Chart管理飞书表格中的图表(柱形图、折线图、饼图、条形图、面积图、散点图、组合图、雷达图等)。当用户需要创建图表、修改图表样式或数据源、查看已有图表配置、删除图表时使用。也适用于用户提到"数据可视化"、"画个图"、"趋势分析"、"对比图"、"占比分析"、"做个图表"等数据可视化相关场景。
Lark Sheet Pivot Table管理飞书表格中的数据透视表。当用户需要创建透视表、修改透视表的行列字段/聚合方式/筛选条件、查看已有透视表配置、删除透视表时使用。也适用于用户提到"分组汇总"、"交叉分析"、"按XXX统计"、"按字段分组"、"再分下组"、"多维分析"、"数据透视"等场景。
Lark Sheet Conditional Format管理飞书表格中的条件格式规则(重复值高亮、单元格值比较、数据条、色阶、排名、自定义公式等)。当用户需要创建条件格式、修改已有规则的范围或样式、查看当前条件格式配置、删除规则时使用。也适用于用户提到"高亮"、"标红"、"颜色标记"、"数据条"、"色阶"、"条件样式"等场景。
Lark Sheet Filter管理飞书表格中的筛选器(filter)。当用户需要筛选数据(按文本/数值/颜色/日期条件过滤行)、查看已有筛选配置、修改或删除筛选器时使用。也适用于"只看"、"筛选出"、"仅保留符合条件的"等场景。
Lark Sheet Filter View管理飞书表格中的筛选视图(filter view)。当用户需要"建一个 XX 视图"、"保存这个筛选状态"、"切换不同筛选"、维护一个 sheet 上多份独立筛选配置时使用。视图与筛选器(filter)相互独立,可在同一 sheet 共存;视图的隐藏行仅在用户进入该视图时本地生效,不影响其他协作者。
Lark Sheet Sparkline管理飞书表格中的迷你图(折线迷你图、柱形迷你图、胜负迷你图)。当用户需要在单元格内嵌入小型图表来展示数据趋势时使用。也适用于"趋势线"、"单元格内图表"、"迷你图"等场景。注意:不等同于被禁用的 SPARKLINE() 公式函数。
Lark Sheet Float Image管理飞书表格中的浮动图片。当用户需要在表格中插入浮动图片、调整图片位置和大小、查看已有浮动图片、删除图片时使用。也适用于"插入图片"、"添加 logo"、"放一张图"等场景。注意:如果用户需要将图片嵌入到某个单元格内部(单元格图片),请阅读 lark-sheets-write-cells。
Lark Sheet History查询飞书表格的历史版本并回滚到指定版本。当用户需要查看一张表的编辑历史版本列表、回滚到某个历史版本、或查询回滚的异步状态(进行中/成功/失败)时使用。回滚为异步操作,发起后通过状态查询轮询结果。仅针对飞书表格。
Lark Sheet Changeset读取两个版本(CS revision)之间的 changeset(原始变更操作清单),用于复核某次编辑——尤其是 AI 编辑——是否真实满足用户诉求。传入起始版本(编辑前基线),可选结束版本(省略取最新),版本差上限 20;返回里最外层带当前表格最新版本号。当用户需要"看看这次改了什么"、"核对 AI 改动"、"对比两个版本的变更"时使用。

公共 flag 速查

各 reference 的 shortcut 标题下用一行徽章标注支持的公共 / 系统 flag(如 _公共四件套 · 系统:--dry-run__公共:URL/token(无 sheet 定位)…_ 表示只接 URL/token)。type / 必填 / 描述在本段统一声明:

公共 flag(定位资源)

公共四件套 = --url / --spreadsheet-token / --sheet-id / --sheet-name,分成两组 XOR,每组都必须给且只能给一个(XOR = 二选一必填,不是"可选"):

  1. spreadsheet 定位(必填)--url(解析 /sheets//spreadsheets//wiki/ 三种链接;wiki 链接自动定位背后的电子表格)与 --spreadsheet-token(裸 token)二选一。例外+workbook-create / +workbook-import 产出还不存在的表,不接受任何定位 flag。
  2. sheet 定位(公共四件套 shortcut 必填)--sheet-id--sheet-name 二选一。
    • ⚠️ 不确定 sheet 名时禁止猜 Sheet1:除非对话或上下文已出现具体值,第一步先 +workbook-infosheets[].sheet_id/title 再选——中文表的子表常叫"数据"/"工作表 1"/业务名,猜名大概率撞 sheet not found
    • ⚠️ --range 里的 Sheet1! 前缀不能替代 sheet 定位:仍必须传 --sheet-id / --sheet-name
    • ⚠️ A1 引用含 ! 时整段用单引号包裹--range 'Sheet1!A1:B2',挡 bash history expansion;别用 set +H,sh/dash 下非法)。sheet 名含 -/空格需内层再包单引号时用 '\'' 转义:--source ''\''Sales-2025'\''!A1:D100'
    • 例外:徽章标 _公共:URL/token(无 sheet 定位)…_ 的 shortcut(+workbook-info / +workbook-export / +batch-update / +styles-put / +dropdown-update|delete / +cells-batch-clear / +sheet-create)不接受 sheet 定位。+pivot-create--target-sheet-id/name(XOR,可都不传)。
# 统一调用范式:两组定位缺一不可(占位符别原样填;表名先 +workbook-info 查)
lark-cli sheets +csv-get --url "https://.../sheets/shtXXX" --sheet-name "<真实表名>" --range "A1:F30"

系统 flag

FlagType必填说明
--dry-runbool零副作用:仅打印请求路径与参数模板,不发起调用;多步操作会输出每个子操作的请求模板
--yesbool是(仅 high-risk-write二次确认;不带时退出码 10。详见 ../lark-shared/SKILL.md 高风险审批协议
--print-schemabool本地打印复合 JSON flag 的 JSON Schema 并退出,不发起调用、不需要其它 required flag。搭配 --flag-name 指定查哪个 flag;省略时列出该 shortcut 可查询的 flag。仅对含复合 JSON flag 的 shortcut 有效。
--flag-namestring配合 --print-schema:flag 名不带 -- 前缀(cells / properties)。支持点分路径切片--flag-name properties.snapshot.plotArea.axes 只打印该子树,大 schema(chart 的 properties 约 1700 行)按需取,别整篇翻页。

⚠️ high-risk-write 命令清单(exit 10 强确认门禁)+batch-update+cells-clear+cells-batch-clear+sheet-delete+dim-delete+dropdown-delete,以及各对象删除 +chart-delete / +pivot-delete / +cond-format-delete / +filter-delete / +filter-view-delete / +sparkline-delete / +float-image-delete

审批协议:先 --dry-run 预览、向用户展示将执行的操作与影响范围,获得用户明确同意后再在原命令追加 --yes 执行。未经用户同意不得带 --yes,也不得在 exit 10 后静默补 --yes 重试——那等于禁用门禁。完整协议见 ../lark-shared/SKILL.md

Agent 使用提示:写复合 JSON flag 前对结构不确定时,先 --print-schema --flag-name <name>(深层字段用点分路径切片)再构造 payload;图表直接 +chart-create --print-example <type> 拿最小可用模板改参。reference 的 ## Schemas 段只给一层结构。

flag 内容类型与输出约定(术语速记)

  • JSON 类入参分三类:复合 JSON = 深层嵌套对象(--print-schema 可查);简单 JSON = 一二维标量数组;非 JSON 文本 = 原样文本(如 CSV)。--print-schema 只对复合 JSON flag 有效。
  • envelope:所有 shortcut 返回统一外层 {ok, identity, data, ...};写操作不会自动回读,校验自行调用 +*-list / +*-get / +cells-get

复合 JSON / 大入参:优先 stdin

大 payload(--operations / --cells / --sheets / --styles / --properties…)、或含换行 / 引号 / ! 等特殊字符时,优先 heredoc stdin(-)传入,避免命令行超长与 shell 转义问题:

lark-cli sheets +batch-update --url "..." --dry-run --operations - <<'JSON'   # high-risk:先 --dry-run,用户同意后再追加 --yes 重发
[{"shortcut":"+cells-set","input":{...}}]
JSON
  • stdin 每次调用只能给一个 flag+table-put 同时传 --sheets--styles 两个大 JSON 时,一个走 -、另一个走 @./styles.json@file 只接受 cwd 下相对路径,绝对路径会被拒;正解是 stdin,别 cd、别把临时文件写进用户项目目录)。
  • 参数含特殊字符时用单引号包裹即可,不要 set +H(sh/dash 下非法直接报错);参数本身含单引号或 payload 大时走 stdin。
  • 非 POSIX shell(PowerShell / cmd.exe)适配:本 skill 全部 bash 代码块(heredoc <<'JSON'、单引号转义 '\'')只适用于 bash / zsh,动手前先判断当前 shell,非 POSIX 环境按下表改写,不要试错式改引号——@file(cwd 相对路径)是全平台无引号问题的兜底形态:
形态bash / zshPowerShellcmd.exe
大 / 多行 JSON--flag - <<'JSON' … JSON先写 UTF-8 无 BOM 文件再 --flag '@./x.json',或 Get-Content -Raw ./x.json | lark-cli … --flag -先写文件再 --flag @./x.json(cmd 无 heredoc / 管道读文件不可靠)
单行 inline JSON--flag '{"a":1}'--flag '{"a":1}'(PS 单引号同为字面量)不要 inline——cmd 会吃掉内层双引号,一律走 @file

Frequently asked questions about Lark Sheets

Similar skills