ooodc
a7883dbed9
- 移除 TodoItem 中的 priority、created_at 和 updated_at 字段 - 强制每个任务都必须有唯一 id，且由用户负责生成 - 修改合并模式逻辑，merge=true 下保留未提及的旧任务 - 支持已完成和已取消任务重新激活（状态改回 pending 或 in_progress） - 禁止 in_progress 状态退回到 pending，必须标记为 completed 或 cancelled - 优化状态转换校验，允许特定状态间合法切换 - 简化任务变更消息，移除详细的新增/更新/移除统计 - 更新文档和示例，明确 id 必须由用户生成和使用 - 修复和补充测试，增强状态转换和合并模式验证 - 调整任务时间戳生成逻辑，统一使用当前时间及索引 - 该变更提供更合理的任务状态机械及管理模式，提升稳定性和易用性
112 lines
5.0 KiB
Markdown
112 lines
5.0 KiB
Markdown
---
|
||
name: lark-okr
|
||
version: 1.0.0
|
||
description: "飞书 OKR：管理目标与关键结果。查看和编辑 OKR 周期、目标、关键结果、对齐关系、量化指标和进展记录。当用户需要查看或创建 OKR、管理目标和关键结果、查看对齐关系时使用。不负责：待办任务管理（lark-task）、日程/会议安排（lark-calendar）、绩效评估"
|
||
metadata:
|
||
requires:
|
||
bins: [ "lark-cli" ]
|
||
cliHelp: "lark-cli okr --help"
|
||
---
|
||
|
||
# okr (v2)
|
||
|
||
**CRITICAL — 开始前 MUST 先用 Read 工具读取 [`../lark-shared/SKILL.md`](../lark-shared/SKILL.md)，其中包含认证、权限处理**
|
||
|
||
**身份**：OKR 操作默认使用 `--as user`（查看当前用户/上下级的 OKR 时）。也支持 `--as bot` 查看他人 OKR（需相应权限）。
|
||
|
||
## Shortcuts（推荐优先使用）
|
||
|
||
Shortcut 是对常用操作的高级封装（`lark-cli okr +<verb> [flags]`）。有 Shortcut 的操作优先使用。
|
||
|
||
| Shortcut | 说明 |
|
||
|--------------------------------------------------------------|--------------------------|
|
||
| [`+cycle-list`](references/lark-okr-cycle-list.md) | 获取特定用户的 OKR 周期列表，可以按时间筛选 |
|
||
| [`+cycle-detail`](references/lark-okr-cycle-detail.md) | 获取特定 OKR 中所有目标和关键结果的内容 |
|
||
| [`+progress-list`](references/lark-okr-progress-list.md) | 获取目标或关键结果的所有进展记录列表 |
|
||
| [`+progress-get`](references/lark-okr-progress-get.md) | 根据 ID 获取单条 OKR 进展记录 |
|
||
| [`+progress-create`](references/lark-okr-progress-create.md) | 为目标或关键结果创建进展记录 |
|
||
| [`+progress-update`](references/lark-okr-progress-update.md) | 更新指定 ID 的进展记录内容 |
|
||
| [`+progress-delete`](references/lark-okr-progress-delete.md) | 删除指定 ID 的进展记录（不可恢复） |
|
||
| [`+upload-image`](references/lark-okr-image-upload.md) | 上传图片用于 OKR 进展记录的富文本内容 |
|
||
|
||
## 格式说明
|
||
|
||
- [`OKR 业务实体`](references/lark-okr-entities.md) 获取 OKR 实体结构，定义和关系，帮助你更好的使用 OKR 功能
|
||
- [`ContentBlock 富文本格式`](references/lark-okr-contentblock.md) — Objective/KeyResult/Progress 中 Content/Note 字段使用的富文本格式说明
|
||
- **强烈建议** 在操作 OKR 前，阅读[`OKR 业务实体`](references/lark-okr-entities.md)以了解基础概念
|
||
|
||
## API Resources
|
||
|
||
### alignments
|
||
|
||
- `delete` — 删除对齐关系
|
||
- `get` — 获取对齐关系
|
||
|
||
### categories
|
||
|
||
- `list` — 批量获取分类
|
||
|
||
### cycles
|
||
|
||
- `list` — 批量获取用户周期
|
||
- `objectives_position` — 更新用户周期下全部目标的位置
|
||
- 请求中必须携带对应周期下全部目标的 ID，否则会参数校验失败。以传入的目标ID顺序重新排列目标。
|
||
- `objectives_weight` — 更新用户周期下全部目标的权重
|
||
- 请求中必须同时修改对应周期下全部目标的权重，且所有权重值的和必须等于 1 ，否则会参数校验失败。例如周期下有 2 个目标时：
|
||
- 正确指令示例如下：
|
||
``` bash
|
||
lark-cli okr cycles objectives_weight --params '{"cycle_id": "7000000000000000001"}' --data '{"objective_weights": [{"objective_id": "7000000000000000002", "weight": 0.7}, {"objective_id": "7000000000000000003", "weight": 0.3}]}' --as user
|
||
```
|
||
|
||
### cycle.objectives
|
||
|
||
- `create` — 创建目标
|
||
- `list` — 批量获取用户周期下的目标
|
||
|
||
### indicators
|
||
|
||
- `patch` — 更新量化指标
|
||
|
||
### key_results
|
||
|
||
- `delete` — 删除关键结果
|
||
- `get` — 获取关键结果
|
||
- `patch` — 更新关键结果
|
||
|
||
### key_result.indicators
|
||
|
||
- `list` — 获取关键结果的量化指标
|
||
|
||
### objectives
|
||
|
||
- `delete` — 删除目标
|
||
- `get` — 获取目标
|
||
- `key_results_position` — 更新全部关键结果的位置
|
||
- 请求中必须携带对应周期下全部关键结果的 ID，否则会参数校验失败。以传入的关键结果ID顺序重新排列关键结果。
|
||
- `key_results_weight` — 更新全部关键结果的权重
|
||
- 类似 `objectives_weight`, 请求中必须同时修改对应目标下全部关键结果的权重，且所有权重值的和必须等于 1 ，否则会参数校验失败。
|
||
- `patch` — 更新目标
|
||
|
||
### objective.alignments
|
||
|
||
- `create` — 创建对齐关系
|
||
- 对齐不允许对齐自己的目标，且发起对齐的目标和被对齐的目标所在周期时间上必须有重叠，否则会参数校验失败。
|
||
- `list` — 批量获取目标下的对齐关系
|
||
|
||
### objective.indicators
|
||
|
||
- `list` — 获取目标的量化指标
|
||
|
||
### objective.key_results
|
||
|
||
- `create` — 创建关键结果
|
||
- `list` — 批量获取目标下的关键结果
|
||
|
||
## 不在本 skill 范围
|
||
|
||
- 待办任务管理 → 使用 [`lark-task`](../lark-task/SKILL.md)
|
||
- 日程安排 → 使用 [`lark-calendar`](../lark-calendar/SKILL.md)
|
||
- 绩效评估 → 使用 [`lark-openapi-explorer`](../lark-openapi-explorer/SKILL.md) 查找原生接口
|
||
|
||
|