61 lines
3.1 KiB
Markdown
61 lines
3.1 KiB
Markdown
# whiteboard +export（导出画板）
|
||
|
||
> **前置条件：** 先阅读 [`../../lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
|
||
|
||
导出画板内容，支持导出为预览图片、SVG 矢量图、提取 PlantUML/Mermaid 代码，或获取飞书 OpenAPI 原生画板节点格式。
|
||
|
||
## 参数
|
||
|
||
| 参数 | 必填 | 说明 |
|
||
|----------------------|----|------------------------------------------------------------------------|
|
||
| `--whiteboard-token` | 是 | 画板 token，需要拥有画板的读权限 |
|
||
| `--output-type` | 是 | 输出格式：`preview`（预览图片）、`svg`（SVG 矢量图）、`source`（PlantUML/Mermaid 代码）、`raw`（OpenAPI 原生画板节点格式） |
|
||
| `--output` | 否 | 输出路径。当 `--output-type preview` 时必填，推荐传入无后缀文件路径（如 `./preview`）；当 `--output-type svg/source/raw` 时可选，不填则直接输出到终端 |
|
||
| `--overwrite` | 否 | 覆盖已存在的文件，默认为 false |
|
||
|
||
## 输出格式
|
||
|
||
- `preview`：预览图片。推荐 `--output ./preview` 这类无后缀文件路径，CLI 会按实际图片类型保存为 `./preview.png` 或 `./preview.jpg`。如果 `--output` 是目录，会保存为该目录下的 `whiteboard_<whiteboard-token>.png/.jpg`；如果显式写了后缀，需要和实际图片类型匹配。`--overwrite` 检查的是补齐后缀后的最终路径，例如返回 PNG 时 `--output ./preview` 对应覆盖 `./preview.png`。
|
||
- `svg`：导出画板为标准 SVG 矢量图。可用于 SVG 编辑后回写画板（见 [`routes/svg-edit.md`](../routes/svg-edit.md)）。注意：导出为纯视觉快照，思维导图层级、表格结构、连接器绑定等语义信息会丢失。
|
||
- `source`：PlantUML/Mermaid 代码。仅限画板内有且仅有一个 PlantUML/Mermaid 图时，才可导出代码，否则会在返回值中告知不存在/有多个节点。
|
||
- `raw`：飞书 OpenAPI 原生画板节点格式。这一 json 格式不适合直接编辑复杂布局或内容，建议仅限于需要修改简单的文本内容/颜色等细节时使用。需要进行更复杂的设计/修改时，建议参考 [§ 渲染 & 写入画板](../SKILL.md#渲染--写入画板)。
|
||
|
||
## 示例
|
||
|
||
### 示例 1：导出画板为预览图片
|
||
|
||
```bash
|
||
lark-cli whiteboard +export \
|
||
--whiteboard-token "wbcnxxxxxxxx" \
|
||
--output-type preview \
|
||
--output ./preview
|
||
```
|
||
|
||
### 示例 2：提取画板中的代码并直接输出
|
||
|
||
```bash
|
||
lark-cli whiteboard +export \
|
||
--whiteboard-token "wbcnxxxxxxxx" \
|
||
--output-type source
|
||
```
|
||
|
||
### 示例 3：导出画板为 SVG 矢量图
|
||
|
||
```bash
|
||
lark-cli whiteboard +export \
|
||
--whiteboard-token "wbcnxxxxxxxx" \
|
||
--output-type svg \
|
||
--output ./whiteboard.svg \
|
||
--as user
|
||
```
|
||
|
||
### 示例 4：导出画板原始节点结构到文件
|
||
|
||
```bash
|
||
lark-cli whiteboard +export \
|
||
--whiteboard-token "wbcnxxxxxxxx" \
|
||
--output-type raw \
|
||
--output ./nodes.json \
|
||
--overwrite
|
||
```
|