SuperAPI AI 工具集

lark-base

办公与效率

查看项目

更新于 10-15 16:37

技能介绍

飞书多维表格(Base)操作技能,用于通过命令行方式管理 Base 中的各类资源。

【用途】 该技能面向需要程序化操作飞书多维表格的场景,覆盖建表、字段、记录、视图、统计、公式/lookup、表单、仪表盘、应用模式(BaseApp/AppMode 页面与组件)、Workspace 目录、workflow、角色权限以及模板中心。

【资源模型】 普通 Base 是数据容器,由一棵 Base Block 资源树和 Base 级配置组成。folder、table、docx、dashboard、workflow 都是 Block 类型;Advanced Permission / Role 是 Base 级配置,不属于 Block。Table 是承载业务数据的核心 Block。Workspace 是组织 Base 与 BaseApp 的外层容器;BaseApp(AppMode)通过 Page 和组件组织 Base 数据,不是 Base 的别名。

【身份与入口】 操作 Base 优先使用 --as user;用户明确要求应用身份时使用 --as bot。开始操作前先确定 base_token 和目标实体类型:URL 或分享链接用 +url-resolve 解析;Base 标题或关键词用 +title-resolve;已有 Base 候选列表用 drive +search --doc-types bitable。BaseApp 优先使用真实 /app/ URL,已有 workspace_token 时可用 +workspace-entity-list --type baseapp 定位。

【主要能力】 读取 Base 用 +base-get;创建新 Base 用 +base-create 同时创建 Base、首表和 fields;复制整个 Base 用 +base-copy。Base Block 统一用 +base-block-list 发现,+base-block-create 创建,+base-block-rename 改名,+base-block-move 调整目录与顺序,+base-block-delete 删除。

Table 层面:+table-list 定位表,+table-get 读取详情,+table-copy 复制表。Field 层面:+field-list / +field-get / +field-search-options 读取,+field-create / +field-update / +field-delete 写入,字段插件可按同行其他字段内容触发 LLM 生成并写回目标字段。Record 层面:+record-get、+record-search、+record-list 读取,支持 --filter-json / --sort-json 结构化条件与排序;+record-batch-create / +record-batch-update 批量写入,单批最多 200 条;+record-delete、+record-share-link-create、+record-history-list 以及附件上传/下载/移除。View 层面:+view-list / +view-get 读取,编辑前需读 View 类型与生命周期。Form 层面:+form-list / +form-get / +form-questions-list 读取,+form-create / +form-update / +form-delete 管理,+form-share-get / +form-share-update 管理分享,+form-detail / +form-submit 填写提交。Dashboard 层面:+dashboard-list / +dashboard-get / +dashboard-update / +dashboard-arrange,内部组件用 +dashboard-block-list / +dashboard-block-get / +dashboard-block-create / +dashboard-block-update / +dashboard-block-delete,数据结果用 +dashboard-block-get-data。应用模式:+workspace-create / +workspace-entity-list / +workspace-move-in,+app-create / +app-get,+app-page-list/get/create/rename/delete,+app-block-list/get/create/update 与 +app-block-get-data。Workflow:+workflow-list / +workflow-get 读取,+workflow-create / +workflow-update 写入,+workflow-enable / +workflow-disable 控制运行状态。权限:+advperm-enable / +advperm-disable,+role-list / +role-get / +role-create / +role-update / +role-delete。模板中心:+template-categories、+template-list、+template-search。

【使用方式】 通过 lark-cli base 系列命令操作,读取记录时建议重复传 --field-id 做最小字段投影,并统一写入 NDJSON artifact(--format ndjson --output <path>.ndjson)。--limit 缺省值和最大值均为 2000,支持 --offset。预计记录数少于 500 行时建议直接拉取到本地用 jq 或 Python 处理。大 payload 可用 --json @file.json。命令具有 confirmation gate 时,确认目标和影响后使用 --yes。

【适用场景】 适合需要批量读写多维表格数据、管理表结构与视图、配置表单收集信息、搭建仪表盘、构建应用模式页面、编排工作流、设置角色权限,以及从公开模板创建新 Base 的场景。

【限制】 认证、初始化、scope、身份切换和授权恢复不在本技能范围,转 lark-shared;Excel、CSV、.base 等本地文件与 Base 之间的导入/导出转 lark-drive;Base 内嵌 Docx 的正文编辑转 lark-doc;电子表格内容操作转 lark-sheets。Table 下大多数更新通过异步链路生效,接口成功返回后立即读取可能暂时看不到最新状态。created_at、updated_at、created_by、updated_by、auto_number、formula、lookup 类型字段只读。当前不支持 BaseApp 复制、Page 完整复制、页面图标以及从 Workspace 移出资源。