Feishu Cli Write

核心概念

Markdown 作为中间态：本地文档与飞书云文档之间通过 Markdown 格式进行转换，中间文件存储在 /tmp 目录中。

CRITICAL: 禁止对已有文档全量覆盖

绝对禁止对已有文档使用 doc import --document-id <id> 全量覆盖！这会：

• 丢失所有划词评论（inline comments）
• 破坏画板/白板引用（变成空占位块）
• 丢失用户手动编辑的格式和内容

更新已有文档必须使用增量方式：doc add（追加）、doc update（修改块）、doc delete（删除块）。 doc import --document-id 仅允许在用户明确要求全量替换时使用。

使用方法

# 创建新文档
/feishu-write "文档标题"

# 更新已有文档
/feishu-write <document_id>

执行流程

创建新文档

1. 收集内容

   • 与用户确认文档标题
   • 收集用户提供的内容或根据对话生成内容

2. 生成 Markdown

   • 在 /tmp/feishu_write_<timestamp>.md 创建 Markdown 文件
   • 使用标准 Markdown 语法
   • 编码验证（防御性检查）：文件写入后，运行 python3 -c "d=open('<file.md>','rb').read(); assert b'\\xef\\xbf\\xbd' not in d, 'U+FFFD found'; d.decode('utf-8')" 同时检查 U+FFFD 替换字符和非法 UTF-8 字节。如果报错，必须修复后再导入飞书

3. 导入到飞书

   feishu-cli doc import /tmp/feishu_write_<timestamp>.md --title "文档标题"
   

4. 添加权限（可选，给指定用户添加 full_access） full_access 是最高权限，包含：管理协作者、编辑内容、管理文档设置（复制/移动/删除）、查看历史版本、导出等全部能力。

   feishu-cli perm add <document_id> --doc-type docx --member-type email --member-id [email protected] --perm full_access
   

5. 通知用户

   • 提供文档链接
   • 发送飞书消息通知

更新已有文档（增量更新）

原则：只修改需要变更的部分，保留其余内容不动。优先使用 content-update 命令，一条命令精准定位并替换。

CRITICAL: 修改文档时禁止使用 append 模式

当用户要求"修改"、"更新"、"替换"、"编辑"文档中某段内容时，必须使用 replace_range 或 replace_all 模式，精准定位并替换目标内容。

禁止将整个文档内容重新 Append 到末尾！这会导致文档内容重复。 append 模式仅在用户明确要求"追加新内容"、"在末尾加一段"时使用。

决策树（按用户意图选择模式）

关键规则：

• 用户说"修改/更新/替换/编辑某个章节" → 必须用 replace_range，禁止用 append
• 用户说"添加/追加/新增内容到末尾" → 用 append
• 用户说"在某处插入" → 用 insert_before 或 insert_after
• 用户说"删除某段内容" → 用 delete_range

场景 A：替换某个章节（最常用）

# 按标题定位并替换（从 H2 标题到下一个 H2，一条命令完成）
feishu-cli doc content-update <document_id> --mode replace_range \
  --selection-by-title "## 旧章节标题" \
  --markdown-file /tmp/feishu_new_section.md

# 也可以直接传 markdown 内容
feishu-cli doc content-update <document_id> --mode replace_range \
  --selection-by-title "## 旧章节标题" \
  --markdown "## 新章节标题\n\n更新后的内容"

场景 B：在文档指定位置插入内容

# 在"目标章节"后面插入新内容
feishu-cli doc content-update <document_id> --mode insert_after \
  --selection-by-title "## 目标章节" \
  --markdown-file /tmp/feishu_insert.md

# 在"目标章节"前面插入新内容
feishu-cli doc content-update <document_id> --mode insert_before \
  --selection-by-title "## 目标章节" \
  --markdown "## 新增章节\n\n插入的内容"

场景 C：在文档末尾追加新内容

仅在确实需要追加新内容到末尾时使用：

cat > /tmp/feishu_append.md << 'EOF'
## 新增章节标题

新增的内容...
EOF

feishu-cli doc content-update <document_id> --mode append \
  --markdown-file /tmp/feishu_append.md

场景 D：删除指定章节

# 按标题定位并删除整个章节
feishu-cli doc content-update <document_id> --mode delete_range \
  --selection-by-title "## 废弃章节"

# 按内容范围定位并删除
feishu-cli doc content-update <document_id> --mode delete_range \
  --selection-with-ellipsis "开始段落...结束段落"

场景 E：全文查找替换

# 替换所有匹配的块
feishu-cli doc content-update <document_id> --mode replace_all \
  --selection-with-ellipsis "旧文本" \
  --markdown "新文本"

场景 F：修改单个块的内容（低级 API）

仅在需要精确控制单个块时使用：

# 1. 获取文档块结构，找到要修改的 block_id
feishu-cli doc blocks <document_id>

# 2. 更新指定块
feishu-cli doc update <document_id> <block_id> \
  --content '{"update_text_elements":{"elements":[{"text_run":{"content":"更新后的文本"}}]}}'

何时允许全量覆盖：仅当用户明确说"重写整个文档"、"全量替换"时，才可使用 content-update --mode overwrite 或 doc import --document-id <id>。默认必须增量更新。

支持的 Markdown 语法

推荐：使用 Mermaid / PlantUML 画图

在文档中画图时，推荐使用 Mermaid（也支持 PlantUML），会自动转换为飞书画板。

支持的 Mermaid 图表类型：

• ✅ flowchart（流程图，支持 subgraph）
• ✅ sequenceDiagram（时序图）
• ✅ classDiagram（类图）
• ✅ stateDiagram-v2（状态图）
• ✅ erDiagram（ER 图）
• ✅ gantt（甘特图）
• ✅ pie（饼图）
• ✅ mindmap（思维导图）

Mermaid 限制（必须遵守，否则导入失败）：

• ❌ 禁止在 flowchart 节点标签中使用 {} 花括号（如 {version}），会触发解析错误
• ❌ 禁止使用 par...and...end 语法，飞书解析器完全不支持
• ❌ 避免复杂度超限：10+ participant + 2+ alt 块 + 30+ 长消息标签会触发服务端 500
• ✅ 安全阈值：participant ≤ 8、alt ≤ 1、消息标签尽量简短
• ✅ par 替代方案：改用 Note over X: 并行执行...
• ✅ 导入失败的图表会自动降级为代码块展示，不会丢失内容

示例：

```mermaid
flowchart TD
    A[开始] --> B{判断}
    B -->|是| C[处理]
    B -->|否| D[结束]
```

```plantuml
@startuml
Alice -> Bob: Hello
Bob --> Alice: Hi
@enduml
```

Callout 高亮块

在文档中使用 Callout 语法创建飞书高亮块：

> [!NOTE]
> 提示信息。

> [!WARNING]
> 警告信息。

> [!TIP]
> 技巧提示。

> [!CAUTION]
> 警示信息。

> [!IMPORTANT]
> 重要信息。

> [!SUCCESS]
> 成功信息。

Callout 内支持多行文本和子块（列表等）。

公式

行内公式：圆面积 $S = \pi r^2$，周长 $C = 2\pi r$。

块级公式：
$$\int_{0}^{\infty} e^{-x^2} dx = \frac{\sqrt{\pi}}{2}$$

高级操作

添加画板

向文档添加空白画板：

# 在文档末尾添加画板
feishu-cli doc add-board <document_id>

# 在指定位置添加画板
feishu-cli doc add-board <document_id> --parent-id <block_id> --index 0

添加 Callout

向文档添加高亮块：

# 添加信息类型 Callout
feishu-cli doc add-callout <document_id> "提示内容" --callout-type info

# 添加警告类型 Callout
feishu-cli doc add-callout <document_id> "警告内容" --callout-type warning

# 指定位置添加
feishu-cli doc add-callout <document_id> "内容" --callout-type error --parent-id <block_id> --index 0

Callout 类型与颜色映射：

飞书 Callout 共 6 种颜色。Markdown 导入（doc import）使用 [!TYPE] 语法支持全部 6 种，CLI 命令（doc add-callout --callout-type）支持其中 4 种：

需要橙色（CAUTION）或紫色（IMPORTANT）时，请使用 Markdown 导入方式（doc import 或 doc add --content-type markdown）。

批量更新块

批量更新文档中的块内容：

# 从 JSON 文件批量更新
feishu-cli doc batch-update <document_id> --source-type content --file updates.json

JSON 格式示例：

[
  {
    "block_id": "block_xxx",
    "block_type": 2,
    "content": "更新后的文本内容"
  }
]

输出格式

创建/更新完成后报告：

• 文档 ID
• 文档 URL：https://feishu.cn/docx/<document_id>
• 操作状态

示例

# 创建新的会议纪要
/feishu-write "2024-01-21 周会纪要"

# 更新现有文档
/feishu-write <document_id>

向文档插入图片或文件

通过 doc media-insert 命令向文档中插入本地图片或文件。

插入图片

图片采用三步法：上传素材 → 创建 Image Block → 设置对齐和描述。

# 插入图片（默认居中对齐）
feishu-cli doc media-insert <document_id> --file /path/to/image.png

# 指定对齐方式和描述
feishu-cli doc media-insert <document_id> \
  --file /path/to/screenshot.png \
  --type image \
  --align left \
  --caption "系统架构图"

插入文件

文件采用三步法：上传素材 → 创建 File Block → 关联文件。

# 插入文件附件
feishu-cli doc media-insert <document_id> \
  --file /path/to/report.pdf \
  --type file

参数说明

两种模式的区别

常见问题

content-update 定位参考

完整的模式决策树和使用示例见上方"更新已有文档"部分。以下是定位方式的详细说明。

定位方式

标题定位规则：

• "## 标题文本" — 匹配 H2 级别且包含"标题文本"的标题
• 范围自动延伸到下一个同级或更高级标题（或文档末尾）

内容范围定位规则：

• "开头...结尾" — 从包含"开头"的块到包含"结尾"的块（左闭右闭）
• 不含 ... 时作为精确匹配，匹配所有包含该文本的块

其他参数

--markdown 和 --markdown-file 不能同时使用。

Markdown 扩展语法（HTML 标签）

除标准 Markdown 语法外，导入时还支持以下 HTML 标签形式的扩展语法。这些标签由导出端自动生成，支持 roundtrip（导出→导入不丢失信息）。

@用户（MentionUser）

<mention-user id="ou_xxx"/>

导入时创建 MentionUser 元素，id 为用户的 Open ID。

@文档（MentionDoc）

<mention-doc token="xxx" type="docx">文档标题</mention-doc>

导入时创建 MentionDoc 元素。type 支持：docx、doc、sheet、bitable、mindnote、wiki、file、slides。

分栏布局（Grid）

<grid cols="2">
<column>
左栏内容（支持嵌套 Markdown）
</column>
<column>
右栏内容（支持嵌套 Markdown）
</column>
</grid>

导入时创建 Grid Block（type=24）+ GridColumn 子块（type=25），每个 <column> 内的 Markdown 递归转换。

Callout 高亮块（HTML 标签形式）

<callout type="NOTE">提示内容</callout>

与 > [!NOTE] 语法效果相同，支持 6 种类型：NOTE、WARNING、TIP、CAUTION、IMPORTANT、SUCCESS。

空白画板（Whiteboard）

<whiteboard type="blank"/>

导入时创建 Board Block（type=43）。

电子表格（Sheet）

<sheet rows="5" cols="5"/>

导入时创建 Sheet Block（type=30），可选 rows、cols 属性指定行列数。

多维表格（Bitable）

<bitable view="table"/>

导入时创建 Bitable Block（type=18）。view 支持：table（默认）、kanban、calendar、gallery、gantt、form。

带属性图片（Image）

<image token="xxx" width="800" height="600" align="center" caption="图片说明"/>

导入时创建 Image Block（type=27）。属性说明：

• token：图片素材 Token（必需）
• width/height：图片尺寸（可选）
• align：对齐方式 left/center/right（可选）
• caption：图片描述（可选）

与标准 ![alt](url) 语法的区别：HTML 标签形式保留了 token、尺寸、对齐等飞书原生属性，适用于 roundtrip 场景。

文件块（File）

<file token="xxx" name="report.pdf" view-type="1"/>

导入时创建 File Block（type=23）。view-type 控制文件卡片显示模式。