feat:移除了弹窗,服务器添加sls
This commit is contained in:
103
.agents/skills/lark-okr/references/lark-okr-cycle-list.md
Normal file
103
.agents/skills/lark-okr/references/lark-okr-cycle-list.md
Normal file
@ -0,0 +1,103 @@
|
||||
# okr +cycle-list
|
||||
|
||||
> **前置条件:** 先阅读 [`lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
|
||||
|
||||
列出指定用户的一页 OKR 周期,支持外部控制翻页和可选的时间范围后置过滤。
|
||||
|
||||
## 推荐命令
|
||||
|
||||
```bash
|
||||
# 获取用户周期第一页 (默认页大小为 100 按时间倒序排列,一般不用翻页)
|
||||
lark-cli okr +cycle-list --user-id "ou_xxx"
|
||||
|
||||
# 获取下一页
|
||||
lark-cli okr +cycle-list --user-id "ou_xxx" --page-size 100 --page-token "7000000000000000002"
|
||||
|
||||
# 使用特定的用户 ID 类型列出周期
|
||||
lark-cli okr +cycle-list --user-id "xxx" --user-id-type user_id
|
||||
|
||||
# 列出当前返回页中与时间范围重叠的周期(例如 2025-01 到 2025-06)
|
||||
lark-cli okr +cycle-list --user-id "ou_xxx" --time-range "2025-01--2025-06"
|
||||
|
||||
# 预览 API 调用而不实际执行
|
||||
lark-cli okr +cycle-list --user-id "ou_xxx" --dry-run
|
||||
```
|
||||
|
||||
## 参数
|
||||
|
||||
| 参数 | 必填 | 默认值 | 说明 |
|
||||
|------------------|----|-----------|------------------------------------------------------------------|
|
||||
| `--user-id` | 是 | — | OKR 所有者的用户 ID |
|
||||
| `--user-id-type` | 否 | `open_id` | 用户 ID 类型:`open_id` \| `union_id` \| `user_id` |
|
||||
| `--time-range` | 否 | — | 后置筛选条件:先按 `--page-size`/`--page-token` 请求一页,再在本地保留与该时间范围重叠的周期。格式:`YYYY-MM--YYYY-MM`(例如 `2025-01--2025-06`)。 |
|
||||
| `--page-size` | 否 | `100` | 每页数量,范围 `1-100`。 |
|
||||
| `--page-token` | 否 | `""` | 上一次响应中的 `page_token`,留空表示第一页。 |
|
||||
| `--dry-run` | 否 | — | 预览 API 调用而不实际执行。 |
|
||||
| `--format` | 否 | `json` | 输出格式。 |
|
||||
|
||||
## 工作流程
|
||||
|
||||
1. 获取目标用户的 `open_id`(或其他 ID 类型)。如果用户说"我的 OKR 周期",先通过 `lark-cli contact +get-user` 获取当前用户的
|
||||
ID。
|
||||
2. 执行 `lark-cli okr +cycle-list --user-id "ou_xxx" --page-size 100`,可选择使用 `--time-range`。
|
||||
3. 如果响应中 `has_more=true`,继续用返回的 `page_token` 调用下一页。
|
||||
4. 报告结果:每个周期的 ID、开始/结束时间和状态。
|
||||
|
||||
`--time-range` 是后置筛选条件,不会改变服务端分页窗口。也就是说,命令会先获取指定页,再过滤该页中的周期;如果需要完整时间范围结果,需要按 `has_more`/`page_token` 逐页拉取并合并。
|
||||
|
||||
## 输出
|
||||
|
||||
返回 JSON:
|
||||
|
||||
```json
|
||||
{
|
||||
"cycles": [
|
||||
{
|
||||
"id": "1234567890123456789",
|
||||
"start_time": "2025-01-01 00:00:00",
|
||||
"end_time": "2025-06-30 00:00:00",
|
||||
"cycle_status": "normal"
|
||||
}
|
||||
],
|
||||
"has_more": true,
|
||||
"page_token": "7000000000000000002",
|
||||
"current_active_cycles": [
|
||||
{
|
||||
"id": "1234567890123456789",
|
||||
"start_time": "2025-01-01 00:00:00",
|
||||
"end_time": "2025-06-30 00:00:00",
|
||||
"cycle_status": "normal"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
在这个周期信息中,这些字段值得关注:
|
||||
|
||||
- `id` 是这个周期的 ID,你通常需要用它在之后使用 `okr +cycle-detail` 获取 OKR 内容详情
|
||||
- `has_more` 和 `page_token` 用于外部控制翻页;`has_more=true` 时,用 `--page-token` 原样传入本次返回的 `page_token` 获取下一页。
|
||||
- `start_time` `end_time` 是周期的起止时间,总是从某个月1日开始,直到此月或之后某月的最后一日结束。
|
||||
- 在 OKR 系统中,我们只关注这个时间的年月部分,如 "2025-01-01开始,2025-06-30结束" 的周期被称作 "2025 年 1-6 月" 周期,而
|
||||
"2025-01-01开始,2025-01-31结束" 的周期被称作 "2025 年 1 月"周期。
|
||||
- 如果一个周期从某年1月1日开始,某年12月31日结束,则它是这一年的年度周期,如 "2025-01-01开始,2025-12-31结束" 的周期就是
|
||||
"2025 年" 的年度周期
|
||||
- `cycle_status` 为周期状态值,参见下文。
|
||||
- `current_active_cycles` 是当前生效的周期列表,不过根据用户的周期设置,可能会出现为空的场景。
|
||||
|
||||
如果需要获取周期的创建时间/总分等信息,可以通过原生 API `okr cycles list` 获取。
|
||||
|
||||
### 周期状态值
|
||||
|
||||
| 值 | 说明 |
|
||||
|-----------|----------|
|
||||
| `default` | 默认状态 (0) |
|
||||
| `normal` | 生效 (1) |
|
||||
| `invalid` | 失效 (2) |
|
||||
| `hidden` | 隐藏 (3) |
|
||||
|
||||
在 OKR 系统中,default/normal 状态下的周期当前正常生效,invalid 状态下的周期已失效但通常仍然可以填写,hidden 状态下的周期隐藏不可见。
|
||||
|
||||
## 参考
|
||||
|
||||
- [lark-okr](../SKILL.md) -- 所有 OKR 命令
|
||||
- [lark-shared](../../lark-shared/SKILL.md) -- 认证和全局参数
|
||||
Reference in New Issue
Block a user