lark-okr

by larksuite

飞书 OKR：管理目标与关键结果。查看和编辑 OKR 周期、目标、关键结果、对齐关系、量化指标和进展记录。当用户需要查看或创建 OKR、管理目标和关键结果、查看对齐关系时使用。不负责：待办任务管理（lark-task）、日程/会议安排（lark-calendar）、绩效评估 npx skills add https://github.com/larksuite/cli --skill lark-okr Download ZIPGitHub15.1k

okr (v2)

CRITICAL — 开始前 MUST 先用 Read 工具读取 ../lark-shared/SKILL.md，其中包含认证、权限处理

身份：OKR 操作默认使用 --as user（查看当前用户/上下级的 OKR 时）。也支持 --as bot 查看他人 OKR（需相应权限）。

Shortcuts（推荐优先使用）

Shortcut 是对常用操作的高级封装（lark-cli okr +<verb> [flags]）。有 Shortcut 的操作优先使用。

Shortcut 说明 +cycle-list 获取特定用户的 OKR 周期列表，可以按时间筛选 +cycle-detail 获取特定 OKR 中所有目标和关键结果的内容 +progress-list 获取目标或关键结果的所有进展记录列表 +progress-get 根据 ID 获取单条 OKR 进展记录 +progress-create 为目标或关键结果创建进展记录 +progress-update 更新指定 ID 的进展记录内容 +progress-delete 删除指定 ID 的进展记录（不可恢复） +upload-image 上传图片用于 OKR 进展记录的富文本内容 +batch-create 批量创建 Objective 和 KR +reorder 调整 Objective 或 KR 的顺位 +weight 调整 Objective 或 KR 的权重 +indicator-update 更新 Objective 或 KR 的指标当前值（简单场景推荐）。更复杂的指标操作见 量化指标管理 +patch 部分更新 Objective 或 KR（content、notes、score、deadline）

格式说明

• OKR 业务实体 获取 OKR 实体结构，定义和关系，帮助你更好的使用 OKR 功能

• ContentBlock 富文本格式 — Objective/KeyResult/Progress 中 Content/Note 字段使用的富文本格式说明，以及简化的半纯文本（SemiPlainContent）格式的进一步说明。

• 强烈建议 在操作 OKR 前，阅读OKR 业务实体以了解基础概念

API Resources

alignments

• delete — 删除对齐关系

• get — 获取对齐关系

操作指南： OKR 对齐关系管理 包含 list/create/delete 完整工作流

categories

• list — 批量获取分类

cycles

• list — 批量获取用户周期

• objectives_position — 更新用户周期下全部目标的位置

• 请求中必须携带对应周期下全部目标的 ID，否则会参数校验失败。以传入的目标ID顺序重新排列目标。

• objectives_weight — 更新用户周期下全部目标的权重

• 请求中必须同时修改对应周期下全部目标的权重，且所有权重值的和必须等于 1 ，否则会参数校验失败。例如周期下有 2 个目标时：

• 正确指令示例如下：

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 — 更新量化指标

操作指南： OKR 量化指标管理 包含目标/KR 指标查询和 patch 更新完整工作流

key_results

• delete — 删除关键结果

• get — 获取关键结果

• patch — 更新关键结果

key_result.indicators

• list — 获取关键结果的量化指标

操作指南： OKR 量化指标管理

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-calendar

• 绩效评估 → 使用 lark-openapi-explorer 查找原生接口