ai_member_xiaobian/.agents/skills/lark-sheets/references/lark-sheets-cell-data.md
2026-05-15 10:57:05 +08:00

5.3 KiB
Raw Permalink Blame History

Sheets Cell Data

前置条件: 先阅读 ../lark-shared/SKILL.md 了解认证、全局参数和安全规则。

这份 reference 汇总单元格数据操作:

  • +read
  • +write
  • +append
  • +find
  • +replace

+read

对应命令:lark-cli sheets +read

内置能力:

  • 支持 --url / --spreadsheet-token 二选一URL 支持 wiki
  • 若已传 --sheet-id--range 可写 A1:D10C2
  • 默认最多返回 200 行
lark-cli sheets +read --url "https://example.larksuite.com/sheets/shtxxxxxxxx" \
  --range "<sheetId>!A1:H20"

lark-cli sheets +read --spreadsheet-token "shtxxxxxxxx" \
  --sheet-id "<sheetId>" --range "C2"

参数:

参数 必填 说明
--url 电子表格 URL--spreadsheet-token 二选一)
--spreadsheet-token 表格 token
--range <sheetId>!A1:D10A1:D10 / C2<sheetId>
--sheet-id 工作表 ID
--value-render-option ToString / FormattedValue / Formula / UnformattedValue
--dry-run 仅打印请求,不执行

输出:

  • range
  • values
  • truncated
  • total_rows

+write

对应命令:lark-cli sheets +write

用于覆盖写入一个矩形区域。

lark-cli sheets +write --spreadsheet-token "shtxxxxxxxx" \
  --range "<sheetId>!A1:B2" \
  --values '[["name","age"],["alice",18]]'

lark-cli sheets +write --url "https://example.larksuite.com/sheets/shtxxxxxxxx" \
  --sheet-id "<sheetId>" --range "C2" \
  --values '[["hello"]]'

参数:

参数 必填 说明
--url 电子表格 URL--spreadsheet-token 二选一)
--spreadsheet-token 表格 token
--range 写入范围;可用相对范围或 <sheetId>
--sheet-id 工作表 ID
--values 二维数组 JSON
--dry-run 仅打印请求,不执行

输出:

  • updated_range
  • updated_rows
  • updated_columns
  • updated_cells
  • revision

+append

对应命令:lark-cli sheets +append

用于向工作表末尾追加行。

lark-cli sheets +append --spreadsheet-token "shtxxxxxxxx" \
  --range "<sheetId>!A1" \
  --values '[["华东一仓","2026-03",125000,98000,168000,"41.7%"]]'

参数:

参数 必填 说明
--url 电子表格 URL--spreadsheet-token 二选一)
--spreadsheet-token 表格 token
--range 追加范围:支持 <sheetId>、完整范围、相对范围
--sheet-id 工作表 ID
--values 二维数组 JSON
--dry-run 仅打印请求,不执行

输出:

  • table_range
  • updated_range
  • updated_rows
  • updated_columns
  • updated_cells
  • revision

+find

对应命令:lark-cli sheets +find

只在一个已知 spreadsheet 内查找单元格内容,不是云空间搜索。

lark-cli sheets +find --url "https://example.larksuite.com/sheets/shtxxxxxxxx" \
  --sheet-id "<sheetId>" --find "张三" --range "A1:H200"

lark-cli sheets +find --spreadsheet-token "shtxxxxxxxx" \
  --sheet-id "<sheetId>" --find "仓库管理营收报表" --ignore-case

参数:

参数 必填 说明
--url 电子表格 URL--spreadsheet-token 二选一)
--spreadsheet-token 表格 token
--sheet-id 工作表 ID
--find 查找内容
--range 范围;不填则搜索整个工作表
--ignore-case 不区分大小写
--match-entire-cell 完全匹配单元格
--search-by-regex 使用正则
--include-formulas 搜索公式
--dry-run 仅打印请求,不执行

输出:

  • matched_cells
  • matched_formula_cells
  • rows_count

+replace

对应命令:lark-cli sheets +replace

在指定范围内查找并替换单元格内容。

lark-cli sheets +replace --spreadsheet-token "shtxxxxxxxx" \
  --sheet-id "<sheetId>" --find "hello" --replacement "world"

lark-cli sheets +replace --spreadsheet-token "shtxxxxxxxx" \
  --sheet-id "<sheetId>" --find "\\d{4}-\\d{2}-\\d{2}" \
  --replacement "DATE" --search-by-regex

参数:

参数 必填 说明
--url 电子表格 URL--spreadsheet-token 二选一)
--spreadsheet-token 表格 token
--sheet-id 工作表 ID
--find 搜索文本
--replacement 替换文本
--range 搜索范围,不传则搜索整个工作表
--match-case 区分大小写
--match-entire-cell 匹配整个单元格
--search-by-regex 使用正则
--include-formulas 在公式中搜索
--dry-run 仅打印请求,不执行

输出:

  • replace_result.matched_cells
  • replace_result.matched_formula_cells
  • replace_result.rows_count

参考