$npx -y skills add larksuite/cli --skill lark-okr飞书 OKR:管理目标与关键结果。查看和编辑 OKR 周期、目标、关键结果、对齐关系、量化指标和进展记录。当用户需要查看或创建 OKR、管理目标和关键结果、查看对齐关系时使用。不负责:待办任务管理(lark-task)、日程/会议安排(lark-calendar)、绩效评估
| 1 | # okr (v2) |
| 2 | |
| 3 | **CRITICAL — 开始前 MUST 先用 Read 工具读取 [`../lark-shared/SKILL.md`](../lark-shared/SKILL.md),其中包含认证、权限处理** |
| 4 | |
| 5 | **身份**:OKR 操作默认使用 `--as user`(查看当前用户/上下级的 OKR 时)。也支持 `--as bot` 查看他人 OKR(需相应权限)。 |
| 6 | |
| 7 | ## Shortcuts(推荐优先使用) |
| 8 | |
| 9 | Shortcut 是对常用操作的高级封装(`lark-cli okr +<verb> [flags]`)。有 Shortcut 的操作优先使用。 |
| 10 | |
| 11 | | Shortcut | 说明 | |
| 12 | |----------------------------------------------------------------|--------------------------| |
| 13 | | [`+cycle-list`](references/lark-okr-cycle-list.md) | 获取特定用户的 OKR 周期列表,可以按时间筛选 | |
| 14 | | [`+cycle-detail`](references/lark-okr-cycle-detail.md) | 获取特定 OKR 中所有目标和关键结果的内容 | |
| 15 | | [`+progress-list`](references/lark-okr-progress-list.md) | 获取目标或关键结果的所有进展记录列表 | |
| 16 | | [`+progress-get`](references/lark-okr-progress-get.md) | 根据 ID 获取单条 OKR 进展记录 | |
| 17 | | [`+progress-create`](references/lark-okr-progress-create.md) | 为目标或关键结果创建进展记录 | |
| 18 | | [`+progress-update`](references/lark-okr-progress-update.md) | 更新指定 ID 的进展记录内容 | |
| 19 | | [`+progress-delete`](references/lark-okr-progress-delete.md) | 删除指定 ID 的进展记录(不可恢复) | |
| 20 | | [`+upload-image`](references/lark-okr-image-upload.md) | 上传图片用于 OKR 进展记录的富文本内容 | |
| 21 | | [`+batch-create`](references/lark-okr-batch-create.md) | 批量创建 Objective 和 KR | |
| 22 | | [`+reorder`](references/lark-okr-reorder.md) | 调整 Objective 或 KR 的顺位 | |
| 23 | | [`+weight`](references/lark-okr-weight.md) | 调整 Objective 或 KR 的权重 | |
| 24 | | [`+indicator-update`](references/lark-okr-indicator-update.md) | 更新 Objective 或 KR 的指标当前值(简单场景推荐)。更复杂的指标操作见 [量化指标管理](references/lark-okr-indicators.md) | |
| 25 | | [`+patch`](references/lark-okr-patch.md) | 部分更新 Objective 或 KR(content、notes、score、deadline) | |
| 26 | |
| 27 | ## 格式说明 |
| 28 | |
| 29 | - [`OKR 业务实体`](references/lark-okr-entities.md) 获取 OKR 实体结构,定义和关系,帮助你更好的使用 OKR 功能 |
| 30 | - [`ContentBlock 富文本格式`](references/lark-okr-contentblock.md) — Objective/KeyResult/Progress 中 Content/Note 字段使用的富文本格式说明,以及简化的半纯文本(SemiPlainContent)格式的进一步说明。 |
| 31 | - **强烈建议** 在操作 OKR 前,阅读[`OKR 业务实体`](references/lark-okr-entities.md)以了解基础概念 |
| 32 | |
| 33 | ## API Resources |
| 34 | |
| 35 | ### alignments |
| 36 | |
| 37 | - `delete` — 删除对齐关系 |
| 38 | - `get` — 获取对齐关系 |
| 39 | |
| 40 | > **操作指南:** [OKR 对齐关系管理](references/lark-okr-alignments.md) 包含 list/create/delete 完整工作流 |
| 41 | |
| 42 | ### categories |
| 43 | |
| 44 | - `list` — 批量获取分类 |
| 45 | |
| 46 | ### cycles |
| 47 | |
| 48 | - `list` — 批量获取用户周期 |
| 49 | - `objectives_position` — 更新用户周期下全部目标的位置 |
| 50 | - 请求中必须携带对应周期下全部目标的 ID,否则会参数校验失败。以传入的目标ID顺序重新排列目标。 |
| 51 | - `objectives_weight` — 更新用户周期下全部目标的权重 |
| 52 | - 请求中必须同时修改对应周期下全部目标的权重,且所有权重值的和必须等于 1 ,否则会参数校验失败。例如周期下有 2 个目标时: |
| 53 | - 正确指令示例如下: |
| 54 | ``` bash |
| 55 | 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 |
| 56 | ``` |
| 57 | |
| 58 | ### cycle.objectives |
| 59 | |
| 60 | - `create` — 创建目标 |
| 61 | - `list` — 批量获取用户周期下的目标 |
| 62 | |
| 63 | ### indicators |
| 64 | |
| 65 | - `patch` — 更新量化指标 |
| 66 | |
| 67 | > **操作指南:** [OKR 量化指标管理](references/lark-okr-indicators.md) 包含目标/KR 指标查询和 patch 更新完整工作流 |
| 68 | |
| 69 | ### key_results |
| 70 | |
| 71 | - `delete` — 删除关键结果 |
| 72 | - `get` — 获取关键结果 |
| 73 | - `patch` — 更新关键结果 |
| 74 | |
| 75 | ### key_result.indicators |
| 76 | |
| 77 | - `list` — 获取关键结果的量化指标 |
| 78 | |
| 79 | > **操作指南:** [OKR 量化指标管理](references/lark-okr-indicators.md) |
| 80 | |
| 81 | ### objectives |
| 82 | |
| 83 | - `delete` — 删除目标 |
| 84 | - `get` — 获取目标 |
| 85 | - `key_results_position` — 更新全部关键结果的位置 |
| 86 | - 请求中必须携带对应周期下全部关键结果的 ID,否则会参数校验失败。以传入的关键结果ID顺序重新排列关键结果。 |
| 87 | - `key_results_weight` — 更新全部关键结果的权重 |
| 88 | - 类似 `objectives_weight`, 请求中必须同时修改对应目标下全部关键结果的权重,且所有权重值的和必须等于 1 ,否则会参数校验失败。 |
| 89 | - `patch` — 更新目标 |
| 90 | |
| 91 | ### objective.alignments |
| 92 | |
| 93 | - `create` — 创建对齐关系 |
| 94 | - 对齐不允许对齐自己的目标,且发起对齐的目标和被对齐的目标所在周期时间上必须有重叠,否则会参数校验失败。 |
| 95 | - `list` — 批量获取目标下的对齐关系 |
| 96 | |
| 97 | ### objective.indicators |
| 98 | |
| 99 | - `list` — 获取目标的量化指标 |
| 100 | |
| 101 | ### objective.key_results |
| 102 | |
| 103 | - `create` — 创建关键结果 |
| 104 | - `list` — 批量获取目标下的关键结果 |
| 105 | |
| 106 | ## 不在本 skill 范围 |
| 107 | |
| 108 | - 待办任务管理 → 使用 [`lark-task`](../lark-task/SKILL.md) |
| 109 | - 日程安排 → 使用 [`lark-calendar`](../lark-calendar/SKILL.md) |
| 110 | - 绩效评估 → 使用 [`lark-openapi-explorer`](../lark-openapi-explorer/SKILL.md) 查找原生接口 |