@cloudglab/zentao-cli 0.1.4 → 0.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/CHANGELOG.md +38 -0
  2. package/README.md +139 -257
  3. package/dist/api/execution.d.ts +33 -0
  4. package/dist/api/execution.js +363 -0
  5. package/dist/api/execution.js.map +1 -1
  6. package/dist/api/index.js +1 -1
  7. package/dist/api/index.js.map +1 -1
  8. package/dist/api/statistics.d.ts +38 -1
  9. package/dist/api/statistics.js +307 -1
  10. package/dist/api/statistics.js.map +1 -1
  11. package/dist/api/task.js +24 -5
  12. package/dist/api/task.js.map +1 -1
  13. package/dist/cli.js +21 -3
  14. package/dist/cli.js.map +1 -1
  15. package/dist/core/http.d.ts +1 -0
  16. package/dist/core/http.js +26 -0
  17. package/dist/core/http.js.map +1 -1
  18. package/dist/core/roles.js +1 -1
  19. package/dist/core/roles.js.map +1 -1
  20. package/dist/install.d.ts +2 -0
  21. package/dist/install.js +206 -0
  22. package/dist/install.js.map +1 -0
  23. package/dist/tools/execution.js +8 -0
  24. package/dist/tools/execution.js.map +1 -1
  25. package/dist/tools/statistics.js +8 -0
  26. package/dist/tools/statistics.js.map +1 -1
  27. package/dist/version.d.ts +1 -1
  28. package/dist/version.js +1 -1
  29. package/package.json +10 -3
  30. package/skills/zentao-cli/SKILL.md +185 -0
  31. package/skills/zentao-cli/reference/bug.md +93 -0
  32. package/skills/zentao-cli/reference/build.md +21 -0
  33. package/skills/zentao-cli/reference/cli.md +25 -0
  34. package/skills/zentao-cli/reference/execution.md +38 -0
  35. package/skills/zentao-cli/reference/install.md +90 -0
  36. package/skills/zentao-cli/reference/overview.md +24 -0
  37. package/skills/zentao-cli/reference/plan.md +20 -0
  38. package/skills/zentao-cli/reference/product.md +14 -0
  39. package/skills/zentao-cli/reference/project.md +14 -0
  40. package/skills/zentao-cli/reference/statistics.md +30 -0
  41. package/skills/zentao-cli/reference/story.md +22 -0
  42. package/skills/zentao-cli/reference/task.md +21 -0
  43. package/skills/zentao-cli/reference/testcase.md +20 -0
  44. package/skills/zentao-cli/reference/testtask.md +20 -0
@@ -0,0 +1,38 @@
1
+ # Execution
2
+
3
+ ## 查询
4
+
5
+ ```bash
6
+ zentao getExecutionDetail --executionId <id>
7
+ zentao getExecutionDynamic --executionId <id>
8
+ zentao getExecutionBugs --executionId <id>
9
+ zentao getExecutionDailyBugStats --executionId <id> --iterationName 1.2.3迭代
10
+ zentao getExecutionBuilds --executionId <id>
11
+ ```
12
+
13
+ `getExecutionDynamic` 是近似读取:调用禅道 REST `GET /executions/{id}?fields=dynamics`,用于快速查看执行动态摘要。它不是旧版页面 `execution-dynamic-<id>.html` 的完整等价实现,暂不支持 `today/all/自定义时间范围` 参数。
14
+
15
+ `getExecutionDailyBugStats` 用于“每日迭代执行统计”场景:按执行下 Bug 当前字段统计总 Bug、延期处理、reopen、已关闭、已解决、未解决、测试未及时关闭 Bug、开发今日未及时解决 Bug,并输出参与人员 Bug 情况和文本报告。
16
+
17
+ 统计口径:
18
+
19
+ - reopen:`activatedCount > 0`
20
+ - 延期处理:`resolution` 为 `postponed/delay/delayed`
21
+ - 测试未及时关闭 Bug:当前 `status=resolved` 但还没关闭
22
+ - 开发今日未及时解决 Bug:当前未解决且创建日期不晚于统计日期
23
+ - 参与人员归属:优先 `resolvedBy`,其次 `assignedTo`,再其次 `openedBy`
24
+
25
+ ## 写入
26
+
27
+ ```bash
28
+ zentao startExecution --executionId <id> --confirm true
29
+ zentao closeExecution --executionId <id> --confirm true
30
+ ```
31
+
32
+ ## 场景
33
+
34
+ - 看执行详情
35
+ - 看执行动态摘要
36
+ - 看执行 Bug / 构建
37
+ - 做每日迭代执行 Bug 统计报告
38
+ - 启动 / 关闭执行
@@ -0,0 +1,90 @@
1
+ # 安装 / 更新
2
+
3
+ ## 一键安装 CLI + Skill
4
+
5
+ ```bash
6
+ npx -y @cloudglab/zentao-cli@latest install
7
+ ```
8
+
9
+ 它会依次执行:
10
+
11
+ 1. 安装全局 CLI:`npm install -g @cloudglab/zentao-cli@latest`
12
+ 2. 安装 skill:`npx -y skills add -g cloudglab/zentao-cli`
13
+ 3. 如果没有禅道配置,或已有配置登录失败,则提示输入配置并校验
14
+
15
+ 默认通过 GitHub 仓库安装 skill。如果当前环境不能访问远程 `.git` 仓库,但可以访问 npm 包,可改用 npm 静态包模式:
16
+
17
+ ```bash
18
+ npx -y @cloudglab/zentao-cli@latest install --skill-source npm
19
+ ```
20
+
21
+ 如果已经提前下载并解压好了 npm 静态包,也可以直接指定本地目录:
22
+
23
+ ```bash
24
+ zentao install --skill-local-path ./package
25
+ ```
26
+
27
+ 后续更新可运行:
28
+
29
+ ```bash
30
+ zentao update
31
+ ```
32
+
33
+ `zentao update` 会重新安装最新 CLI 和 skill,并再次校验禅道配置。
34
+
35
+ ## 安装 CLI
36
+
37
+ ```bash
38
+ # 运行时要求:Node.js >= 16
39
+ npm i -g @cloudglab/zentao-cli@latest
40
+ ```
41
+
42
+ 或直接运行:
43
+
44
+ ```bash
45
+ npx -y @cloudglab/zentao-cli@latest --help
46
+ ```
47
+
48
+ ## 安装 Skill
49
+
50
+ 默认 GitHub 仓库方式:
51
+
52
+ ```bash
53
+ npx -y skills add -g cloudglab/zentao-cli
54
+ ```
55
+
56
+ 只能访问 npm、不能 clone `.git` 仓库时:
57
+
58
+ ```bash
59
+ npm pack @cloudglab/zentao-cli@latest
60
+ tar -xzf cloudglab-zentao-cli-*.tgz
61
+ npx -y skills add -g ./package
62
+ ```
63
+
64
+ ## 检查是否已安装
65
+
66
+ ```bash
67
+ command -v zentao
68
+ zentao --version
69
+ zentao version
70
+ zentao help
71
+ ```
72
+
73
+ ## 更新
74
+
75
+ ```bash
76
+ zentao update
77
+ ```
78
+
79
+ skill 内推荐优先调用本地 `zentao`;只有在当前环境不方便安装时,才退回 `npx -y @cloudglab/zentao-cli@latest`。
80
+
81
+ 如果你不想全局安装,也可以一直用:
82
+
83
+ ```bash
84
+ npx -y @cloudglab/zentao-cli@latest
85
+ ```
86
+
87
+ ## 写操作前置条件
88
+
89
+ - `ZENTAO_ENABLE_WRITE=true`
90
+ - `confirm=true`
@@ -0,0 +1,24 @@
1
+ # 总览
2
+
3
+ ## 这个 skill 做什么
4
+
5
+ - 用命令行方式操作禅道
6
+ - 默认只 preview,不直接写线上
7
+ - 支持任务、Bug、需求、项目、执行、构建、测试用例、测试单等常用场景
8
+
9
+ ## 推荐工作流
10
+
11
+ 1. 先确认本机是否安装 `zentao`
12
+ 2. 如果没有,优先安装或升级本地 `zentao`
13
+ 3. 先判断用户问的是普通禅道产品数据,还是业务产品的线上 / 客户反馈 / 生产问题
14
+ 4. 如果是线上 Bug,固定按 `reference/bug.md` 里的“市场和售后问题跟踪 + 模块匹配”链路查询
15
+ 5. 根据问题类型,去对应 reference 文档找命令
16
+ 6. 默认只 preview;写操作必须显式确认
17
+
18
+ 补充:当前发布产物运行时目标为 `Node.js >= 16`;开发 / 构建环境可以更高。
19
+
20
+ ## 适合谁
21
+
22
+ - 需要命令行操作禅道的人
23
+ - 需要把禅道接入智能体的人
24
+ - 需要在旧版本禅道环境下稳定使用的人
@@ -0,0 +1,20 @@
1
+ # Plan
2
+
3
+ ## 查询
4
+
5
+ ```bash
6
+ zentao getProductPlans --productId <productId>
7
+ zentao getPlanDetail --planId <id>
8
+ ```
9
+
10
+ ## 关系操作
11
+
12
+ ```bash
13
+ zentao linkStoriesToPlan --planId <id> --storyIds <id1,id2>
14
+ zentao linkBugsToPlan --planId <id> --bugIds <id1,id2>
15
+ ```
16
+
17
+ ## 场景
18
+
19
+ - 查看计划
20
+ - 关联需求 / Bug 到计划
@@ -0,0 +1,14 @@
1
+ # Product
2
+
3
+ ## 查询
4
+
5
+ ```bash
6
+ zentao getProducts
7
+ zentao getProductDetail --productId <id>
8
+ zentao getProductStories --productId <id>
9
+ ```
10
+
11
+ ## 场景
12
+
13
+ - 查看产品信息
14
+ - 查看产品下需求 / Bug / 用例
@@ -0,0 +1,14 @@
1
+ # Project
2
+
3
+ ## 查询
4
+
5
+ ```bash
6
+ zentao getProjects
7
+ zentao getProjectDetail --projectId <id>
8
+ zentao getProjectExecutions --projectId <id>
9
+ ```
10
+
11
+ ## 场景
12
+
13
+ - 查看项目
14
+ - 查看项目下执行
@@ -0,0 +1,30 @@
1
+ # Statistics
2
+
3
+ ## 查询
4
+
5
+ ```bash
6
+ zentao getMyTaskStatistics
7
+ zentao getMyBugStatistics
8
+ zentao getMyBugStatistics --productId <productId>
9
+ zentao getMyWeeklyActivity --account <account> --week last
10
+ zentao getMyWeeklyActivity --account <account> --dateRange 上周
11
+ zentao getMyWeeklyActivity --account <account> --dateRange 最近3天
12
+ zentao getMyWeeklyActivity --account <account> --dateRange 2026-05-28
13
+ zentao getMyWeeklyActivity --account <account> --startDate 2026-05-25 --endDate 2026-05-29
14
+ ```
15
+
16
+ ## 场景
17
+
18
+ - 看个人任务统计
19
+ - 看个人 Bug 统计
20
+ - 看指定账号上周 / 本周做了什么:解决 Bug、关闭 Bug、评论补充、指派流转、任务相关动作和每日清单
21
+
22
+ 说明:
23
+
24
+ - `getMyBugStatistics` 不传 `productId` 时,默认统计跨所有产品“指派给我的 Bug”
25
+ - 传 `productId` 时,只统计指定产品内我的 Bug
26
+ - `getMyWeeklyActivity` 是近似读取:调用禅道旧版动态页面 JSON 获取动态原始数据,再按原始 `originalDate` / `date` 在客户端筛选日期范围,用于快速生成“我某段时间做了什么”清单
27
+ - 日期不要写死为周:优先支持 `--dateRange` 自然语言描述,也支持 `--startDate/--endDate` 和 `--days`
28
+ - `--dateRange` 支持示例:`上周`、`本周`、`今天`、`昨天`、`最近3天`、`3天前`、`2026-05-28`、`2026-05-25到2026-05-29`
29
+ - 未传日期范围时,默认兼容旧参数:`--week last` 映射 `lastWeek`,`--week this` 映射 `thisWeek`
30
+ - bug 转任务去重会优先识别动态记录中的来源 Bug 字段;如果动态记录没有来源 Bug 字段,该任务会按独立任务计数并在结果限制说明中提示
@@ -0,0 +1,22 @@
1
+ # Story
2
+
3
+ ## 查询
4
+
5
+ ```bash
6
+ zentao getStoryDetail --storyId <id>
7
+ zentao getProductStories --productId <productId>
8
+ zentao searchStories --productId <productId> --keyword <keyword>
9
+ ```
10
+
11
+ ## 写入
12
+
13
+ ```bash
14
+ zentao updateStory --storyId <id> --confirm true
15
+ zentao changeStory --storyId <id> --confirm true
16
+ ```
17
+
18
+ ## 场景
19
+
20
+ - 查看需求
21
+ - 修改需求内容
22
+ - 变更需求状态
@@ -0,0 +1,21 @@
1
+ # 任务 Task
2
+
3
+ ## 查询
4
+
5
+ ```bash
6
+ zentao getMyTasks
7
+ zentao getTaskDetail --taskId <id>
8
+ ```
9
+
10
+ ## 写入
11
+
12
+ ```bash
13
+ zentao updateTask --taskId <id> --status done --confirm true
14
+ zentao finishTask --taskId <id> --confirm true
15
+ ```
16
+
17
+ ## 场景
18
+
19
+ - 看我的待办
20
+ - 改任务状态
21
+ - 完成任务
@@ -0,0 +1,20 @@
1
+ # TestCase
2
+
3
+ ## 查询
4
+
5
+ ```bash
6
+ zentao getProductTestCases --productId <productId>
7
+ zentao getTestCaseDetail --testCaseId <id>
8
+ ```
9
+
10
+ ## 写入
11
+
12
+ ```bash
13
+ zentao createTestCase --productId <productId> --title <title> --type feature --confirm true
14
+ zentao updateTestCase --testCaseId <id> --confirm true
15
+ ```
16
+
17
+ ## 场景
18
+
19
+ - 创建 / 修改测试用例
20
+ - 查看产品用例列表
@@ -0,0 +1,20 @@
1
+ # TestTask
2
+
3
+ ## 查询
4
+
5
+ ```bash
6
+ zentao getTestTasks --productId <productId>
7
+ zentao getTestTaskDetail --testTaskId <id>
8
+ ```
9
+
10
+ ## 写入
11
+
12
+ ```bash
13
+ zentao createTestTask --project <projectId> --productID <productId> --name <name> --build <buildId> --begin <YYYY-MM-DD> --end <YYYY-MM-DD> --confirm true
14
+ zentao updateTestTask --testTaskId <id> --confirm true
15
+ ```
16
+
17
+ ## 场景
18
+
19
+ - 创建 / 修改测试单
20
+ - 查看产品测试单列表