ooodc
a7883dbed9
- 移除 TodoItem 中的 priority、created_at 和 updated_at 字段 - 强制每个任务都必须有唯一 id，且由用户负责生成 - 修改合并模式逻辑，merge=true 下保留未提及的旧任务 - 支持已完成和已取消任务重新激活（状态改回 pending 或 in_progress） - 禁止 in_progress 状态退回到 pending，必须标记为 completed 或 cancelled - 优化状态转换校验，允许特定状态间合法切换 - 简化任务变更消息，移除详细的新增/更新/移除统计 - 更新文档和示例，明确 id 必须由用户生成和使用 - 修复和补充测试，增强状态转换和合并模式验证 - 调整任务时间戳生成逻辑，统一使用当前时间及索引 - 该变更提供更合理的任务状态机械及管理模式，提升稳定性和易用性
101 lines
3.5 KiB
Markdown
101 lines
3.5 KiB
Markdown
# whiteboard +update（更新画板）
|
||
|
||
> **前置条件：** 先阅读 [`../../lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
|
||
|
||
更新画板内容，支持三种输入格式：
|
||
|
||
- `raw`：飞书 OpenAPI 原生画板节点格式，不推荐直接编辑。
|
||
- `plantuml`：PlantUML 代码
|
||
- `mermaid`：Mermaid 代码
|
||
|
||
输入内容可以通过管道从 stdin 读取，或通过 `--source` 指定文件。
|
||
|
||
## 参数
|
||
|
||
| 参数 | 必填 | 说明 |
|
||
|----------------------|----|--------------------------------------------|
|
||
| `--whiteboard-token` | 是 | 画板 token，需要拥有画板的编辑权限 |
|
||
| `--idempotent-token` | 否 | 幂等 token，确保更新操作幂等，最小长度 10 个字符 |
|
||
| `--overwrite` | 否 | 覆盖更新，在更新前删除所有现有内容，默认为 false |
|
||
| `--source` | 是 | 输入画板内容，支持使用 `@path` 从文件读取，或 `-` 从 stdin 读取 |
|
||
| `--input_format` | 否 | 输入格式：`raw`、`plantuml`、`mermaid`，默认为 `raw` |
|
||
|
||
### 以 raw (OpenAPI 原生画板节点格式) 创作
|
||
|
||
**不要以直接生成 json 语法的方式创作 raw 格式的飞书 OpenAPI 原生画板节点参数**
|
||
|
||
思维导图，时序图，类图，饼图，流程图等图表推荐使用 Mermaid/PlantUML 语法绘制。
|
||
|
||
而当需要绘制架构图，组织架构图，泳道图，对比图，鱼骨图，柱状图，折线图，树状图，漏斗图，金字塔图，循环/飞轮图，里程碑或其他较为复杂的图表时，推荐参考 [§ 渲染 & 写入画板](../SKILL.md#渲染--写入画板) 使用 whiteboard-cli 工具创作。
|
||
|
||
## 示例
|
||
|
||
### 示例 1：使用 PlantUML 代码更新画板（从 stdin 读取）
|
||
|
||
```bash
|
||
# 编写 PlantUML 代码
|
||
cat > diagram.puml << 'EOF'
|
||
@startuml
|
||
Alice -> Bob: Hello
|
||
Bob -> Alice: Hi
|
||
@enduml
|
||
EOF
|
||
|
||
# 通过管道传递给命令
|
||
cat diagram.puml | lark-cli whiteboard +update \
|
||
--whiteboard-token <画板Token> \
|
||
--input_format plantuml --source -\
|
||
--overwrite --as user
|
||
```
|
||
|
||
### 示例 2：使用 Mermaid 代码更新画板（从文件读取）
|
||
|
||
```bash
|
||
# 编写 Mermaid 代码
|
||
cat > diagram.mmd << 'EOF'
|
||
graph TD
|
||
A[开始] --> B{判断}
|
||
B -->|是| C[处理]
|
||
B -->|否| D[结束]
|
||
C --> D
|
||
EOF
|
||
|
||
# 从文件读取并更新
|
||
lark-cli whiteboard +update \
|
||
--whiteboard-token <画板Token> \
|
||
--input_format mermaid \
|
||
--source @./diagram.mmd \
|
||
--overwrite --as user
|
||
```
|
||
|
||
### 示例 3：使用 whiteboard-cli 生成 OpenAPI 格式并写入画板
|
||
|
||
whiteboard-cli 工具的具体用法请参考 [§ 渲染 & 写入画板](../SKILL.md#渲染--写入画板)
|
||
|
||
```bash
|
||
# 使用 whiteboard-cli 生成 OpenAPI 格式并通过管道传递
|
||
npx -y @larksuite/whiteboard-cli@^0.2.11 -i <产物文件> --to openapi --format json \
|
||
| lark-cli whiteboard +update \
|
||
--whiteboard-token <画板Token> \
|
||
--source - --input_format raw \
|
||
--idempotent-token <10+字符唯一串> \
|
||
--as user
|
||
```
|
||
|
||
### 示例 4：先生成产物文件，再从文件读取更新
|
||
|
||
whiteboard-cli 工具的具体用法请参考 [§ 渲染 & 写入画板](../SKILL.md#渲染--写入画板)
|
||
|
||
```bash
|
||
# 生成 OpenAPI 格式到文件
|
||
npx -y @larksuite/whiteboard-cli@^0.2.11 -i <DSL 文件> --to openapi --format json -o ./temp.json
|
||
|
||
# 从文件读取并更新
|
||
lark-cli whiteboard +update \
|
||
--whiteboard-token <画板Token> \
|
||
--idempotent-token <10+字符唯一串> \
|
||
--input_format raw \
|
||
--source @./temp.json \
|
||
--overwrite --as user
|
||
```
|