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

3.8 KiB
Raw Blame History

Sheets Spreadsheet Management

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

这份 reference 汇总电子表格对象级操作:

  • +create:创建电子表格
  • +info:查看电子表格和工作表信息
  • +export:导出电子表格

+create

对应命令:lark-cli sheets +create

特性:

  • 一步创建表格并返回 URL
  • 可选 --headers/--data 在创建后自动写入第一个工作表的 A1 开始
  • --as bot 创建成功后CLI 会尝试为当前 CLI 用户自动授予 full_access
# 只创建表格
lark-cli sheets +create --title "仓库管理营收报表"

# 创建并写入表头 + 初始数据
lark-cli sheets +create --title "仓库管理营收报表" \
  --headers '["仓库","统计月份","入库金额","出库金额","销售收入","毛利率"]' \
  --data '[["华东一仓","2026-03",125000,98000,168000,"41.7%"]]'

# 创建到指定文件夹
lark-cli sheets +create --title "测试表" --folder-token "fldbc_xxx"

# 仅预览请求
lark-cli sheets +create --title "测试表" --dry-run

参数:

参数 必填 说明
--title 表格标题
--folder-token 创建到指定文件夹
--headers 一维数组 JSON作为表头写入
--data 二维数组 JSON作为初始数据写入
--dry-run 仅打印请求,不执行

输出:

  • spreadsheet_token
  • title
  • url
  • permission_grant(仅 --as bot 时返回)

+info

对应命令:lark-cli sheets +info

用于:

  • 从表格 URL / token 获取 spreadsheet_token
  • 列出工作表的 sheet_id、标题、行列数、冻结状态等信息
# 传 URL支持 wiki URL
lark-cli sheets +info --url "https://example.larksuite.com/sheets/shtxxxxxxxx"

# 传 spreadsheet_token
lark-cli sheets +info --spreadsheet-token "shtxxxxxxxx"

# 仅预览请求
lark-cli sheets +info --url "https://..." --dry-run

参数:

参数 必填 说明
--url 电子表格 URL--spreadsheet-token 二选一;支持 wiki URL
--spreadsheet-token 电子表格 token
--dry-run 仅打印请求,不执行

输出:

  • spreadsheet.spreadsheet.token
  • spreadsheet.spreadsheet.url
  • sheets.sheets[]

+export

对应命令:lark-cli sheets +export

特性:

  • 创建导出任务并轮询完成
  • 支持导出 xlsxcsv
  • 提供 --output-path 时自动下载,否则只返回 file_token
# 导出 xlsx 并保存到本地
lark-cli sheets +export --url "https://example.larksuite.com/sheets/shtxxxxxxxx" \
  --file-extension xlsx --output-path "./report.xlsx"

# 导出 csv必须指定 sheet-id
lark-cli sheets +export --spreadsheet-token "shtxxxxxxxx" \
  --file-extension csv --sheet-id "<sheetId>" --output-path "./report.csv"

# 只返回导出文件 token
lark-cli sheets +export --spreadsheet-token "shtxxxxxxxx" --file-extension xlsx

参数:

参数 必填 说明
--url 电子表格 URL--spreadsheet-token 二选一)
--spreadsheet-token 电子表格 token
--file-extension xlsxcsv
--sheet-id 导出 csv 时必填
--output-path 保存到本地的路径
--dry-run 仅打印请求,不执行

输出:

  • 提供 --output-pathsaved_pathfile_namefile_size
  • 不提供 --output-pathfile_tokenfile_namefile_size

参考