lark-sheets について
lark-sheets は、Lark のオンラインスプレッドシートを操作するためのエージェントスキルです。セルの読み書き、ワークブックやシートの管理、グラフ、ピボットテーブル、条件付き書式、フィルターなどに対応しています。エージェントで Lark スプレッドシートを自動編集する利用者を想定しており、読み戻し確認や数式の検証、データの根拠について明確な手順を定めています。
主な機能
- 01セルのデータ、数式、スタイルの読み書き
- 02ワークブックとシートの構造管理
- 03グラフ、ピボットテーブル、条件付き書式の作成
- 04フィルター、検索と置換、スパークライン
- 05AI 数式の書き込みと非同期の状態確認
活用シーン
- 01エージェントによるスプレッドシートデータの一括書き込みと整形
- 02シートのデータからのグラフやピボット集計の作成
- 03既存シートへのスタイルの統一とレイアウト調整
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ larksuite/ cli --skill lark-sheetsインストール後、Claude Code で/lark-sheetsを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
references/lark-sheets-batch-update.mdlark-sheets-changeset.mdlark-sheets-chart.mdlark-sheets-conditional-format.mdlark-sheets-filter-view.mdlark-sheets-filter.mdlark-sheets-float-image.mdlark-sheets-formula-translation.mdlark-sheets-formula-verify.mdlark-sheets-history.mdlark-sheets-pivot-table.mdlark-sheets-range-operations.mdlark-sheets-read-data.mdlark-sheets-search-replace.mdlark-sheets-sheet-structure.mdlark-sheets-sparkline.mdlark-sheets-styles-put.mdlark-sheets-visual-standards.mdlark-sheets-workbook.mdlark-sheets-write-cells.mdscripts/lark_chart_quality_check.pylark_chart_size_advisor.pylark_chart_size_rules.pylark_detect_subtables.pylark_inspect_workbook.pylark_profile_table.pylark_sheet_range.pylark_sheet_read_cli.pylark_sheets_df.py詳細
sheets
CRITICAL — 开始前 MUST 先用 Read 工具读取 ../lark-shared/SKILL.md,其中包含认证、权限处理。
场景 → 命令速查
按当前动作选行;下一步必须 Read 该行 reference,读取完成前不得执行命令。只读命中的文档;含公式 / 样式等横切动作时再读对应规范,禁止用目录枚举代替 Read。
| 你要做的事 | ✅ 正确写法 | 动手前读(先 Read 再动手) |
|---|---|---|
| 读数据 | +csv-get(纯值/CSV)、+cells-get(公式/样式/批注) | 读 references/lark-sheets-read-data.md |
| 写入数据 | +csv-put(无类型歧义纯文本)、+table-put(typed;量值/真日期;标签/编号/前导零/文本数字用 object,禁裸 csv-put)、+cells-set(公式/富写入)、+cells-set-style(样式)、+cells-set-image(单元格图片) | 读 references/lark-sheets-write-cells.md |
| 格式继承(新列/新行) | 物理插行 / 插列用 +dim-insert --inherit-style before|after;往已有空白区域扩写用 +range-copy --paste-type formats 先铺样式再写值 | 读 references/lark-sheets-range-operations.md;插行插列再读 references/lark-sheets-sheet-structure.md |
| 工作簿操作 | +workbook-create、+workbook-info、+workbook-import、+sheet-copy、+revision-get、+workbook-export | 读 references/lark-sheets-workbook.md |
| 行列操作 | 排序用 +range-sort 原子移动整行;合并 / 取消合并用 +cells-merge / +cells-unmerge;清空内容才用 +cells-clear;尺寸用 +cols-resize / +rows-resize | 读 references/lark-sheets-range-operations.md;涉结构布局再读 references/lark-sheets-sheet-structure.md |
| 美化收尾 | +styles-put | 读 references/lark-sheets-styles-put.md |
| 子表结构 | +sheet-info、+dim-insert;删整行 / 列用 +dim-delete,不能用 clear 代替 | 读 references/lark-sheets-sheet-structure.md |
| 画图表 / 可视化 / 柱状图 / 折线图 / 饼图 / 趋势 / 占比 | 单图用 +chart-create-basic,多图用扁平输入的 +batch-chart-create;改已有图的数据源用 +chart-data-update、配置用 +chart-config-update;只有语义 shortcut 表达不了的单系列 / 单数据点 / 高级字段才用 +chart-create / +chart-update,且只提交必要的局部 properties。动手前先断言每张图的类型、横轴字段、分组字段和目标张数,画完 +chart-list 逐项核;图片迁移成真图表后删除并复查原浮动图片 | 读 references/lark-sheets-chart.md;含透视 / 分组汇总再读 references/lark-sheets-pivot-table.md |
| 分组汇总 / 透视 | +pivot-create | 读 references/lark-sheets-pivot-table.md |
| 筛选 / 只看符合条件的行 | +filter-create | 读 references/lark-sheets-filter.md |
| 查找 / 替换文本 | +cells-search、+cells-replace | 读 references/lark-sheets-search-replace.md |
| 条件格式 / 条件高亮 / 数据条 / 色阶 | 随数据变化的标色用 +cond-format-create;固定刷色只用于用户点名要静态着色 | 读 references/lark-sheets-conditional-format.md |
| 插图:自由摆放的装饰 | +float-image-create | 读 references/lark-sheets-float-image.md |
| 迷你图 / 单元格内趋势线 | +sparkline-create | 读 references/lark-sheets-sparkline.md |
| 批量清除多区域 | +cells-batch-clear | 读 references/lark-sheets-batch-update.md(high-risk) |
| 复核编辑变更 / 取版本间差异 | +changeset-get | 读 references/lark-sheets-changeset.md |
| 保存多份筛选状态 / 命名筛选视图 | +filter-view-create;视图与 +filter-create 相互独立、可在同一子表共存 | 读 references/lark-sheets-filter-view.md |
| 查编辑历史 / 回滚到历史版本 | +history-list 取版本,+history-revert(high-risk,异步)回滚后用 +history-revert-status 轮询 | 读 references/lark-sheets-history.md |
⚠️ 金额 / 百分比 / 比率 / 计数及参与运算的真日期写数字(百分比传
0.4+number_format);日期标签、编号、前导零、身份证 / 单据号写文本。--range只写A1:B2,子表另传--sheet-id/--sheet-name。
飞书表格编辑准则
- 最小改动:用户没点名要删 / 改名 / 隐藏时,已有 Sheet 一张不动;补齐只写空格,未要求调整的值 / 结构 / 格式不动。
- 目标子表与回读断言:先确认真实末行与目标区域;未点名子表时只从
resource_type=sheet && is_hidden=false的可见网格候选里选,唯一才自动使用,多张不得按 index 猜。涉及"所有 / 每个 sheet"(跨表汇总、批量清洗、合并多张子表)时先+workbook-info列全再逐个处理,别只做前几张。写后用+csv-get/+cells-get/+<对象>-list验首、中、末及用户点名项——返回ok只表示请求成功。纯 CSV 回写前去掉annotated_csv的[row=N]前缀,cells-get的样式字段与值分开处理,公式必须回读formula。样式同样要回读:写过边框 / 底色 / 字体色 / 数字格式 / 行高列宽 / 冻结的,收尾用+cells-get --include style或+sheet-info抽查目标区域首、中、末格确认属性真的在——写入返回ok不代表样式落上了;缺的整份重发(样式是幂等盖章,重发无副作用)。 - 公式闭环:可推导值写落格公式,不用静态值代替——用 Python 算好数值再写进单元格,交付的是改输入不重算的死表;Python 只用于推导和验证,落进单元格的必须是引用其他格的公式。写前确认字段语义、阈值边界(以上/至少=
>=,超过/大于=>)、单位/时区和完整源范围,选首中末、空值、边界及一条可手算记录作哨兵;写后逐段+formula-verify --exit-on-error,各段status='success'且哨兵值正确才算完成(AI 公式例外:异步计算,改用+formula-verify --ai-only对整个写入区间做一次异步状态检查,不用+cells-get轮询结果,failed清零后即使仍有 pending 也可交付并说明);试错 3 次仍失败可降级静态值,交付说明写明「静态值 + 失败原因 + 不随源数据更新」。 - 完整继承样式:新增行列时禁止只读值只写值——原表字体、对齐、底色(含奇偶行交替)、四边框都延续到新区域。物理插入行 / 列用
+dim-insert --inherit-style before|after(原生继承,比补刷可靠);往已有空白区域扩写(如在数据右侧加新列)用+range-copy --paste-type formats先铺样式再写值;两者都表达不了的非规则样式,才用+cells-get --include style读源区样式随值写回。无论走哪条路径,插入后都另查行高列宽(行高不随样式继承,插行填长文本前补+rows-resize)、合并与跨列标题并补齐。详见references/lark-sheets-write-cells.md。 - 原子操作:排序用
+range-sort,--range覆盖完整记录宽度,排序列只写进--sort-keys;删除记录用+dim-delete,清空内容 / 格式才用+cells-clear;禁止读值后用+csv-put覆盖来模拟排序 / 删除。仅跨类型且有顺序依赖时才用 high-risk+batch-update。 - 标色分流:数据变化后应自动重算的高亮 / 标红用条件格式,已确定结果的固定标注用静态样式,装饰性美化按视觉规范。两条路径取色字段用同一判据:用户中文语境下的"标红 / 染色 / 标记"指单元格背景色,"文字红 / 字体红 / 把字变红"才用字体色,默认无说明时选背景色。条件格式建完先
+cond-format-list验规则与范围,再+cond-format-result-get抽查哨兵格命中样式。 - 产物可核对:用户点名的 sheet 名与数量、表头、标题、图例、文件名、口径逐字保留;回复中每项“已完成”都能定位到产物,缺口逐项声明。
- 替换与新增:批量替换 / 删除后搜索确认无残留;新增列要有表头,单位 / 口径另置,不占原表头或数据格。
- 不编造:表外数据须有可核验来源,不用常识或名称推断伪造公司、标准值、行情或法规参数;没有来源就留空——凭记忆填的数值大概率与真实值对不上,比留空更糟。留空的格在交付说明里逐项列出格址与缺的来源,不要只写一句"部分数据缺失"。
🤖 文本类 NLP 任务首选 AI 公式,别默认退回手工 / Python:只要对文本列做翻译 / 情感 / 分类打标签 / 信息提取 / 总结 / 润色等 NLP,飞书在线表格上优先用原生
=AI(prompt, range)逐列铺开(写法与普通公式一致,见references/lark-sheets-formula-translation.md),一次落表随行自动计算,比逐条读 → 手工判断 → 回写 / Python 调模型再写静态值都更省事。判定标准是「逐行独立」:每个目标单元格只依赖同一行输入即为逐行独立,数据量(哪怕 1 万 +)、分批、判断复杂度都不改变该判定——大数据量下 AI 公式仍是首选,分批只改公式铺设的批次大小(行数很多时按批串行,量级参考每批几百到一千行),不得改为「用 Python 或规则脚本生成语义结果后静态写回」;Python 只能做清洗 / 行号映射 / 构造公式批次,不得读源文本生成目标语义值。只有单个结果依赖多行输入的跨行任务才走非公式路线。AI 公式异步计算,写完先对种子格 / 首格做一次+cells-get --include formula核对文本,随后第一校验入口必须是+formula-verify --ai-only --range <整个写入区间>,禁止用+cells-get轮询计算结果;判据为ai_formula_failed_count == 0(--range只透传给后端、不保证收窄汇总口径,按返回的单元格定位核对本次区间,别拿总数对预期条数),满足后即使仍有 pending 也可交付,并告知用户"AI 公式仍在后台运行"。
流程:了解结构 →(未点名时先按 visible_grid selection 定位)→ 读数据 → 原生工具写入 → 按用户点名项回读验证 → 在线交付。整理 / 美化 / 加汇总行这类会改变表长或版式的任务,收尾把表头行冻住(原表已有冻结设置的不动)。xlsx 验收只在处理本地 xlsx、或用户点名要本地 xlsx / 下载 / 打印时跑。
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、日期差、多层范围结果与二次展开)时使用。本文负责把公式写对;落表后必须用 references/lark-sheets-formula-verify.md 对本次公式范围逐段诊断。 |
オブジェクト別ツールリファレンス(shortcut を含む)
| Reference | 説明 |
|---|---|
| Lark Sheet Formula Verify | 数式の書き込み/一括入力/--copy-to-range による拡張/数式を含むワークブックのインポート後の完了確認に使用します。通常の数式は今回追加または変更した範囲をセグメントごとにスキャンし、コンパイル失敗と 7 種類の実行エラーをまとめます。partial の場合は引き続き分割し、すべてが status='success' になったら完了です。AI 数式は --ai-only を使って書き込み範囲全体の非同期ステータスを一度確認します。pending の場合は、その旨を説明してから納品できます。 |
| Lark Sheet Workbook | Lark スプレッドシートのワークブック構造(シート一覧とメタデータ)を管理します。ユーザーが「このスプレッドシートに何があるか見て」、「スプレッドシートの構造」、「どんなシートがあるか」、「シートを新規作成」、「このワークシートを削除」、「名前を変更」、「コピーを作成」、「前に移動」と言った場合に使用します。 |
| Lark Sheet Sheet Structure | Lark スプレッドシートのシート構造とレイアウトを管理します。行の高さや列幅の確認、非表示、結合、固定、グループ化のほか、行列の挿入/削除/移動など、物理的な構造の操作を行います。データのグループ集計には lark-sheets-pivot-table を使用します。通常の表の末尾への追加には、まず lark-sheets-write-cells の +table-put --mode append を使用して最終行を自動特定してください。物理的な行列の挿入、テンプレート構造の継承、レイアウトの拡張をユーザーが明示的に要求した場合に限り、この reference を先に使用します。 |
| Lark Sheet Read Data | Lark スプレッドシートのセルデータを読み取ります。ユーザーが「データを見て」、「データを分析して」、「集計/要約して」と依頼した場合に使用します。数式、スタイル、コメントなどの詳細情報を確認する場合にも使用できます。 |
| Lark Sheet Search & Replace | Lark スプレッドシート内のテキストを検索、置換します。範囲指定、大文字と小文字の区別、完全一致、正規表現に対応しています。ユーザーが値の「検索」、「探す」、「特定」、または「置換」、「テキストを一括変更」、「A を B に変更」と依頼した場合に使用します。スプレッドシートの構造の理解(データを読み取ってください)やデータ分析(データを読み取ってから計算してください)には使用しないでください。また、ユーザーの操作内容に含まれるキーワード(「金額を集計」や「数量を統計」など)を検索語として扱わないでください。 |
| Lark Sheet Write Cells | Lark スプレッドシートの指定範囲に値、数式、スタイル、コメント、セル画像を一括で書き込みます。プレーンテキストには +csv-put を使用できます。金額、パーセンテージ、日付、ブール値、カウント、および後で集計に使用する列には、dtypes/formats を明示して +table-put を使用してください。数式やリッチフィールドには +cells-set を使用します。データの追加には +table-put --mode append を直接使用できます。物理的な行/列の挿入が明確に必要な場合に限り、先に lark-sheets-sheet-structure を使用してください。数式を書き込んだ後は、必ず lark-sheets-formula-verify を実行してください。 |
| Lark Sheet Range Operations | Lark スプレッドシートの指定範囲に対して、セルデータ値を書き込まずに構造操作を実行します。対象となる操作:内容や書式のクリア(「クリア」、「内容を削除」、「書式を削除」)、セルの結合/結合解除、行の高さや列幅の調整(「列幅を広げる」、「列幅を自動調整」)、データの移動/コピー/入力/並べ替え(「データを移動」、「コピー先」、「オートフィル」、「列で並べ替え」)。セルデータの書き込みには lark-sheets-write-cells を使用してください。 |
| Lark Sheet Styles Put | 宣言型のビジュアル仕様(スタイル/罫線/結合/行の高さや列幅/固定)を、既存の Lark スプレッドシートの複数のシートに一括適用します。仕様全体を一度に送信します。既存の表の仕上げ、スタイルの一括適用、レイアウトの統一を行う場合に使用します。スタイル値の基準については lark-sheets-visual-standards を参照してください。新規表の作成とスタイル適用には lark-sheets-workbook(+workbook-create --styles)、データ書き込みと同時のスタイル適用には lark-sheets-write-cells(+table-put --styles)を使用します。いずれも同じ --styles 用語を共有しています。Lark スプレッドシートのみを対象とします。 |
| Lark Sheet Batch Update | 複数の Lark スプレッドシートへの書き込み操作を一括実行にまとめ、順番に実行します。複数の書き込み操作を連続して実行する必要がある場合(たとえば、先に構造を変更してからデータを書き込む場合)に適しています。 |
| Lark Sheet Chart | Lark スプレッドシートのグラフ(縦棒グラフ、折れ線グラフ、円グラフ、横棒グラフ、面グラフ、散布図、複合グラフ、レーダーチャートなど)を管理します。ユーザーがグラフの作成、グラフのスタイルやデータソースの変更、既存のグラフ設定の確認、グラフの削除を希望する場合に使用します。「データの可視化」、「グラフを描いて」、「傾向分析」、「比較グラフ」、「割合分析」、「グラフを作って」など、データの可視化に関する依頼にも使用できます。 |
| Lark Sheet Pivot Table | Lark スプレッドシートのピボットテーブルを管理します。ユーザーがピボットテーブルの作成、行/列フィールド・集計方法・フィルター条件の変更、既存のピボットテーブル設定の確認、ピボットテーブルの削除を希望する場合に使用します。「グループ集計」、「クロス分析」、「XXX 別に集計」、「フィールド別にグループ化」、「さらにグループ分け」、「多次元分析」、「ピボット分析」などの依頼にも使用できます。 |
| Lark Sheet Conditional Format | Lark スプレッドシートの条件付き書式ルール(重複値の強調表示、セル値の比較、データバー、カラースケール、ランキング、カスタム数式など)を管理します。ユーザーが条件付き書式の作成、既存ルールの範囲やスタイルの変更、現在の条件付き書式設定の確認、ルールの削除を希望する場合に使用します。「強調表示」、「赤色にする」、「色でマーク」、「データバー」、「カラースケール」、「条件付きスタイル」などの依頼にも使用できます。 |
| Lark Sheet Filter | Lark スプレッドシートのフィルター(filter)を管理します。ユーザーがデータのフィルタリング(テキスト/数値/色/日付条件による行の絞り込み)、既存のフィルター設定の確認、フィルターの変更または削除を希望する場合に使用します。「〜だけを見る」、「〜を抽出」、「条件に合うものだけを残す」といった依頼にも使用できます。 |
| Lark Sheet Filter View | Lark スプレッドシートのフィルタービュー(filter view)を管理します。ユーザーが「XX ビューを作成」、「このフィルター状態を保存」、「異なるフィルターを切り替え」、「1 つの sheet 上で複数の独立したフィルター設定を管理」と依頼した場合に使用します。ビューとフィルター(filter)は互いに独立しており、同じ sheet 上で共存できます。ビュー内の非表示行は、ユーザーがそのビューを開いている間だけローカルで有効になり、他の共同編集者には影響しません。 |
| Lark Sheet Sparkline | Lark スプレッドシートのスパークライン(折れ線スパークライン、棒スパークライン、勝敗スパークライン)を管理します。ユーザーがデータの傾向を示す小さなグラフをセル内に埋め込みたい場合に使用します。「トレンドライン」、「セル内グラフ」、「スパークライン」といった依頼にも使用できます。注意:無効化されている SPARKLINE() 数式関数とは異なります。 |
| Lark Sheet Float Image | Lark スプレッドシートのフローティング画像を管理します。ユーザーがスプレッドシートへのフローティング画像の挿入、画像の位置やサイズの調整、既存のフローティング画像の確認、画像の削除を希望する場合に使用します。「画像を挿入」、「ロゴを追加」、「画像を置いて」といった依頼にも使用できます。注意:画像をセル内に埋め込みたい場合(セル画像)は、lark-sheets-write-cells を参照してください。 |
| Lark Sheet History | Lark スプレッドシートの過去のバージョンを照会し、指定したバージョンにロールバックします。ユーザーが表の編集履歴バージョン一覧の確認、過去のバージョンへのロールバック、またはロールバックの非同期ステータス(進行中/成功/失敗)の確認を希望する場合に使用します。ロールバックは非同期操作です。開始後、ステータス照会で結果をポーリングします。Lark スプレッドシートのみを対象とします。 |
| Lark Sheet Changeset | 2 つのバージョン(CS revision)間の changeset(変更操作の生の一覧)を読み取り、編集、特に AI による編集がユーザーの要望を実際に満たしているか確認します。開始バージョン(編集前の基準)を指定し、終了バージョンは省略できます(省略時は最新)。バージョン差の上限は 20 です。返却値の最外層には、現在のスプレッドシートの最新バージョン番号が含まれます。ユーザーが「今回何を変更したか見て」、「AI の変更を確認」、「2 つのバージョンの変更を比較」と依頼した場合に使用します。 |
公共 flag 速查
各 reference 的 shortcut 标题下用一行徽章标注支持的公共 / 系统 flag(如 _公共四件套 · 系统:--dry-run_)。type / 必填 / 描述在本段统一声明:
公共 flag(定位资源)
公共四件套 = --url / --spreadsheet-token / --sheet-id / --sheet-name,分成两组 XOR,每组都必须给且只能给一个(XOR = 二选一必填,不是"可选")——spreadsheet 指工作簿、sheet 指子表;条件格式 / 图表 / 筛选视图 / 透视表 / 迷你图 / 浮动图片这类对象在四件套之外另用各自的 --*-id 定位:
- spreadsheet 定位(必填):
--url(解析/sheets/、/spreadsheets/、/wiki/三种链接;wiki 链接自动定位背后的电子表格)与--spreadsheet-token(裸 token)二选一。例外:+workbook-create/+workbook-import产出还不存在的表,不接受任何定位 flag。 - sheet 定位(公共四件套 shortcut 必填):
--sheet-id与--sheet-name二选一。- ⚠️ 不确定 sheet 名时禁止猜
Sheet1:除非对话或上下文已出现具体值,第一步先+workbook-info拿sheets[].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 名要在 A1 里内层再包单引号时用'\''转义。 - 例外:徽章标
_公共:URL/token(无 sheet 定位)…_的 shortcut 不接受 sheet 定位——工作簿级(+workbook-info/+sheet-list/+sheet-create/+revision-get/+changeset-get/+history-list|revert|revert-status)、批量与整表级(+batch-update/+batch-chart-create|update/+cells-batch-clear/+styles-put/+dropdown-update|delete),以及子表名写在 payload 里的+table-put。+workbook-export只接--sheet-id(无--sheet-name),+pivot-create用--target-sheet-id/name(XOR,可都不传)。徽章是判据,本行只是速记。
- ⚠️ 不确定 sheet 名时禁止猜
# 统一调用范式:两组定位缺一不可(占位符别原样填;表名先 +workbook-info 查)
lark-cli sheets +csv-get --url "https://.../sheets/shtXXX" --sheet-name "<真实表名>" --range "A1:F30"
系统 flag
| Flag | Type | 必填 | 说明 |
|---|---|---|---|
--dry-run | bool | 否 | 零副作用:仅打印请求路径与参数模板,不发起调用 |
--yes | bool | 是(仅 high-risk-write) | 二次确认;不带时退出码 10。详见 ../lark-shared/SKILL.md 高风险审批协议 |
--print-schema | bool | 否 | 写复合 JSON flag 前结构不确定就先跑它:本地打印 Schema 并退出(不发起调用、不需要其它 required flag),搭配 --flag-name 指定查哪个 flag,省略时列出该 shortcut 可查的 flag。只有含复合 JSON flag 的 shortcut 支持。 |
--flag-name | string | 否 | 配合 --print-schema:flag 名不带 -- 前缀(cells / properties)。支持点分路径切片:--flag-name properties.snapshot.plotArea.axes 只打印该子树,大 schema(chart 的 properties 约 1700 行)按需取,别整篇翻页。 |
bool flag 语法:开启可用裸
--flag;显式值只用--flag=true或--flag=false,不得用空格分隔。
⚠️ high-risk-write 命令清单(exit 10 强确认门禁):
+batch-update、+cells-clear、+cells-batch-clear、+sheet-delete、+dim-delete、+dropdown-delete、+history-revert(整表回滚到历史版本),以及各对象删除+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。
Schema 的边界:--print-schema 打印的是 flag 值的内部结构,flag 描述要求外层信封时(如 --sheets 的 {"sheets":[…]})schema 里看不到那层,按描述补上;reference 的 ## Schemas 段也只给一层。图表直接 +chart-create --print-example <type> 拿最小可用模板改参。
flag 内容类型与输出约定(术语速记)
- JSON 类入参分三类:复合 JSON = 深层嵌套对象(
--print-schema可查);简单 JSON = 一二维标量数组;非 JSON 文本 = 原样文本(如 CSV)。 - envelope:所有 shortcut 返回统一外层
{ok, identity, data, ...};写操作不会自动回读,校验自行调用+*-list/+*-get/+cells-get。 - 大 payload 走文件 / stdin,不在命令行内联:Type 标
File + Stdin的 flag 支持--flag "@./x.json"(@file只接受 cwd 下相对路径,绝对路径被拒)与--flag -(stdin);payload 含换行 / 引号或体量大时一律落文件。stdin 每次调用只能给一个 flag——+table-put的--sheets与--styles都是大 JSON 时,一个走-、另一个走@./x.json。临时文件不要落进用户项目目录。 - 非 POSIX shell(PowerShell / cmd.exe)适配:本 skill 全部
bash代码块(heredoc<<'JSON'、单引号转义'\'')只适用于 bash / zsh,动手前先判断当前 shell,非 POSIX 环境按下表改写,不要试错式改引号——@file(cwd 相对路径)是全平台无引号问题的兜底形态:
| 形态 | bash / zsh | PowerShell | cmd.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 |