lark-okr

作者: larksuite

飛書 OKR:管理目標與關鍵結果。查看和編輯 OKR 週期、目標、關鍵結果、對齊關係、量化指標和進展記錄。當用戶需要查看或建立 OKR、管理目標和關鍵結果、查看對齊關係時使用。不負責:待辦任務管理(lark-task)、行程/會議安排(lark-calendar)、績效評估

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

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

格式说明

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 范围

來自 larksuite 的更多技能

lark-doc
larksuite
飛書雲文檔 / Docx / 知識庫 Wiki 文檔(v2):建立、開啟、讀取、取得、檢視、總結、整理、改寫、翻譯、審閱和編輯飛書文檔內容。當使用者提供飛書文檔 URL/token,或要求檢視/讀取/開啟某個文檔、提取文檔內容、總結文檔、生成/建立文檔、追加/取代/刪除/移動內容、調整排版、插入或下載文檔圖片/附件/素材/畫板縮圖時使用。文檔內容中出現嵌入試算表、多維表格、需要將重要資訊視覺化為畫板(含 SVG 畫板)、引用或同步區塊時,也先使用本 skill 讀取和提取 token,再切換至對應 skill 深入處理。使用本 skill 時,docs +create、docs +fetch、docs +update 必須攜帶 --api-version v2;預設使用 DocxXML,也
documentapiproductivity
lark-im
larksuite
飛書即時通訊:收發訊息和管理群聊。發送和回覆訊息、搜尋聊天記錄、管理群聊成員、上傳下載圖片和檔案(支援大檔案分片下載)、管理表情回覆。當用戶需要發訊息、查看或搜尋聊天記錄、下載聊天中的檔案、查看群成員、搜尋群、建立群聊或話題群、管理標記資料時使用。
communicationproductivityapi
lark-shared
larksuite
首次設定 lark-cli、執行 auth login、切換使用者/機器人身份(--as)、處理權限拒絕或範圍錯誤、需要更新 lark-cli,或是在 JSON 輸出中看到 _notice 時使用。
developmentapicommunication
lark-base
larksuite
當需要用 lark-cli 操作飛書多維表格(Base)時調用:搜尋 Base、建表、欄位管理、記錄讀寫、記錄分享連結、檢視配置、歷史查詢,以及角色/表單/儀表板管理/工作流程;也適用於把舊的 +table / +field / +record 寫法改成當前命令寫法。涉及欄位設計、公式欄位、查找引用、跨表計算、行級派生指標、資料分析需求時也必須使用本 skill。
databasedata-analysisapi
lark-drive
larksuite
飛書雲空間:管理雲端空間中的檔案與資料夾。可上傳與下載檔案、建立資料夾、複製/移動/刪除檔案、檢視檔案元資料、管理文件評論、管理文件權限、訂閱使用者評論變更事件、修改檔案標題(docx、sheet、bitable、file、folder、wiki);同時也負責將本機的 Word/Markdown/Excel/CSV 以及 Base 快照(.base)匯入為飛書線上雲端文件(docx、sheet、bitable)。當使用者需要上傳或下載檔案、整理雲端空間目錄、檢視檔案詳細資訊、管理評論、管理文件權限、修改檔案標題、訂閱使用者評論變更事件,或將本機檔案匯入為新版文件、電子表格、多維表格/Base 時使用。
documentproductivityapi
lark-whiteboard
larksuite
飛書畫板:查詢和編輯飛書雲文檔中的畫板。支援匯出畫板為預覽圖片、匯出原始節點結構、使用多種格式更新畫板內容。當用戶需要查看畫板內容、匯出畫板圖片、編輯畫板時使用此 skill。不負責:飛書雲文檔內容編輯(lark-doc)、文檔內嵌電子表格/Base(lark-sheets / lark-base)。
documentcreativeproductivity
lark-mail
larksuite
飛書郵箱 — 起草、撰寫、發送、回覆、轉發、閱讀及搜尋郵件;管理草稿、資料夾、標籤、聯絡人、附件及郵件規則。當使用者提及 起草郵件、寫一封郵件、擬郵件、草稿、發通知郵件、發送郵件、發郵件、回覆郵件、轉發郵件、查看郵件、看郵件、讀郵件、搜尋郵件、查郵件、收件箱、郵件會話、編輯草稿、管理草稿、下載附件、郵件資料夾、郵件標籤、郵件聯絡人、監聽新郵件、收信規則、郵件規則、draft、compose、send email、reply、forward、inbox、mail thread、mail rules 時使用。
communicationproductivityapi
lark-workflow-meeting-summary
larksuite
會議紀要整理工作流:彙總指定時間範圍內的會議紀要並生成結構化報告。當用戶需要整理會議紀要、生成會議週報、回顧一段時間內的會議內容時使用。
productivitydocumentcommunication