4.3 KiB
4.3 KiB
okr +batch-create
前置条件: 先阅读
lark-shared/SKILL.md了解认证、全局参数和安全规则。
批量创建 OKR 目标(Objective)和关键结果(Key Result)。
推荐命令
# 批量创建 2 个 Objective,各带 2 个 KR。
lark-cli okr +batch-create \
--cycle-id 7000000000000000001 \
--input '[{"text":"提升产品用户体验","mention":["ou_xxxxxxxx"],"notes":"重点关注核心路径体验","krs":[{"text":"页面加载速度提升 50%","mention":["ou_yyyyyyyy"]},{"text":"用户满意度达到 4.8 分"}]},{"text":"拓展新市场份额","krs":[{"text":"新增 10 个城市覆盖"},{"text":"市场份额提升至 25%"}]}]' \
--as user
# 从文件读取输入
lark-cli okr +batch-create \
--cycle-id 7000000000000000001 \
--input @okr_batch.json \
--as user
# 预览 API 调用(Dry-run)
lark-cli okr +batch-create \
--cycle-id 7000000000000000001 \
--input @okr_batch.json \
--dry-run \
--as user
- mention 是可选参数,不需要使用“@”提及其他用户时不传入。
- 传入的 mention 参数会以 @对应用户的形式,添加在文本后。
- Objective 的 notes / notes_mention 是可选参数,用于创建目标备注;KR 不支持备注。
- Objective 的 category_id 是可选参数;也可以通过
--category-id给所有未显式设置分类的 Objective 指定默认分类。
参数
| 参数 | 必填 | 默认值 | 说明 |
|---|---|---|---|
--cycle-id |
是 | — | OKR 周期 ID(int64 类型) |
--input |
是 | — | JSON 数组格式的 Objective 列表。支持 @文件路径 从文件读取或 - 从 stdin 读取。 |
--category-id |
否 | — | 默认 Objective 分类 ID。仅用于 input 中未设置 category_id 的 Objective。通常不需要传入,见下方“分类提示”。 |
--user-id-type |
否 | open_id |
mention 中使用的用户 ID 类型:open_id | union_id | user_id |
--dry-run |
否 | — | 预览 API 调用而不实际执行 |
--format |
否 | json |
输出格式 |
分类提示:当用户明确要求设置 Objective 分类,或创建 Objective 返回
invalid parameters且怀疑租户强制开启分类时,可以配置 category-id 字段进行创建。先运行lark-cli okr categories list --as user查看可用分类,然后选择一个语义合适且enabled=true的分类 ID 作为category-id。分类创建后可以再调整;不必因为分类选择停下等待用户确认。
输入格式
[
{
"text": "Objective 内容",
"mention": ["ou_xxxxxxxx", "ou_yyyyyyyy"],
"notes": "Objective 备注",
"notes_mention": ["ou_xxxxxxxx"],
"category_id": "7249339036661170180",
"krs": [
{
"text": "KR 内容",
"mention": ["ou_zzzzzzzz"]
}
]
}
]
字段说明:
text:Objective 或 KR 内容,必填。mention:追加到内容后的用户 mention,可选。notes:Objective 备注文本,可选,仅 Objective 支持。notes_mention:追加到 Objective 备注后的用户 mention,可选,仅在notes存在时有意义。category_id:Objective 分类 ID,可选;会覆盖命令级--category-id。krs:当前 Objective 下要创建的 KR 列表,可选。
工作流程
- 使用
+cycle-list获取可用的 OKR 周期 ID - 构造
--inputJSON 数组,包含要创建的 Objective 和 KR - 执行
lark-cli okr +batch-create --cycle-id <id> --input '...'
输出
成功返回 JSON:
{
"ok": true,
"data": {
"created": [
{
"objective_id": "7000000000000000002",
"krs": ["7000000000000000003", "7000000000000000004"]
},
{
"objective_id": "7000000000000000005",
"krs": ["7000000000000000006"]
}
]
}
}
参考
- OKR 业务实体 -- OKR 实体结构定义
- lark-shared -- 认证和全局参数