全面支持多维表格的增删改查,涵盖记录、字段、视图、仪表盘、工作流、角色、表单和高级权限 — CLI 中功能最丰富的模块,包含 60 个快捷命令。
Feishu CLI 多维表格模块是功能最丰富的领域,包含 60 个快捷命令,覆盖飞书多维表格(Base)的方方面面。所有命令使用 base 服务前缀,通过 Base v3 API 操作。
核心能力包括:
所有命令均支持用户和机器人身份。高风险操作(删除)支持 --dry-run 进行安全预览。
大多数多维表格命令共享以下通用引用参数。--base-token 几乎在所有操作中都是必需的,可从多维表格 URL 中提取。
| 参数 | 说明 |
|---|---|
--base-token | Base token(几乎所有命令都需要) |
--table-id | 数据表 ID 或名称 |
--field-id | 字段 ID 或名称 |
--view-id | 视图 ID 或名称 |
--record-id | 记录 ID |
在 Base 中创建、列出、获取、更新和删除数据表。创建数据表时支持内联定义字段和视图。
| 命令 | 说明 | 关键参数 |
|---|---|---|
+table-create | 创建数据表及可选字段/视图 | --name, --fields, --view |
+table-list | 列出所有数据表 | --base-token |
+table-get | 获取数据表详情 | --table-id |
+table-update | 更新数据表名称 | --table-id, --name |
+table-delete | 删除数据表 | --table-id |
创建、读取、更新和删除记录。+record-upsert 命令会根据是否提供 --record-id 智能决定是创建还是更新记录。支持直接向附件字段上传文件。
| 命令 | 说明 | 关键参数 |
|---|---|---|
+record-list | 列出数据表中的记录 | --view-id, --offset, --limit |
+record-get | 获取特定记录 | --record-id |
+record-upsert | 创建或更新记录 | --json, --record-id(可选) |
+record-upload-attachment | 向附件字段上传文件 | --record-id, --field-id, --file, --name |
+record-delete | 删除记录 | --record-id |
+record-history-list | 查看记录编辑历史 | --record-id |
创建、列出、获取、更新和删除字段。字段定义使用包含 field_name、type(数字编码)和可选 property(用于选项、公式和查找引用)的 JSON 对象。
| 类型编码 | 字段类型 | 类型编码 | 字段类型 |
|---|---|---|---|
| 1 | 文本 | 11 | 人员 |
| 2 | 数字 | 13 | 电话号码 |
| 3 | 单选 | 15 | 超链接 |
| 4 | 多选 | 17 | 查找引用 |
| 5 | 日期时间 | 18 | 公式 |
| 7 | 复选框 | 22 | 地理位置 |
| 命令 | 说明 |
|---|---|
+field-create | 创建带类型和属性定义的字段 |
+field-list | 列出数据表中的所有字段 |
+field-get | 获取字段详情 |
+field-update | 更新字段属性 |
+field-delete | 删除字段 |
+field-search-options | 搜索单选/多选选项 |
创建、列出、重命名和删除视图。配置视图级别的筛选、分组、排序、时间轴和卡片布局。每个配置项都有专用的获取和设置命令。
| 命令 | 说明 |
|---|---|
+view-create | 创建新视图 |
+view-list | 列出所有视图 |
+view-get | 获取视图详情 |
+view-delete | 删除视图 |
+view-rename | 重命名视图 |
+view-get-filter / +view-set-filter | 获取或设置视图筛选配置 |
+view-get-group / +view-set-group | 获取或设置视图分组 |
+view-get-sort / +view-set-sort | 获取或设置视图排序 |
+view-get-timebar / +view-set-timebar | 获取或设置甘特图/时间轴配置 |
+view-get-card / +view-set-card | 获取或设置卡片布局配置 |
使用 LiteQuery 协议查询和分析 Base 数据 — 这是一种支持维度、度量、聚合、筛选、排序和分组的 JSON DSL。DSL 中必须包含 dimensions 或 measures 至少其一。
| DSL 字段 | 说明 |
|---|---|
dimensions | 用于分组的字段名称数组 |
measures | {"field_name", "aggregator"} 对象数组(SUM、COUNT、AVG、MAX、MIN) |
filter | 包含 conjunction(and/or)和 conditions 数组的筛选对象 |
sort | {"field_name", "desc": true/false} 对象数组 |
权限范围:base:table:read
创建和管理仪表盘,支持图表区块、指标区块和其他可视化组件。仪表盘提供 Base 数据的可视化概览。
| 命令 | 说明 |
|---|---|
+dashboard-create | 创建仪表盘 |
+dashboard-list | 列出所有仪表盘 |
+dashboard-get | 获取仪表盘详情 |
+dashboard-update | 更新仪表盘名称或主题 |
+dashboard-delete | 删除仪表盘 |
+dashboard-block-create | 向仪表盘添加区块 |
+dashboard-block-list | 列出仪表盘中的区块 |
+dashboard-block-get | 获取区块详情 |
+dashboard-block-update | 更新仪表盘区块 |
+dashboard-block-delete | 删除仪表盘区块 |
在 Base 中创建和管理自动化工作流。工作流可以基于记录变更、时间条件或手动触发来执行操作。工作流定义以 JSON 格式传入,大型定义可使用 @path/to/file.json 语法从文件加载。
| 命令 | 说明 |
|---|---|
+workflow-create | 创建新工作流 |
+workflow-list | 列出所有工作流 |
+workflow-get | 获取工作流详情 |
+workflow-update | 更新工作流定义 |
+workflow-enable | 启用工作流 |
+workflow-disable | 禁用工作流 |
创建关联到 Base 数据表的表单并管理表单问题。表单提供用户友好的输入界面,用于向数据表收集记录。
| 命令 | 说明 |
|---|---|
+form-create | 为数据表创建表单 |
+form-list | 列出所有表单 |
+form-get | 获取表单详情 |
+form-update | 更新表单名称或描述 |
+form-delete | 删除表单 |
+form-questions-create | 向表单添加问题 |
+form-questions-update | 更新表单问题 |
+form-questions-delete | 删除表单问题 |
创建和管理自定义角色以实现细粒度的访问控制。可在 Base 级别启用或禁用高级权限。启用高级权限后,访问控制通过角色而非简单共享来管理。
| 命令 | 说明 |
|---|---|
+role-create | 创建自定义角色 |
+role-list | 列出所有角色 |
+role-get | 获取角色详情 |
+role-update | 更新角色 |
+role-delete | 删除角色 |
+advperm-enable | 启用高级权限 |
+advperm-disable | 禁用高级权限 |
获取 Base 信息、创建新 Base 或复制已有 Base。
| 命令 | 说明 |
|---|---|
+base-get | 获取 Base 元数据 |
+base-create | 创建新 Base |
+base-copy | 复制已有 Base |
+record-upload-attachment 每个文件最大 20 MB。lark-cli wiki spaces get_node 解析知识库 token 以获取实际的 Base token。--dry-run,可在执行前预览 API 调用。--field-id 参数既接受字段 ID(fldXXX)也接受字段名称。@path/to/file.json 语法替代内联 JSON 字符串。--i-have-read-guide。| 分类 | 命令 | 风险等级 | 说明 |
|---|---|---|---|
| 数据表 | +table-create | 写入 | 创建数据表及可选字段/视图 |
+table-list | 读取 | 列出所有数据表 | |
+table-get | 读取 | 获取数据表详情 | |
+table-update | 写入 | 更新数据表名称 | |
+table-delete | 写入 | 删除数据表 | |
| 记录 | +record-list | 读取 | 列出数据表中的记录 |
+record-get | 读取 | 获取特定记录 | |
+record-upsert | 写入 | 创建或更新记录 | |
+record-upload-attachment | 写入 | 向附件字段上传文件 | |
+record-delete | 写入 | 删除记录 | |
+record-history-list | 读取 | 查看记录编辑历史 | |
| 字段 | +field-create | 写入 | 创建字段 |
+field-list | 读取 | 列出所有字段 | |
+field-get | 读取 | 获取字段详情 | |
+field-update | 写入 | 更新字段属性 | |
+field-delete | 写入 | 删除字段 | |
+field-search-options | 读取 | 搜索选项 | |
| 视图 | +view-create | 写入 | 创建新视图 |
+view-list | 读取 | 列出所有视图 | |
+view-get | 读取 | 获取视图详情 | |
+view-delete | 写入 | 删除视图 | |
+view-rename | 写入 | 重命名视图 | |
+view-get-filter | 读取 | 获取视图筛选 | |
+view-set-filter | 写入 | 设置视图筛选 | |
+view-get-group | 读取 | 获取视图分组 | |
+view-set-group | 写入 | 设置视图分组 | |
+view-get-sort | 读取 | 获取视图排序 | |
+view-set-sort | 写入 | 设置视图排序 | |
+view-get-timebar | 读取 | 获取时间轴配置 | |
+view-set-timebar | 写入 | 设置时间轴配置 | |
+view-get-card | 读取 | 获取卡片布局 | |
+view-set-card | 写入 | 设置卡片布局 | |
| 查询 | +data-query | 读取 | 使用 JSON DSL 查询 |
| 仪表盘 | +dashboard-create | 写入 | 创建仪表盘 |
+dashboard-list | 读取 | 列出仪表盘 | |
+dashboard-get | 读取 | 获取仪表盘详情 | |
+dashboard-update | 写入 | 更新仪表盘 | |
+dashboard-delete | 写入 | 删除仪表盘 | |
+dashboard-block-create | 写入 | 添加区块 | |
+dashboard-block-list | 读取 | 列出区块 | |
+dashboard-block-get | 读取 | 获取区块详情 | |
+dashboard-block-update | 写入 | 更新区块 | |
+dashboard-block-delete | 写入 | 删除区块 | |
| 工作流 | +workflow-create | 写入 | 创建工作流 |
+workflow-list | 读取 | 列出工作流 | |
+workflow-get | 读取 | 获取工作流详情 | |
+workflow-update | 写入 | 更新工作流 | |
+workflow-enable | 写入 | 启用工作流 | |
+workflow-disable | 写入 | 禁用工作流 | |
| 表单 | +form-create | 写入 | 创建表单 |
+form-list | 读取 | 列出表单 | |
+form-get | 读取 | 获取表单详情 | |
+form-update | 写入 | 更新表单 | |
+form-delete | 写入 | 删除表单 | |
+form-questions-create | 写入 | 添加问题 | |
+form-questions-update | 写入 | 更新问题 | |
+form-questions-delete | 写入 | 删除问题 | |
| Base | +base-get | 读取 | 获取 Base 元数据 |
+base-create | 写入 | 创建新 Base | |
+base-copy | 写入 | 复制已有 Base | |
| 角色与权限 | +role-create | 写入 | 创建自定义角色 |
+role-list | 读取 | 列出角色 | |
+role-get | 读取 | 获取角色详情 | |
+role-update | 写入 | 更新角色 | |
+role-delete | 写入 | 删除角色 | |
+advperm-enable | 写入 | 启用高级权限 | |
+advperm-disable | 写入 | 禁用高级权限 |