larksuite/cli

lark-okr

飞书 OKR:管理目标与关键结果。查看和编辑 OKR 周期、目标、关键结果、对齐关系、量化指标和进展记录。当用户需要查看或创建 OKR、管理目标和关键结果、查看对齐关系时使用。不负责:待办任务管理(lark-task)、日程/会议安排(lark-calendar)、绩效评估

View source
Original skill document

Rendered from the source repository. Headings, examples, code, tables, links, and referenced images are preserved.

okr (v2)

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

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

快速决策

用户需求操作路径参考文档
查看自己/他人的 OKR获取用户 ID -> +cycle-list -> +cycle-detail -> 按需查指标/进展记录`cycle-list`, `cycle-detail`, `indicators`, `progress-list`
为自己写一组 OKR优先用 +batch-create 创建 Objective/KR 骨架`batch-create`, `contentblock`
只新增一条 O 或单条 KR+create`create`
编辑内容/备注/截止时间+patch`patch`
修改 OKR 分数只有用户明确说“分数”“评分”“打分”“score”时才用 +patch --score;分数不是进度/完成度`patch`
调整顺序或权重+reorder / +weight`reorder`, `weight`
更新数字进度/完成度百分比或不带单位数字用 +indicator-update;需要改单位/目标值时查指标后用 indicators patch`indicator-update`, `indicators`
写文字进展+progress-create;如果文本和数字都有,百分比或默认单位可使用 --progress-percent 统一改,非百分比单位更新量化指标`progress-create`, `progress-list`, `progress-update`
对齐目标直接按对齐关系工作流处理`alignments`

分类只在用户明确要求分类,或创建 Objective 返回 invalid parameters 且怀疑租户强制开启分类时处理:用 lark-cli okr categories list --params '{"owner_type":"user","page_size":100}' --as user 查可用分类,选择语义合适且 enabled=true 的分类 ID;分类可后续调整,不必停下等待用户确认。

获取当前用户用 contact +get-user;按姓名/邮箱查他人用 contact +search-user,拿到 open_id 后再查 OKR。

bash
lark-cli contact +search-user --query "张三" --has-chatted --as user

最常用 OKR 命令示例:

bash
# 查用户周期,再用周期 ID 查详情
lark-cli okr +cycle-list --user-id "ou_xxx" --as user
lark-cli okr +cycle-detail --cycle-id 7000000000000000001 --as user

# 批量创建 Objective/KR
lark-cli okr +batch-create \
  --cycle-id 7000000000000000001 \
  --input '[{"text":"提升产品用户体验","notes":"关注核心流程和用户反馈","krs":[{"text":"核心流程满意度达到 4.8 分"}]}]' \
  --as user

# 更新数字进度/完成度
lark-cli okr +indicator-update \
  --level key-result \
  --id 7000000000000000003 \
  --value 75 \
  --as user

分数和进度不要混用:用户说“进度”“完成度”“当前做到 75%”时,通常是在改量化指标或写进展记录,不是在改 score。只有明确要求修改 OKR 分数/评分/打分时,才使用 `+patch --score`score 取值是 0-1,最多一位小数。

进度判断规则:用户说“进度”“完成度”时,先判断是否是量化数字。数字进度通常对应量化指标;不可量化文本对应进展记录。需要修改指标单位时看 `lark-okr-indicators.md`

Shortcuts(推荐优先使用)

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

Shortcut说明
`+cycle-list`分页获取特定用户的 OKR 周期列表,可以用 --time-range 对当前页后置筛选
`+cycle-detail`获取特定 OKR 中所有目标和关键结果的内容
`+create`创建单个 Objective(可带备注),或向已有 Objective 新增 KR
`+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)

创建场景选择

  • 单条创建优先用 [`+create`](references/lark-okr-create.md):适合创建一个 Objective,或给已有 Objective 增加一个 KR。
  • 批量创建用 [`+batch-create`](references/lark-okr-batch-create.md):适合一次创建多个 Objective,并可同时附带多个 KR。
  • 如果你只需要修改已有 Objective / KR 的内容、备注、分数或截止时间,使用 `+patch`

格式说明

字段使用的富文本格式说明,以及简化的半纯文本(SemiPlainContent)格式的进一步说明。

API Resources

alignments

  • delete — 删除对齐关系
  • get — 获取对齐关系
操作指南: OKR 对齐关系管理 包含 list/create/delete 完整工作流

categories

  • list — 批量获取分类

cycles

  • list — 批量获取用户周期

cycle.objectives

  • 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

  • list — 批量获取目标下的关键结果

不在本 skill 范围

from this repository

More skills

All skills
larksuite
Community

lark-base

飞书多维表格(Base)操作:建表、字段、记录、视图、统计、公式/lookup、表单、仪表盘、应用模式(BaseApp/AppMode 页面与组件)、Workspace 目录、workflow、角色权限、模板中心(多维表格模板分类/列表/搜索);遇到 Base/多维表格/bitable、BaseApp/AppMode、/base/ 或 /app/ 链接时使用。BaseApp 不走 lark-apps;文件导入/导出转 lark-drive,认证/授权转 lark-shared。

installs
429,8 k
GitHub stars
16,9 k
Updated
31 août
larksuite
Community

lark-doc

飞书云文档(Docx / Wiki)内容操作:读取、创建、编辑文档,插入或下载图片附件,以及操作思维笔记。用户提供文档 URL/token(包括 doubao.com 的 /docx/、/wiki/)时使用;按 URL 路径/token 而非域名路由。文档内嵌资源按读取参考中的统一规则分流。独立评论操作走 lark-drive;随正文读取评论使用 docs +fetch。表格或 Base 内部数据操作不在本 skill。

installs
431,6 k
GitHub stars
16,9 k
Updated
31 août
larksuite
Community

lark-sheets

飞书电子表格:创建和操作电子表格。支持创建表格、管理工作表与行列结构(增删/合并/调整尺寸/隐藏/冻结)、读写单元格(值/公式/样式/批注/单元格图片)、查找替换、多操作批量更新,以及图表、透视表、条件格式、筛选器、迷你图、浮动图片等对象的创建与维护。当用户需要创建电子表格、管理工作表、批量读写或编辑数据、统计汇总与可视化、表格美化、公式计算(含 Excel 公式迁移)、金融/财务建模(DCF、三张表、预算、Sensitivity 等)等任务时使用。若用户是想按名称或关键词搜索云空间(云盘/云存储)里的表格文件,请改用 lark-drive 的 drive +search 先定位资源。当用户给出 doubao.com 的 /sheets/ URL/token 时,也应直接使用本 skill,不要因为域名不是飞书而回退到 WebFetch;路由依据是 URL 路径模式和 token,而不是域名。

installs
426,5 k
GitHub stars
16,9 k
Updated
31 août
larksuite
Community

lark-task

飞书任务:管理任务、清单和任务智能体。创建待办任务、查看和更新任务状态、拆分子任务、组织任务清单、分配协作成员、上传任务附件、注册或注销任务智能体、更新任务智能体的主页数据、写入智能体任务记录。当用户需要创建待办事项、查看任务列表、跟踪任务进度、管理项目清单或给他人分配任务、为任务上传附件文件、注册注销任务智能体、更新智能体主页数据、写入任务记录时使用。

installs
425,3 k
GitHub stars
16,9 k
Updated
31 août