lark-okr

okr (v2)

CRITICAL, Before starting, you MUST use the Read tool to read ../lark-shared/SKILL.md, which contains information on authentication and permission handling.

Identity: OKR operations use --as user by default (when viewing the current user's or their subordinates' OKRs). It also supports --as bot to view others' OKRs (requires corresponding permissions).

Shortcuts (Recommended for priority use)

Shortcuts are advanced wrappers for common operations (lark-cli okr +<verb> [flags]). Use shortcuts whenever available.

Format Notes

• OKR Business Entities Get OKR entity structures, definitions, and relationships to help you use OKR features better
• ContentBlock Rich Text Format, Explanation of the rich text format used in Content/Note fields for Objective/KeyResult/Progress
• Highly recommended: Before operating on OKRs, read OKR Business Entities to understand the basic concepts

API Resources

alignments

• delete, Delete alignment relationship
• get, Get alignment relationship

categories

• list, Batch get categories

cycles

• list, Batch get user cycles
• objectives_position, Update the position of all objectives under a user cycle
  • The request must include the IDs of all objectives under the corresponding cycle, otherwise parameter validation will fail. Objectives will be reordered based on the order of the provided objective IDs.
• objectives_weight, Update the weight of all objectives under a user cycle
  • The request must modify the weights of all objectives under the corresponding cycle simultaneously, and the sum of all weight values must equal 1, otherwise parameter validation will fail. For example, when there are 2 objectives under a cycle:
  • Correct command example:

    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, Create objective
• list, Batch get objectives under a user cycle

indicators

• patch, Update quantitative indicator

key_results

• delete, Delete key result
• get, Get key result
• patch, Update key result

key_result.indicators

• list, Get quantitative indicators for a key result

objectives

• delete, Delete objective
• get, Get objective
• key_results_position, Update the position of all key results
  • The request must include the IDs of all key results under the corresponding cycle, otherwise parameter validation will fail. Key results will be reordered based on the order of the provided key result IDs.
• key_results_weight, Update the weight of all key results
  • Similar to objectives_weight, the request must modify the weights of all key results under the corresponding objective simultaneously, and the sum of all weight values must equal 1, otherwise parameter validation will fail.
• patch, Update objective

objective.alignments

• create, Create alignment relationship
  • Aligning an objective to itself is not allowed, and the cycle time of the initiating objective and the target objective must overlap, otherwise parameter validation will fail.
• list, Batch get alignment relationships under an objective

objective.indicators

• list, Get quantitative indicators for an objective

objective.key_results

• create, Create key result
• list, Batch get key results under an objective

Out of Scope for this Skill

• To-do task management → Use lark-task
• Calendar scheduling → Use lark-calendar
• Performance evaluation → Use lark-openapi-explorer to find native interfaces