- name
- lark-base
- version
- 1.2.0
- description
- 当需要用 lark-cli 操作飞书多维表格(Base)时调用:适用于建表、字段管理、记录读写、视图配置、历史查询,以及角色/表单/仪表盘管理/工作流;也适用于把旧的 +table / +field / +record 写法改成当前命令写法。涉及字段设计、公式字段、查找引用、跨表计算、行级派生指标、数据分析需求时也必须使用本 skill。
- metadata
- {"requires":{"bins":["lark-cli"]},"cliHelp":"lark-cli base --help"}
# base
> **前置条件:** 先阅读 [`../lark-shared/SKILL.md`](../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 前置约束
1. 先阅读 [`../lark-shared/SKILL.md`](../lark-shared/SKILL.md)。
2. Base 业务命令仅使用 `lark-cli base +...` 形式的 shortcut 命令;如果输入是 Wiki 链接,可先调用
`lark-cli wiki spaces get_node` 解析真实 token。
3. 定位到命令后,先读该命令对应的 reference,再执行命令。
4. 如果用户要把本地 Excel / CSV 导入成 Base / 多维表格 / bitable,第一步不是 `base`,而是
`lark-cli drive +import --type bitable`;导入完成后再回到 `lark-cli base +...` 做表内操作。
5. 不要在 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`](references/lark-base-workspace.md)
| 命令 | 用途 / 何时使用 | 必读 reference | 路由提醒 |
| -------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `+base-create` | 创建新的 Base | [`lark-base-base-create.md`](references/lark-base-base-create.md)、[`lark-base-workspace.md`](references/lark-base-workspace.md) | 写入操作;执行前先读 reference;`--folder-token`、`--time-zone` 都是可选项 |
| `+base-get` | 获取 Base 信息 | [`lark-base-base-get.md`](references/lark-base-base-get.md)、[`lark-base-workspace.md`](references/lark-base-workspace.md) | 适合确认 Base 本体信息,不替代表/字段结构读取 |
| `+base-copy` | 复制已有 Base | [`lark-base-base-copy.md`](references/lark-base-base-copy.md)、[`lark-base-workspace.md`](references/lark-base-workspace.md) | 写入操作;执行前先读 reference;复制成功后应主动返回新 Base 标识信息 |
### 2.3 表与数据模块
这是最常用的大模块,包含 `table / field / record / view` 四类子模块。
补充示例:[`references/examples.md`](references/examples.md),适合需要串联 table / record /
view 完整操作链路时再读。
#### 2.3.1 Table 子模块
子模块索引:[`references/lark-base-table.md`](references/lark-base-table.md)
| 命令 | 用途 / 何时使用 | 必读 reference | 路由提醒 |
| ----------------------------------------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `+table-list / +table-get` | 列出数据表,或获取单个表详情 | [`lark-base-table-list.md`](references/lark-base-table-list.md)、[`lark-base-table-get.md`](references/lark-base-table-get.md) | `+table-list` 只能串行执行;`+table-get` 适合删除/修改前确认目标 |
| `+table-create / +table-update / +table-delete` | 创建、更新或删除数据表 | [`lark-base-table-create.md`](references/lark-base-table-create.md)、[`lark-base-table-update.md`](references/lark-base-table-update.md)、[`lark-base-table-delete.md`](references/lark-base-table-delete.md) | 创建适合一次性建表;更新前先确认目标表;删除时用户已明确目标可直接执行并带 `--yes` |
#### 2.3.2 Field 子模块
普通字段管理走这里;如果字段类型是 `formula` 或 `lookup`,转到下方“公式 / Lookup 模块”。
子模块索引:[`references/lark-base-field.md`](references/lark-base-field.md)
| 命令 | 用途 / 何时使用 | 必读 reference | 路由提醒 |
| ----------------------------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------- |
GitHubで見る