5.3 KiB
5.3 KiB
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:D10或C2 - 默认最多返回 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:D10、A1:D10 / C2 或 <sheetId> |
--sheet-id |
否 | 工作表 ID |
--value-render-option |
否 | ToString / FormattedValue / Formula / UnformattedValue |
--dry-run |
否 | 仅打印请求,不执行 |
输出:
rangevaluestruncatedtotal_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_rangeupdated_rowsupdated_columnsupdated_cellsrevision
+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_rangeupdated_rangeupdated_rowsupdated_columnsupdated_cellsrevision
+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_cellsmatched_formula_cellsrows_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_cellsreplace_result.matched_formula_cellsreplace_result.rows_count
参考
- spreadsheet-management — 先获取
sheet_id - dropdown — 写入
multipleValue前先设置下拉列表 - formula — 公式写入规则