base
前置条件:
先阅读
../lark-shared/SKILL.md
。
执行前必做:
执行任何
base
命令前,必须先阅读对应命令的 reference 文档,再调用命令。
命名约定:
Base 业务命令仅使用
lark-cli base +...
形式;如需先解析 Wiki 链接,可先调用
lark-cli wiki ...
。
分流规则:
如果用户要“把本地文件导入成 Base / 多维表格 / bitable”,第一步不是
base
,而是
lark-cli drive +import --type bitable
;导入完成后再回到
lark-cli base +...
做表内操作。
1. 何时使用本 Skill
1.1 触发条件
以下场景应使用本 skill:
用户明确要操作飞书多维表格 / Base。
用户要建表、改表、查表、删表,或管理字段、记录、视图。
用户要做公式字段、lookup 字段、派生指标、跨表计算。
用户要做临时统计、聚合分析、比较排序、求最值。
用户要管理 workflow、dashboard、表单、角色权限。
用户给出
/base/{token}
链接。
用户给出
/wiki/{token}
链接,且最终解析为
bitable
。
用户要把旧的 Base 聚合式写法改成当前原子命令写法,例如把旧
+table / +field / +record / +view / +history / +workspace
改写成当前命令。
以下场景不应使用本 skill:
用户只是做认证、初始化配置、切换
--as user/bot
、处理 scope。此时先读
../lark-shared/SKILL.md
。
用户只是泛化地讨论“数据分析 / 字段设计”,但并不在 Base 场景中。不要因为提到“统计 / 公式 / lookup”就误触发。
1.2 前置约束
先阅读
../lark-shared/SKILL.md
。
Base 业务命令仅使用
lark-cli base +...
形式的 shortcut 命令;如果输入是 Wiki 链接,可先调用
lark-cli wiki spaces get_node
解析真实 token。
定位到命令后,先读该命令对应的 reference,再执行命令。
如果用户要把本地 Excel / CSV 导入成 Base / 多维表格 / bitable,第一步不是
base
,而是
lark-cli drive +import --type bitable
;导入完成后再回到
lark-cli base +...
做表内操作。
不要在 Base 场景改走
lark-cli api /open-apis/bitable/v1/...
。
2. 模块与命令导航
本章按“先选模块,再选命令”的方式组织。先判断用户目标属于哪个大模块,再进入对应子模块,按要求阅读 reference 后执行命令。
2.1 模块地图
大模块
处理什么问题
包含的小模块 / 能力
Base 模块
管理 Base 本体,或从链接进入 Base 场景
base-create / base-get / base-copy
,Base / Wiki 链接解析
表与数据模块
管理 Base 内部结构与日常数据操作
table / field / record / view
公式 / Lookup 模块
处理派生字段、条件判断、跨表计算、固定查找引用
formula / lookup
字段创建与更新
数据分析模块
做一次性筛选、分组、聚合分析
data-query
Workflow 模块
管理自动化流程
workflow-list / get / create / update / enable / disable
Dashboard 模块
管理仪表盘和图表组件
dashboard- / dashboard-block-
表单模块
管理表单和表单题目
form- / form-questions-
权限与角色模块
管理高级权限和自定义角色
advperm- / role-
2.2 Base 模块
用于管理 Base 本体,或从用户给出的链接进入后续 Base 操作。
模块索引:
references/lark-base-workspace.md
命令
用途 / 何时使用
必读 reference
路由提醒
+base-create
创建新的 Base
lark-base-base-create.md
、
lark-base-workspace.md
写入操作;执行前先读 reference;
--folder-token
、
--time-zone
都是可选项
+base-get
获取 Base 信息
lark-base-base-get.md
、
lark-base-workspace.md
适合确认 Base 本体信息,不替代表/字段结构读取
+base-copy
复制已有 Base
lark-base-base-copy.md
、
lark-base-workspace.md
写入操作;执行前先读 reference;复制成功后应主动返回新 Base 标识信息
2.3 表与数据模块
这是最常用的大模块,包含
table / field / record / view
四类子模块。
补充示例:
references/examples.md
,适合需要串联 table / record / view 完整操作链路时再读。
2.3.1 Table 子模块
子模块索引:
references/lark-base-table.md
命令
用途 / 何时使用
必读 reference
路由提醒
+table-list / +table-get
列出数据表,或获取单个表详情
lark-base-table-list.md
、
lark-base-table-get.md
+table-list
只能串行执行;
+table-get
适合删除/修改前确认目标
+table-create / +table-update / +table-delete
创建、更新或删除数据表
lark-base-table-create.md
、
lark-base-table-update.md
、
lark-base-table-delete.md
创建适合一次性建表;更新前先确认目标表;删除时用户已明确目标可直接执行并带
--yes
2.3.2 Field 子模块
普通字段管理走这里;如果字段类型是
formula
或
lookup
,转到下方“公式 / Lookup 模块”。
子模块索引:
references/lark-base-field.md
命令
用途 / 何时使用
必读 reference
路由提醒
+field-list / +field-get
列出字段结构,或获取单个字段详情
lark-base-field-list.md
、
lark-base-field-get.md
写记录、写字段、做分析前常先读
+field-list
;
+field-list
只能串行执行;
+field-get
适合删除/更新前确认目标
+field-create / +field-update / +field-delete
创建、更新或删除普通字段
lark-base-field-create.md
、
lark-base-field-update.md
、
lark-base-field-delete.md
、
lark-base-shortcut-field-properties.md
写字段前先看字段属性规范;如果类型是
formula / lookup
,先转去读对应 guide;删除时用户已明确目标可直接执行并带
--yes
+field-search-options
查询字段可选项
lark-base-field-search-options.md
适合单选/多选等选项型字段
2.3.3 Record 子模块
子模块索引:
references/lark-base-record.md
、
references/lark-base-history.md
命令
用途 / 何时使用
必读 reference
路由提醒
+record-search / +record-list / +record-get
按关键词检索记录、读取记录明细 / 分页导出,或获取单条记录详情
lark-base-record-search.md
、
lark-base-record-list.md
、
lark-base-record-get.md
默认优先
+record-list
;仅当用户提供明确搜索关键词时使用
+record-search
;取数不用来做聚合分析;
--limit
最大
200
;仅在用户明确需要时继续翻页;
+record-list
只能串行执行
+record-upsert / +record-batch-create / +record-batch-update
创建、更新或批量写入记录
lark-base-record-upsert.md
、
lark-base-record-batch-create.md
、
lark-base-record-batch-update.md
、
lark-base-shortcut-record-value.md
写前先
+field-list
;只写存储字段;
+record-batch-update
为同值更新(同一 patch 应用到多条记录);批量单次不超过
200
条;附件不要走这里
+record-upload-attachment
给已有记录上传附件
lark-base-record-upload-attachment.md
附件上传专用链路,不要用
+record-upsert
/
+record-batch-
伪造附件值
lark-cli docs +media-download
下载 Base 附件文件到本地
../lark-doc/references/lark-doc-media-download.md
Base 附件的
file_token
从
+record-get
返回的附件字段数组里取;
不要用
lark-cli drive +download
(对 Base 附件返回 403)
+record-delete / +record-history-list
删除记录,或查询某条记录的变更历史
lark-base-record-delete.md
、
lark-base-record-history-list.md
删除时用户已明确目标可直接执行并带
--yes
;历史查询按
table-id + record-id
,不支持整表扫描;
+record-history-list
只能串行执行
2.3.4 View 子模块
子模块索引:
references/lark-base-view.md
命令
用途 / 何时使用
必读 reference
路由提醒
+view-list / +view-get
列出视图,或获取视图详情
lark-base-view-list.md
、
lark-base-view-get.md
+view-list
只能串行执行;
+view-get
适合查看已有视图配置
+view-create / +view-delete / +view-rename
创建、删除或重命名视图
lark-base-view-create.md
、
lark-base-view-delete.md
、
lark-base-view-rename.md
创建前先确认表和视图类型;删除前先确认目标;用户已明确新名字时可直接重命名
+view-get-filter / +view-set-filter
读取或配置筛选条件
lark-base-view-get-filter.md
、
lark-base-view-set-filter.md
、
lark-base-record-list.md
常与
+record-list
组合,用于按视图筛选读取
+view-get-sort / +view-set-sort
读取或配置排序
lark-base-view-get-sort.md
、
lark-base-view-set-sort.md
字段名必须来自真实结构
+view-get-group / +view-set-group
读取或配置分组
lark-base-view-get-group.md
、
lark-base-view-set-group.md
字段名必须来自真实结构
+view-get-visible-fields / +view-set-visible-fields
读取或配置视图可见字段
lark-base-view-get-visible-fields.md
、
lark-base-view-set-visible-fields.md
用于控制视图中的字段顺序与可见性;字段名必须来自真实结构
+view-get-card / +view-set-card
读取或配置卡片视图
lark-base-view-get-card.md
、
lark-base-view-set-card.md
适合卡片展示场景
+view-get-timebar / +view-set-timebar
读取或配置时间轴视图
lark-base-view-get-timebar.md
、
lark-base-view-set-timebar.md
适合时间线展示场景
2.4 公式 / Lookup 模块
只要用户诉求涉及派生指标、条件判断、文本处理、日期差、跨表计算、跨表筛选后取值,都要先判断是否进入本模块。
默认优先考虑
formula
:适合常规计算、条件判断、文本处理、日期差、跨表聚合,以及需要长期显示在表里的派生结果。
只有当用户明确要求
lookup
,或场景天然符合
from / select / where / aggregate
这种固定查找建模时,再使用
lookup
。
命令
用途 / 何时使用
必读 reference
路由提醒
+field-create
(
type=formula
)
创建公式字段
formula-field-guide.md
、
lark-base-field-create.md
、
lark-base-shortcut-field-properties.md
没读 guide 前不要直接创建
+field-update
(
type=formula
)
更新公式字段
formula-field-guide.md
、
lark-base-field-update.md
、
lark-base-shortcut-field-properties.md
先拿当前表结构
+field-create
(
type=lookup
)
创建 lookup 字段
lookup-field-guide.md
、
lark-base-field-create.md
、
lark-base-shortcut-field-properties.md
没读 guide 前不要直接创建
+field-update
(
type=lookup
)
更新 lookup 字段
lookup-field-guide.md
、
lark-base-field-update.md
、
lark-base-shortcut-field-properties.md
跨表时还要拿目标表结构
2.5 数据分析模块
用于一次性分析和临时聚合查询。用户要的是“这次算出来的结果”,而不是把结果沉淀成字段时,优先进入本模块。
进入本模块前先确认几件事:
+data-query
只做聚合查询(分组、过滤、排序、聚合计算),不用于列出原始记录或逐条明细。
调用者必须是目标多维表格的管理员,拥有目标多维表格的 FA(Full Access / 完全访问权限),否则会返回权限错误。
+data-query
只支持白名单字段类型;
formula
、
lookup
、附件、系统字段、关联等字段不能用于
dimensions / measures / filters / sort
。
命令
用途 / 何时使用
必读 reference
路由提醒
+data-query
做分组统计、SUM / AVG / COUNT / MAX / MIN、条件筛选后的聚合分析
lark-base-data-query.md
字段名必须精确匹配真实字段名;不要用
+record-list
/
+record-search
拉全量再手算;
+data-query
不返回原始记录;使用前先确认权限和字段类型是否受支持
2.6 Workflow 模块
这是高约束模块。执行任何 workflow 命令前,都必须先读对应命令文档和 schema。
模块索引:
references/lark-base-workflow.md
命令
用途 / 何时使用
必读 reference
路由提醒
+workflow-list / +workflow-get
列出 workflow,或获取完整 workflow 结构
lark-base-workflow-list.md
、
lark-base-workflow-get.md
、
lark-base-workflow-schema.md
+workflow-list
只返回摘要且只能串行执行;需要完整结构时用
+workflow-get
+workflow-create / +workflow-update
创建或更新 workflow
lark-base-workflow-create.md
、
lark-base-workflow-update.md
、
lark-base-workflow-schema.md
先读 schema;禁止凭自然语言猜
type
;先确认真实表名和字段名
+workflow-enable / +workflow-disable
启用或停用 workflow
lark-base-workflow-enable.md
、
lark-base-workflow-disable.md
、
lark-base-workflow-schema.md
启用或停用前先确认目标 workflow;
workflow_id
与
table_id
需按前缀区分
2.7 Dashboard 模块
当用户提到“仪表盘、dashboard、数据看板、图表、可视化、block、组件、添加组件、创建图表”等关键词时,进入本模块,并先阅读
lark-base-dashboard.md
。
命令
用途 / 何时使用
必读 reference
路由提醒
+dashboard-list / +dashboard-get
列出仪表盘,或获取仪表盘详情
lark-base-dashboard-list.md
、
lark-base-dashboard-get.md
、
lark-base-dashboard.md
进入仪表盘语义后先读 guide;
+dashboard-list
只能串行执行
+dashboard-create / +dashboard-update / +dashboard-delete
创建、更新或删除仪表盘
lark-base-dashboard-create.md
、
lark-base-dashboard-update.md
、
lark-base-dashboard-delete.md
、
lark-base-dashboard.md
创建前先明确看板目标和展示场景;更新前先读取当前配置;删除前先确认目标
+dashboard-block-list / +dashboard-block-get
列出图表组件,或获取单个 block 详情
lark-base-dashboard-block-list.md
、
lark-base-dashboard-block-get.md
、
lark-base-dashboard.md
、
dashboard-block-data-config.md
+dashboard-block-list
只能串行执行;查看配置细节时读 block config 文档
+dashboard-block-create / +dashboard-block-update / +dashboard-block-delete
创建、更新或删除图表组件
lark-base-dashboard-block-create.md
、
lark-base-dashboard-block-update.md
、
lark-base-dashboard-block-delete.md
、
lark-base-dashboard.md
、
dashboard-block-data-config.md
涉及
data_config
、图表类型、filter 时要读 block config 文档;删除前先确认目标
2.8 表单模块
用于管理表单本体和表单题目。
模块索引:
references/lark-base-form.md
、
references/lark-base-form-questions.md
表单问题相关操作依赖
form-id
;具体获取方式见
form-list
和
form-create
的 reference。
命令
用途 / 何时使用
必读 reference
路由提醒
+form-list / +form-get
列出表单,或获取单个表单
lark-base-form-list.md
、
lark-base-form-get.md
+form-list
可用来获取
form-id
;
+form-get
适合查看已有表单配置
+form-create / +form-update / +form-delete
创建、更新或删除表单
lark-base-form-create.md
、
lark-base-form-update.md
、
lark-base-form-delete.md
创建后可继续进入表单问题相关操作;更新或删除前先确认目标表单
+form-questions-list
列出表单题目
lark-base-form-questions-list.md
适合查看已有题目结构
+form-questions-create / +form-questions-update / +form-questions-delete
创建、更新或删除题目
lark-base-form-questions-create.md
、
lark-base-form-questions-update.md
、
lark-base-form-questions-delete.md
先确认
form-id
;更新或删除前先确认题目目标
2.9 权限与角色模块
用于启用高级权限,以及管理 Base 自定义角色。
涉及
+advperm-enable / +advperm-disable / +role-
时,操作用户必须为 Base 管理员,否则会返回权限错误。
命令
用途 / 何时使用
必读 reference
路由提醒
+advperm-enable / +advperm-disable
启用或停用高级权限
lark-base-advperm-enable.md
、
lark-base-advperm-disable.md
管理角色前必须先启用;停用是高风险操作,会使已有自定义角色失效
+role-list / +role-get
列出角色,或获取角色详情
lark-base-role-list.md
、
lark-base-role-get.md
、
role-config.md
+role-list
只能串行执行;
+role-get
适合查看完整权限配置
+role-create / +role-update / +role-delete
创建、更新或删除角色
lark-base-role-create.md
、
lark-base-role-update.md
、
lark-base-role-delete.md
、
role-config.md
+role-create
仅支持
custom_role
;
+role-update
采用 Delta Merge,
role_name
和
role_type
即使不改也必须传当前值;
+role-delete
不可逆
3. 多维表格通用知识
飞书多维表格英文名是
Base
,曾用名
Bitable
;因此旧文档、返回字段、参数名或错误信息里出现
bitable
多属历史兼容,不代表应改用另一套命令体系。
3.1 字段分类与可写性
字段类型
含义
能否直接作为
+record-upsert / +record-batch-create / +record-batch-update
写入目标
说明
存储字段
真实存用户输入的数据
可以
常见如文本、数字、日期、单选、多选、人员、关联
附件字段
存储文件附件
不应直接按普通字段写
上传附件走
+record-upload-attachment
;下载附件走
lark-cli docs +media-download
系统字段
平台自动维护
不可以
常见如创建时间、更新时间、创建人、修改人、自动编号
formula
字段
通过表达式计算
不可以
只读字段
lookup
字段
通过跨表规则查找引用
不可以
只读字段
3.2 任务选路心智模型
用户诉求
优先方案
不要误走
一次性分析 / 临时统计
+data-query
不要用
+record-list
/
+record-search
拉全量后手算
要把结果长期显示在表里
formula
字段
不要只给一次性手工分析结果
用户明确要求 lookup,或天然是固定查找配置
lookup
字段
不要默认先上 lookup;先判断 formula 是否更合适
读取原始记录明细 / 关键词检索 / 导出
+record-search / +record-list / +record-get
不要拿
+data-query
当取数命令
上传附件到记录
+record-upload-attachment
不要用
+record-upsert
/
+record-batch-*
伪造附件值
下载记录里的附件文件
lark-cli docs +media-download --token
lark-base
安装
npx skills add https://github.com/larksuite/cli --skill lark-base