lark-base-form-update.md 2.2 KB

base +form-update

前置条件: 先阅读 ../lark-shared/SKILL.md 了解认证、全局参数和安全规则。

更新多维表格数据表中指定表单的名称或描述。

命令

# 更新表单名称
lark-cli base +form-update \
  --base-token <base_token> \
  --table-id <table_id> \
  --form-id <form_id> \
  --name "新表单名称"

# 更新描述(纯文本)
lark-cli base +form-update \
  --base-token <base_token> \
  --table-id <table_id> \
  --form-id <form_id> \
  --description "新的描述内容"

# 更新描述(含链接)
lark-cli base +form-update \
  --base-token <base_token> \
  --table-id <table_id> \
  --form-id <form_id> \
  --description "新描述,[了解更多](https://example.com)"

# 同时更新名称和描述
lark-cli base +form-update \
  --base-token <base_token> \
  --table-id <table_id> \
  --form-id <form_id> \
  --name "新表单名称" \
  --description "新的描述内容"

参数

参数 必填 说明
--base-token <token> 多维表格 App token(base_token)
--table-id <id> 数据表 ID
--form-id <id> 表单 ID
--name <name> 新的表单名称
--description <string> 新的表单描述(纯文本或 Markdown 链接,如 [文本](https://example.com)
--format 输出格式:json(默认)| pretty | table | ndjson | csv
--as 身份:user(默认)| bot
--dry-run 预览 API 调用,不执行

--name--description 至少传一个,否则无实际变更。

输出格式

返回更新后的表单信息:

{
  "ok": true,
  "data": {
    "id": "vewX58te9D",
    "name": "新表单名称",
    "description": "新的描述内容"
  }
}

工作流

[!CAUTION] 这是写入操作 — 执行前必须向用户确认。

  1. 确认 form_id(可通过 +form-list 获取)
  2. 确认要修改的字段
  3. 执行命令并报告更新后的值

参考