lark-base
larksuite/cli
lark-cli를 사용하여 페이스북 오피스 다차원 표(Base)를 조작해야 할 때 호출합니다: 테이블 생성, 필드 관리, 레코드 읽기/쓰기, 뷰 설정, 이력 조회는 물론, 역할/폼/대시보드 관리에도 적합합니다. 또한 기존의 +table / +field / +record 표기법을 현재 명령어 표기법으로 변경하는 데에도 활용됩니다. 필드 설계, 공식 필드, 찾아보기 참조, 타 테이블 간 계산, 행 단위 파생 지표, 데이터 분석 관련 작업을 할 경우에도 반드시 이 스킬을 사용해야 합니다.
...모든 것을 확장하십시오lark-base에 대하여
lark-base 스킬은 lark-cli를 통해 Lark의 Base 플랫폼과 상호작용하는 데 사용되는 도구입니다. 이 도구를 활용하면 테이블, 필드, 레코드, 뷰 및 과거 쿼리를 관리할 수 있어 테이블 생성, 필드 관리, 데이터 분석과 같은 작업에 매우 적합합니다. 또한 기존 명령어들(+table, +field, +record 등)을 현재의 명령어 구조로 전환하는 데에도 유용하게 활용됩니다. 필드 설계, 공식 필드, 참조 조회, 테이블 간 계산, 행 단위 파생 지표와 관련된 작업에서 이 스킬은 필수적인 역할을 하며, Lark의 고급 데이터 관리 워크플로우에 있어 핵심 도구가 됩니다.
이 스킬은 데이터 조회, 레코드 검색 및 삽입, 공식 필드 생성, 참조 조회 필드 관리 등 다양한 기능을 포함합니다. 테이블 생성, 레코드 조작, 테이블 간 쿼리와 같은 작업 시 반드시 준수해야 할 단계들을 명시함으로써 데이터의 일관성과 정확성을 보장하는 엄격한 가이드라인도 제공합니다. 주요 기능으로는 저장 필드, 시스템 필드, 그리고 공식 필드나 참조 조회 필드와 같은 계산된 필드들의 처리가 포함됩니다. 또한 데이터 분석을 수행하고 워크플로우를 구현할 수 있는 프레임워크도 제공하여, 사용자들이 레코드와 뷰를 생성하고 관리하는 데 있어 모범 사례를 준수할 수 있도록 지원합니다. 전반적으로 lark-base 스킬은 Lark의 Base 환경에서 작업하며 데이터 작업 및 워크플로우를 효율화해야 하는 모든 사용자에게 매우 중요한 도구입니다.
이 스킬은 특히 데이터 분석가, 데이터베이스 관리자, 그리고 Lark의 Base 시스템 내에서 데이터를 관리해야 하는 모든 사람들에게 매우 유용합니다. 테이블과 필드의 생성 및 수정, 쿼리 실행, 워크플로우 자동화에 있어 체계적인 접근 방식을 강제함으로써 효율적인 데이터 관리를 가능하게 합니다. 복잡한 데이터 모델을 구축하거나, 프로세스를 자동화하며, 고급 보고서를 생성해야 하는 사용자들에게 이 스킬은 워크플로우에서 없어서는 안 될 도구가 됩니다.
FAQ
lark-base를 사용하기 위한 사전 요구 사항은 무엇인가요?
lark-base를 사용하려면 먼저 lark-cli가 설치되어 있어야 합니다. 또한 각 명령어의 올바른 사용 방법을 숙지하기 위해 해당 명령어 참고 자료도 반드시 읽어보아야 합니다.
Lark Base의 필드 유형에는 어떤 것들이 있나요?
Lark Base에는 세 가지 종류의 필드가 있습니다. 실제 사용자 데이터를 저장하는 저장 필드, 플랫폼에서 자동으로 관리되며 읽기 전용인 시스템 필드, 그리고 다른 필드나 테이블의 데이터를 바탕으로 자동으로 값을 계산하는 공식 필드와 참조 조회 필드 같은 계산된 필드가 있습니다.
lark-base를 사용해 공식 필드나 참조 조회 필드를 수정할 수 있나요?
아니요, 공식 필드와 참조 조회 필드는 읽기 전용이므로 +record-upsert 명령어를 사용해 직접 수정할 수 없습니다. 이러한 필드들은 다른 필드나 테이블의 데이터를 기반으로 자동으로 값을 계산하도록 설계되었습니다.
lark-base는 기존 명령어와 호환되나요?
네, lark-base는 +table, +field, +record와 같은 기존 명령어들을 현재의 명령어 구조로 전환하는 것을 지원하여, 사용자들이 자신의 워크플로우를 현대화할 수 있도록 돕습니다.
lark-base에서 워크플로우는 어떤 역할을 하나요?
lark-base의 워크플로우는 단계, 트리거, 작업, 루프를 정의함으로써 사용자가 작업을 자동화할 수 있도록 해줍니다. 어떤 워크플로우 명령어든 실행하기 전에, 사용자는 올바른 구문과 스키마를 준수하고 있는지 확인하기 위해 해당 문서를 참조해야 합니다.
base
何时使用
使用本 skill:
- 用户明确提到 Base / 多维表格 / bitable,或给出
/base/链接。 - 用户要在 Base 内建表、改表、管理字段、写记录、查记录、配视图。
- 用户要在 Base 内做公式字段、lookup 字段、跨表计算、派生指标、筛选聚合、TopN、统计分析。
- 用户要管理 Base 表单、仪表盘、workflow、高级权限或角色。
- 用户要把旧 Base 聚合式命令或旧写法迁移到当前
lark-cli base +...shortcut。
不要使用本 skill:
- 只是认证、初始化配置、切换身份、处理 scope 或权限授权恢复,转
lark-shared。 - 把本地 Excel / CSV /
.base导入成 Base,转lark-drive +import --type bitable。 - 泛化数据分析、字段设计、公式讨论,但没有 Base/多维表格上下文。
使用边界
- Base 业务操作只使用
lark-cli base +...shortcut,不使用旧聚合式+table / +field / +record / +view / +history / +workspace。 - 本轮 Base 不依赖
lark-cli schema。SKILL 只保留路由、风险和复杂 JSON/DSL;简单命令由命令自身的参数、tips 和错误恢复承接。 - 用户要把 Excel / CSV /
.base导入成 Base 时,先转lark-cli drive +import --type bitable,导入完成后再回到 Base 命令。 - 用户只给 Base 名称或关键词时,先用
lark-cli drive +search --query <keyword> --doc-types bitable定位资源。 - Base 命令必须先有
base_token或可解析出的 Base URL。没有 token 时:用户要新建就用+base-create;用户给标题/关键词就搜lark-cli drive +search --query "<base title>" --doc-types bitable --only-title --as user;仍无法定位时,反问用户具体是哪一个 Base。 - 认证、初始化、scope、身份切换、权限不足恢复属于
lark-shared;Base 文档只保留会影响 Base 路径选择的权限规则。
快速路由
| 用户目标 | 优先命令 | 何时读 reference |
|---|---|---|
| 查 Base 本体 | +base-get | 用返回确认 Base 名称、owner、权限和可继续操作的 token |
| 创建/复制 Base | +base-create / +base-copy | 新建时强烈推荐用 --table-name + --fields 同时配置新 Base 里唯一一个初始数据表的 name 和 schema;写入后报告新 Base 标识和 permission_grant |
| 查看 Base 内资源目录 | +base-block-list | 想先了解一个 Base 里有哪些 table/docx/dashboard/workflow/folder 时优先用它;返回 ID 关系和 fewshot 看 --help |
| 管理 Base 内资源目录 | +base-block-create/move/rename/delete | 创建或整理 Base 直接管理的 folder/table/docx/dashboard/workflow;资源内容继续用对应命令 |
| 管理数据表 | +table-list/get/create/update/delete | 处理 table 的列出、详情、创建、重命名和删除 |
| 列/查/删字段 | +field-list/get/delete/search-options | 写入前用 list/get 确认字段类型、选项、ID;删除前确认目标字段 |
| 创建/更新字段 | +field-create / +field-update | 必读 lark-base-field-json.md;公式读 formula-field-guide.md;lookup 读 lookup-field-guide.md;命令细节读 lark-base-field-create.md / lark-base-field-update.md |
| 读记录明细 | +record-get / +record-list / +record-search | 涉及筛选、排序、Top/Bottom N、聚合、多表关联、全局结论时读 lark-base-data-analysis-sop.md |
| 写记录 | +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-cell-value.md |
| 附件字段 | +record-upload-attachment / +record-download-attachment / +record-remove-attachment | 附件不要伪造成普通 CellValue;上传走本地文件,下载/删除按 file token 或字段定位 |
| 删除记录 / 分享记录链接 / 历史 | +record-delete / +record-share-link-create / +record-history-list | 删除前确认 record;分享链接最多 100 条;历史读 lark-base-record-history-list.md,只查单条记录,不做整表审计 |
| 管理视图 | +view-* | +view-set-filter 读 lark-base-view-set-filter.md;其余配置先 get 现状,再按返回结构更新 |
| 一次性聚合统计 | +data-query | 必读 lark-base-data-analysis-sop.md 和入口 lark-base-data-query-guide.md;完整 DSL 再读 lark-base-data-query.md |
| 公式字段 | +field-create/update --json '{"type":"formula",...}' | 必读 formula-field-guide.md,读后再加隐藏确认 flag --i-have-read-guide |
| Lookup 字段 | +field-create/update --json '{"type":"lookup",...}' | 必读 lookup-field-guide.md,读后再加隐藏确认 flag --i-have-read-guide |
| 表单提交 | +form-submit | 先读 lark-base-form-detail.md 获取题目、filter 和附件所需 base_token;提交 JSON 读 lark-base-form-submit.md |
| 表单题目创建/更新 | +form-questions-create / +form-questions-update | 读 lark-base-form-questions-create.md / lark-base-form-questions-update.md |
| 其他表单管理 | +form-list/get/detail/create/update/delete / +form-questions-list/delete | +form-detail 读 lark-base-form-detail.md;删除前确认目标表单 |
| 仪表盘与组件 | +dashboard-* / +dashboard-block-* | 提到图表/看板/block 时先读 lark-base-dashboard.md;组件 data_config 读 dashboard-block-data-config.md;读取图表计算结果用 +dashboard-block-get-data |
| Workflow | +workflow-* | 创建/更新或理解 steps 时读入口 lark-base-workflow-guide.md 和 steps JSON SSOT lark-base-workflow-schema.md;list/get/enable/disable 只处理 workflow ID 与启停状态 |
| 高级权限与角色 | +advperm-* / +role-* | 角色操作先读入口 lark-base-role-guide.md;角色 create/update 或解读完整配置再读权限 JSON SSOT role-config.md;系统角色不可删除;关闭高级权限会影响自定义角色 |
Base 心智模型
- Base 曾用名 Bitable;返回字段、错误或旧文档里的
bitable多为历史兼容,不代表应改走裸 API 或另一套命令。 +base-block-list是查看一个 Base 内资源目录的新入口:它列出这个 Base 直接管理的folder/table/docx/dashboard/workflow,适合先判断 Base 里有什么,再决定走 table、dashboard、workflow 或 docx 命令。base-block只负责资源目录管理,包括创建资源、移动到 folder、重命名和删除;具体资源内容仍走 table/dashboard/workflow 命令。- 新建 Base 时,强烈推荐一次性执行
lark-cli base +base-create --name "<base>" --table-name "<table>" --fields '<field-json-array>',同时配置新 Base 里唯一一个初始数据表的 name 和 schema;使用--fields前先读 lark-base-field-json.md 或复用+field-create的字段 JSON 形状,不要猜字段属性。 +base-create不传--table-name和--fields时,会创建一个默认 schema 的初始数据表。- 表、字段、视图、workflow、dashboard block 的名称和 ID 必须来自真实返回,不要凭用户口述猜。
- 存储字段可写;系统字段、
formula、lookup只读;附件字段走专用 attachment 命令。 - 一次性原始记录查询优先用
+record-list/+record-search的 filter/sort;聚合分析优先用+data-query;需要长期显示在表中时,才新增formula/lookup字段。 formula适合常规计算、条件判断、文本/日期处理和长期派生指标;lookup适合明确的跨表查找、筛选后取值或聚合引用。- 写入、分析、公式、lookup、workflow、dashboard 前,先读取真实结构:表、字段、视图、关联表和 dashboard block 名称都以命令返回为准。
- 跨表场景必须读取目标表结构;link 单元格中的关联
record_id只是连接键,最终回答要回查并展示用户可读字段。
身份与权限降级
- 默认显式使用
--as user操作用户资源;只有用户明确要求应用身份时,才直接用--as bot。 - user 身份报 scope/授权不足,或错误中包含
permission_violations/hint,先转lark-shared做用户授权恢复,不要直接降级 bot。 - user 身份报资源级无访问且无授权恢复提示时,才可用
--as bot重试一次;bot 仍失败就停止重试并按权限错误处理。 91403或明确不可访问错误不要循环换身份重试。+base-create/+base-copy若用 bot 身份执行,关注返回中的permission_grant,并把用户是否可打开新 Base 告知用户。
查询与统计规则
涉及查询、统计或判断结论时,先阅读 lark-base-data-analysis-sop.md,并遵守:
+record-list的默认页、固定--limit和本地jq只能证明已读取范围内的事实,不能直接支撑全局最值、全量计数、Top/Bottom N、异常识别或分组结论。- 能由 Base 表达的筛选、排序、投影、聚合、分组和限制,应在 Base 云端查询能力中执行;不要先拉原始记录到本地上下文再手工筛选排序。
has_more=true或等价分页信号表示当前结果不是全量;除非用户只要样例/前 N 条,不能基于该页回答全局问题。- 多表查询必须先确认关系字段和连接键;link 单元格里的
record_id是关系键,不是用户可读答案。 - 最终答案必须能追溯到真实表、真实字段、查询范围、筛选/排序/聚合条件和必要的连接键。
- 一次性原始记录查询优先用
+record-list/+record-search的 filter/sort;聚合分析优先用+data-query;要把结果长期显示在表里,才考虑新增formula/lookup字段。 +data-query可返回聚合结果或维度字段行,但维度行按字段组合去重且不返回record_id;需要逐条记录、记录定位或完整行级字段时,再用+record-list/+record-search/+record-get回查。
写入前置规则
- 写记录前先读字段结构;只写存储字段。系统字段、附件字段、
formula、lookup不作为普通记录写入目标。 - 附件上传、下载、删除走专用
+record-*-attachment命令。 - 写字段前先读 lark-base-field-json.md;涉及
formula/lookup时必须读 formula-field-guide.md / lookup-field-guide.md。 - 表名、字段名、视图名、workflow 配置中的名称必须来自真实返回;跨表场景还要读取目标表结构。
- 删除、角色更新、字段更新等高风险操作遵循 CLI 的 confirmation gate;目标不明确时先用 get/list 消歧。
- 批量写入单批最多 200 条;连续写同一表时串行执行,遇到
1254291按短暂等待后重试处理。 +record-batch-update是“同值批量更新”:同一份 patch 应用到全部record_id_list,不要拿它做逐行不同值映射。- select/multiselect 写入未知选项可能触发平台新增选项;不是要新增时,先用
+field-list或+field-search-options确认可选值。
表单与视图细节
+form-submit前必须先跑+form-detail,读取questions[].type、required、filter和附件场景需要的base_token;不要填写被 filter 隐藏的问题。- 表单附件不要写进
fields,放在--json.attachments;提交附件时必须同时传表单所属 Base 的--base-token。 +view-set-filter是唯一保留的 view reference;sort/group/card/timebar/visible-fields 这类配置先用对应 get 命令读现状,保留未修改字段,只替换用户要求变更的配置。- 视图适合持久化、共享和 UI 复用;一次性筛选/排序可先用
+record-list/+record-search的 filter/sort 验证结果,再按需要沉淀为持久视图。
Token 与链接
| 输入类型 | 含义 / 正确处理方式 |
|---|---|
/base/{token} | 普通 Base 链接;提取 /base/ 后的 token 作为 --base-token |
/wiki/{token} | Wiki 节点链接;先 wiki +node-get,当 data.obj_type=bitable 时使用 data.obj_token 作为 --base-token |
/base/{token}?table={id} | table 参数用于定位 Base 内对象:tbl 开头是数据表 --table-id;blk 开头是 dashboard ID;wkf 开头是 workflow ID |
/base/{token}?view={id} | view 参数用于定位表视图,提取为 --view-id;通常还需要确认 table 参数或先查表结构 |
/share/base/form/{shareToken} | 表单分享链接;这是表单 share token,走 +form-detail / +form-submit --share-token <shareToken> |
/share/base/view/{shareToken} | 视图分享链接;具有分享权限语义,暂不支持用 CLI 直接访问,引导用户在浏览器或飞书客户端打开 |
/share/base/dashboard/{shareToken} | 仪表盘分享链接;具有分享权限语义,暂不支持用 CLI 直接访问,引导用户在浏览器或飞书客户端打开 |
/record/{shareToken} | 记录分享链接;暂不支持用 CLI 直接访问,引导用户在浏览器或飞书客户端打开。若用户想生成现有记录的分享链接,用 +record-share-link-create --base-token <base_token> --table-id <table_id> --record-ids <record_id> |
/base/workspace/{token} | BaseApp / workspace 链接;暂不支持用 CLI 直接访问 |
wiki +node-get 返回非 bitable 时,不继续使用 Base 命令:docx 转文档,sheet 转表格,其他云空间对象转对应 skill 或 drive。
Dashboard / Workflow / Role
- Dashboard 的复杂点是 block 的
data_config,不是 list/get/create/delete 命令参数。创建或更新 block 前先读 dashboard-block-data-config.md,组件必须串行创建;+dashboard-arrange是服务端智能布局,只在用户明确要求重排/美化时执行。+dashboard-block-get-data读取图表最终计算结果,不返回 block 名称、类型、布局或data_config;需要元数据先用+dashboard-block-get。 - Workflow 的复杂点是
steps结构。创建、更新或解释完整 workflow 时读入口 lark-base-workflow-guide.md 和 steps JSON SSOT lark-base-workflow-schema.md;enable/disable/list 只需确认 workflow ID、当前启停状态和用户意图。 - Role 的复杂点是权限 JSON。角色操作先读入口 lark-base-role-guide.md;
+role-create只支持自定义角色;+role-update是 delta merge;角色 create/update 或解读完整配置时读权限 JSON SSOT role-config.md。+role-delete只适用于自定义角色,系统角色不可删除;删除角色和关闭高级权限前必须确认目标和影响。
常见恢复
| 错误 / 现象 | 恢复动作 |
|---|---|
param baseToken is invalid / base_token invalid | 检查是否把 wiki token、workspace token 或完整 URL 当成了 --base-token;按 Token 与链接 重新定位真实 Base token |
not found 且输入来自 Wiki 链接 | 优先检查是否把 wiki token 当成 base token,不要立刻改走裸 API |
1254045 字段名不存在 | 重新 +field-list,使用真实字段名或字段 ID;注意空格、大小写和跨表字段 |
1254015 字段值类型不匹配 | 先 +field-list,再按 lark-base-cell-value.md 构造 CellValue |
| 日期 / 人员 / 超链接字段报格式错误 | 日期用 YYYY-MM-DD HH:mm:ss;人员用 [{ "id": "ou_xxx" }];超链接用 URL 或 markdown link 字符串 |
| formula / lookup 创建失败 | 先读 formula-field-guide.md / lookup-field-guide.md,再按 guide 重建请求 |
ignored_fields / READONLY | 移除只读字段,只写存储字段 |
1254104 | 批量超过 200,分批调用 |
1254291 | 并发写冲突,串行写入并在批次间短暂等待 |
91403 | 无权限访问该 Base,按 lark-shared 权限流程处理,不要盲目重试 |
保留 Reference
- lark-base-data-analysis-sop.md:查询/统计/全局结论的选路 SOP
- lark-base-data-query-guide.md / lark-base-data-query.md:聚合查询入口 fewshot 与 DSL SSOT
- lark-base-cell-value.md:记录 CellValue 构造
- lark-base-field-json.md:字段 JSON 构造
- formula-field-guide.md / lookup-field-guide.md:公式与 lookup 字段
- lark-base-field-create.md / lark-base-field-update.md:字段创建/更新命令级补充
- lark-base-record-upsert.md / lark-base-record-batch-create.md / lark-base-record-batch-update.md / lark-base-record-history-list.md:记录写入 JSON 与历史返回解释
- lark-base-view-set-filter.md:视图筛选 JSON
- lark-base-form-detail.md / lark-base-form-submit.md / lark-base-form-questions-create.md / lark-base-form-questions-update.md:表单详情、提交和复杂 JSON
- lark-base-dashboard.md / dashboard-block-data-config.md / lark-base-dashboard-block-get-data.md:仪表盘、组件配置与图表结果协议
- lark-base-workflow-guide.md / lark-base-workflow-schema.md:workflow 入口与 steps JSON SSOT
- lark-base-role-guide.md / role-config.md:角色入口与权限 JSON SSOT
lark-base 설치
해당 스킬 파일들을 다운로드하여 .claude/skills/ 디렉터리에 압축을 풀어 저장하세요.
ZIP 다운로드저장소를 클론하고 스킬 파일을 프로젝트에 복사하세요.
git clone https://github.com/larksuite/cli/blob/main/skills/lark-base/SKILL.md # Copy SKILL.md to your .claude/skills/ directory
복사





집
