lark-okr

작성자: larksuite

飞书 OKR：管理 목표와 핵심 결과. OKR 주기, 목표, 핵심 결과, 정렬 관계, 정량 지표 및 진행 기록을 확인하고 편집합니다. 사용자가 OKR을 확인하거나 생성하고, 목표와 핵심 결과를 관리하며, 정렬 관계를 확인해야 할 때 사용합니다. 담당하지 않는 작업: 할 일 관리(lark-task), 일정/회의 예약(lark-calendar), 성과 평가

npx skills add https://github.com/larksuite/cli --skill lark-okr

ZIP 다운로드 GitHub

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 进展记录的富文本内容

格式说明

OKR 业务实体 获取 OKR 实体结构，定义和关系，帮助你更好的使用 OKR 功能
ContentBlock 富文本格式 — Objective/KeyResult/Progress 中 Content/Note 字段使用的富文本格式说明
强烈建议 在操作 OKR 前，阅读OKR 业务实体以了解基础概念

API Resources

alignments

delete — 删除对齐关系
get — 获取对齐关系

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

key_results

delete — 删除关键结果
get — 获取关键结果
patch — 更新关键结果

key_result.indicators

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

objectives

delete — 删除目标
get — 获取目标
key_results_position — 更新全部关键结果的位置
- 请求中必须携带对应周期下全部关键结果的 ID，否则会参数校验失败。以传入的关键结果ID顺序重新排列关键结果。
key_results_weight — 更新全部关键结果的权重
- 类似 objectives_weight, 请求中必须同时修改对应目标下全部关键结果的权重，且所有权重值的和必须等于 1 ，否则会参数校验失败。
patch — 更新目标