lark-okr
larksuite/cli
Manage OKR cycles, objectives, key results, alignments, and progress tracking in Lark.
What is lark-okr?
Lark OKR skill enables viewing and editing OKR cycles, objectives, key results, alignment relationships, quantitative indicators, and progress records. Use it when users need to view or create OKRs, manage goals and key results, or check alignment relationships.
- View and list OKR cycles for specific users with time-based filtering
- Retrieve detailed OKR content including all objectives and key results within a cycle
- Create, update, and delete progress records for objectives and key results
- Manage objective and key result properties including weights, positions, and indicators
- Create and manage alignment relationships between objectives across cycles
- Upload images for rich-text content in OKR progress records
How to install lark-okr
npx skills add null --skill lark-okr- lark-cli installed and configured
- Read ../lark-shared/SKILL.md for authentication and permission handling
- Appropriate Lark OKR permissions for the operations being performed
How to use lark-okr
- 1.Read the OKR business entities reference to understand OKR structure and relationships
- 2.Authenticate using --as user (default) for personal/subordinate OKRs or --as bot for others with appropriate permissions
- 3.Use Shortcuts (lark-cli okr +<verb>) for common operations like +cycle-list, +cycle-detail, and +progress-create
- 4.For advanced operations, use API resources directly (e.g., lark-cli okr cycles list, lark-cli okr cycle.objectives create)
- 5.When working with rich-text content, refer to ContentBlock format documentation for proper formatting
Use cases
- Track quarterly OKR progress by viewing cycles and updating progress records
- Align team objectives with company-level goals by creating and viewing alignment relationships
- Bulk import OKR data by batch creating objectives and key results
- Update quantitative metrics and indicators as work progresses
- Reorder or reweight objectives and key results based on priority changes
- OKR managers and coordinators
- Team leads tracking goal progress
- Individual contributors viewing personal OKRs
- Executives monitoring organizational alignment
lark-okr FAQ
--as user (default) views OKRs for the current user or their direct reports. --as bot allows viewing other users' OKRs if you have the appropriate permissions.
No. Use lark-task for task management and lark-calendar for scheduling. This skill focuses exclusively on OKR management.
Use the +weight shortcut or call objectives_weight/key_results_weight API. All weights in a group must sum to 1.0 and all items must be included in the request.
Deletion is permanent and cannot be recovered. Use +progress-delete with caution.
No. Alignment is only allowed between objectives whose cycles have overlapping time periods, and an objective cannot align with itself.
Full instructions (SKILL.md)
Source of truth, from larksuite/cli.
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，其中包含认证、权限处理
身份：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 的指标当前值 |
格式说明
OKR 业务实体获取 OKR 实体结构，定义和关系，帮助你更好的使用 OKR 功能ContentBlock 富文本格式— Objective/KeyResult/Progress 中 Content/Note 字段使用的富文本格式说明- 强烈建议 在操作 OKR 前，阅读
OKR 业务实体以了解基础概念
API Resources
alignments
delete— 删除对齐关系get— 获取对齐关系
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— 更新量化指标
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-calendar - 绩效评估 → 使用
lark-openapi-explorer查找原生接口
Related skills
More from larksuite/cli and the wider catalog.
lark-doc
Read and edit Lark/Feishu Docx & Wiki documents via CLI — fetch, create, update, and manage media attachments.
lark-base
Manage Lark Base (multi-dimensional tables): create tables, fields, records, views, formulas, forms, dashboards, workflows, and roles.
lark-im
Lark/Feishu IM skill: send messages, manage group chats, download files, and handle interactive cards via lark-cli
lark-drive
Manage Lark/Feishu Drive files and folders: upload, download, import, organize, comment, and control permissions.
lark-shared
Manage Lark CLI auth, identity, permissions, and scopes for coding agents like Claude Code and Cursor
lark-calendar
Manage Lark calendar events and meeting rooms: view, create, update events, check availability, and book rooms.