@comate/zulu 1.2.1-beta.2 → 1.3.1

package/comate-engine/assets/skills/icode-comate/references/api/get_machine_check.md

@@ -0,0 +1,73 @@
+# get_machine_check - 获取机器检查结果
+
+获取代码评审的自动化机器检查结果，包括代码规范检查、静态分析等。
+
+## 命令格式
+
+```bash
+icode-cli api get_machine_check --change-number <评审编号> [--output <格式>]
+```
+
+## 参数说明
+
+| 参数 | 短参数 | 必填 | 默认值 | 说明 |
+|------|--------|------|--------|------|
+| `--change-number` | `-n` | 是 | - | 评审编号（数字） |
+| `--output` | `-o` | 否 | json | 输出格式：json/yaml/table |
+
+## 使用示例
+
+```bash
+# 获取机器检查结果
+icode-cli api get_machine_check -n 12345
+
+# 表格格式输出
+icode-cli api get_machine_check --change-number 12345 --output table
+```
+
+## 返回数据
+
+### JSON 格式
+
+```json
+{
+  "status": "OK",
+  "message": "操作成功",
+  "data": {
+    "checks": [
+      {
+        "name": "lint-check",
+        "status": "PASSED",
+        "message": "代码规范检查通过"
+      },
+      {
+        "name": "unit-test",
+        "status": "FAILED",
+        "message": "2 个测试用例失败"
+      }
+    ]
+  }
+}
+```
+
+### 字段说明
+
+| 字段 | 类型 | 说明 |
+|------|------|------|
+| `name` | string | 检查项名称 |
+| `status` | string | 检查状态：PASSED/FAILED/RUNNING |
+| `message` | string | 检查结果说明 |
+
+## 检查状态说明
+
+| 状态 | 含义 |
+|------|------|
+| `PASSED` | 检查通过 |
+| `FAILED` | 检查失败 |
+| `RUNNING` | 检查进行中 |
+
+## 注意事项
+
+- 需要有该评审的访问权限
+- 机器检查结果会影响评审是否可以合并
+- 部分检查可能需要等待一段时间才能完成

package/comate-engine/assets/skills/icode-comate/references/api/get_my_reviews.md

@@ -0,0 +1,115 @@
+# get_my_reviews
+
+获取自己或指定用户的评审列表。
+
+## 命令格式
+
+```bash
+icode-cli api get_my_reviews [--user <username>] [--status <status>] [--type <type>] [--product-name <name>] [--start-from <n>] [--with-diff-info] [-o json|table|yaml]
+```
+
+## 参数说明
+
+| 参数 | 短参数 | 必填 | 默认值 | 说明 |
+|------|--------|------|--------|------|
+| `--user` | `-u` | 否 | 当前用户 | 要查询的用户名 |
+| `--status` | `-s` | 否 | OPEN | 评审状态：OPEN/NEW/MERGED/ABANDONED |
+| `--type` | `-t` | 否 | owner | 角色类型：owner（我发起的）/reviewer（我评审的） |
+| `--product-name` | `-p` | 否 | - | 产品名称（可选过滤） |
+| `--start-from` | `-f` | 否 | 0 | 起始位置（分页用） |
+| `--with-diff-info` | `-d` | 否 | false | 是否附带差异信息 |
+| `--output` | `-o` | 否 | json | 输出格式：json、table、yaml |
+
+## 状态说明
+
+| 状态 | 说明 |
+|------|------|
+| `OPEN` | 待评审（包含 NEW） |
+| `NEW` | 新建的评审 |
+| `MERGED` | 已合入 |
+| `ABANDONED` | 已废弃 |
+
+## 使用示例
+
+```bash
+# 获取当前用户作为 owner 的 OPEN 状态评审（默认）
+icode-cli api get_my_reviews
+
+# 获取指定用户作为 reviewer 的已合入评审
+icode-cli api get_my_reviews --user zhangsan --status MERGED --type reviewer
+
+# 获取评审并附带差异信息
+icode-cli api get_my_reviews --with-diff-info
+
+# 以表格形式输出
+icode-cli api get_my_reviews --output table
+
+# 分页查询，从第 10 条开始
+icode-cli api get_my_reviews --start-from 10
+```
+
+## 输出格式
+
+### JSON 格式（默认）
+
+```json
+{
+  "status": "OK",
+  "message": "",
+  "data": {
+    "hasMore": true,
+    "startfrom": 0,
+    "changes": [
+      {
+        "project": "baidu/icode/test",
+        "branch": "master",
+        "subject": "fix: 修复登录问题",
+        "updated": "2024-01-15 10:30:00",
+        "owner": {
+          "username": "zhangsan"
+        },
+        "current_revision": "abc123",
+        "_number": 12345,
+        "insertions": 10,
+        "deletions": 5
+      }
+    ]
+  }
+}
+```
+
+### Table 格式
+
+```
+User: zhangsan, Role: owner, HasMore: true
+
+Number  Project           Branch  Subject             Owner     Updated
+------  -------           ------  -------             -----     -------
+12345   baidu/icode/test  master  fix: 修复登录问题   zhangsan  2024-01-15 10:30:00
+```
+
+## 返回字段说明
+
+| 字段 | 类型 | 说明 |
+|------|------|------|
+| `hasMore` | bool | 是否还有更多数据 |
+| `startfrom` | int | 当前起始位置 |
+| `changes` | array | 评审列表 |
+| `changes[].project` | string | 代码库名称 |
+| `changes[].branch` | string | 目标分支 |
+| `changes[].subject` | string | 提交标题 |
+| `changes[]._number` | int | 评审编号 |
+| `changes[].owner.username` | string | 提交者用户名 |
+| `changes[].updated` | string | 最后更新时间 |
+
+## 使用场景
+
+1. **查看待处理评审**：快速查看自己需要处理的评审
+2. **追踪评审状态**：了解自己发起的评审进度
+3. **评审人视角**：查看需要自己评审的代码
+
+## 相关命令
+
+- `icode-cli api get_repo_reviews`: 获取仓库的评审列表
+- `icode-cli api get_review_info`: 获取评审详情
+- `icode-cli api set_review_score`: 设置评审分数

package/comate-engine/assets/skills/icode-comate/references/api/get_person_commit.md

@@ -0,0 +1,89 @@
+# get_person_commit - 查询个人提交记录
+
+查询用户在指定时间范围内的代码提交记录。
+
+## 命令格式
+
+```bash
+icode-cli api get_person_commit [--target <用户名>] [--begin-date <开始日期>] [--end-date <结束日期>] [--page-no <页码>] [--page-size <每页数量>] [--output <格式>]
+```
+
+## 参数说明
+
+| 参数 | 短参数 | 必填 | 默认值 | 说明 |
+|------|--------|------|--------|------|
+| `--target` | `-t` | 否 | 当前用户 | 目标用户名 |
+| `--begin-date` | `-b` | 否 | 今天 | 开始日期（YYYY-MM-DD） |
+| `--end-date` | `-e` | 否 | 今天 | 结束日期（YYYY-MM-DD） |
+| `--page-no` | `-p` | 否 | 1 | 页码 |
+| `--page-size` | `-s` | 否 | 50 | 每页数量 |
+| `--output` | `-o` | 否 | json | 输出格式：json/yaml/table |
+
+## 使用示例
+
+```bash
+# 查询今天的提交记录
+icode-cli api get_person_commit
+
+# 查询指定用户的提交
+icode-cli api get_person_commit --target zhangsan
+
+# 查询指定时间范围的提交
+icode-cli api get_person_commit --begin-date 2024-01-01 --end-date 2024-01-31
+
+# 分页查询
+icode-cli api get_person_commit -b 2024-01-01 -e 2024-01-31 -p 2 -s 20
+
+# 表格格式输出
+icode-cli api get_person_commit -b 2024-01-01 -e 2024-01-31 -o table
+```
+
+## 返回数据
+
+### JSON 格式
+
+```json
+{
+  "status": "OK",
+  "message": "操作成功",
+  "data": {
+    "page": {
+      "pageNo": 1,
+      "pageSize": 50,
+      "totalCount": 100
+    },
+    "results": [
+      {
+        "commitId": "abc123def456",
+        "author": "zhangsan",
+        "commitTime": "2024-01-15 14:30:00",
+        "addLines": 100,
+        "deleteLines": 20,
+        "subject": "feat: add new feature"
+      }
+    ]
+  }
+}
+```
+
+### 字段说明
+
+| 字段 | 类型 | 说明 |
+|------|------|------|
+| `commitId` | string | 提交 ID |
+| `author` | string | 作者用户名 |
+| `commitTime` | string | 提交时间 |
+| `addLines` | int | 新增行数 |
+| `deleteLines` | int | 删除行数 |
+| `subject` | string | 提交信息 |
+
+## 使用场景
+
+- 统计代码提交量
+- 生成工作日报/周报
+- 查看自己或他人的提交历史
+
+## 注意事项
+
+- 可以查询其他用户的公开提交记录
+- 日期范围不宜过大，建议按月查询

package/comate-engine/assets/skills/icode-comate/references/api/get_person_repo.md

@@ -0,0 +1,63 @@
+# get_person_repo - 查询个人代码库列表
+
+查询用户有权限访问的代码库列表。
+
+## 命令格式
+
+```bash
+icode-cli api get_person_repo [--page-no <页码>] [--page-size <每页数量>] [--output <格式>]
+```
+
+## 参数说明
+
+| 参数 | 短参数 | 必填 | 默认值 | 说明 |
+|------|--------|------|--------|------|
+| `--page-no` | `-p` | 否 | 1 | 页码，从 1 开始 |
+| `--page-size` | `-s` | 否 | 50 | 每页数量 |
+| `--output` | `-o` | 否 | json | 输出格式：json/yaml/table |
+
+## 使用示例
+
+```bash
+# 获取代码库列表（默认格式）
+icode-cli api get_person_repo
+
+# 使用分页
+icode-cli api get_person_repo --page-no 2 --page-size 20
+
+# 表格格式输出
+icode-cli api get_person_repo --output table
+```
+
+## 返回数据
+
+### JSON 格式
+
+```json
+{
+  "status": "OK",
+  "message": "操作成功",
+  "data": [
+    {
+      "name": "test-repo",
+      "fullName": "baidu/icode/test-repo",
+      "language": "Go",
+      "description": "测试代码库"
+    }
+  ]
+}
+```
+
+### 字段说明
+
+| 字段 | 类型 | 说明 |
+|------|------|------|
+| `name` | string | 代码库名称（最后一级） |
+| `fullName` | string | 完整路径（三层目录） |
+| `language` | string | 主要编程语言 |
+| `description` | string | 代码库描述 |
+
+## 注意事项
+
+- 只能查询当前认证用户有权限的代码库
+- 大量代码库时建议使用分页参数

package/comate-engine/assets/skills/icode-comate/references/api/get_repo_branch.md

@@ -0,0 +1,62 @@
+# get_repo_branch - 查询代码库分支列表
+
+查询指定代码库的所有分支信息。
+
+## 命令格式
+
+```bash
+icode-cli api get_repo_branch --repo <代码库名称> [--output <格式>]
+```
+
+## 参数说明
+
+| 参数 | 短参数 | 必填 | 默认值 | 说明 |
+|------|--------|------|--------|------|
+| `--repo` | `-r` | 是 | - | 代码库名称，三层目录形式 |
+| `--output` | `-o` | 否 | json | 输出格式：json/yaml/table |
+
+## 使用示例
+
+```bash
+# 获取分支列表
+icode-cli api get_repo_branch --repo baidu/icode/test
+
+# 表格格式输出
+icode-cli api get_repo_branch -r baidu/icode/test -o table
+```
+
+## 返回数据
+
+### JSON 格式
+
+```json
+{
+  "status": "OK",
+  "message": "操作成功",
+  "data": [
+    {
+      "name": "master",
+      "createTime": "2024-01-01 10:00:00",
+      "createUser": "zhangsan"
+    },
+    {
+      "name": "develop",
+      "createTime": "2024-01-15 14:30:00",
+      "createUser": "lisi"
+    }
+  ]
+}
+```
+
+### 字段说明
+
+| 字段 | 类型 | 说明 |
+|------|------|------|
+| `name` | string | 分支名称 |
+| `createTime` | string | 创建时间 |
+| `createUser` | string | 创建者用户名 |
+
+## 注意事项
+
+- 需要有代码库的访问权限
+- 代码库名称必须是完整的三层目录形式（如 `baidu/icode/test`）

package/comate-engine/assets/skills/icode-comate/references/api/get_repo_config.md

@@ -0,0 +1,91 @@
+# get_repo_config
+
+获取代码库的配置信息（语言、工作流、保密类型等）。
+
+## 命令格式
+
+```bash
+icode-cli api get_repo_config --repo-names <repo-names> [--check-permission] [-o json|table|yaml]
+```
+
+## 参数说明
+
+| 参数 | 短参数 | 必填 | 默认值 | 说明 |
+|------|--------|------|--------|------|
+| `--repo-names` | `-r` | 是 | - | 代码库名称，逗号分隔，最多 20 个 |
+| `--check-permission` | - | 否 | false | 查询前检查读权限 |
+| `--output` | `-o` | 否 | json | 输出格式：json、table、yaml |
+
+## 使用示例
+
+```bash
+# 获取单个代码库的配置
+icode-cli api get_repo_config --repo-names baidu/icode/test
+
+# 获取多个代码库的配置（逗号分隔，最多 20 个）
+icode-cli api get_repo_config --repo-names baidu/icode/test,baidu/icode/test1
+
+# 先检查权限再查询
+icode-cli api get_repo_config --repo-names baidu/icode/test --check-permission
+
+# 以表格形式输出
+icode-cli api get_repo_config --repo-names baidu/icode/test --output table
+```
+
+## 输出格式
+
+### JSON 格式（默认）
+
+```json
+{
+  "status": "OK",
+  "message": "",
+  "data": [
+    {
+      "fullname": "baidu/icode/test",
+      "language": "Go",
+      "pdbProductId": 12345,
+      "accountId": "100001",
+      "repoWorkflowType": "WORKFLOW_CR",
+      "secret": "public",
+      "secLevel": "L1",
+      "templateName": "default"
+    }
+  ]
+}
+```
+
+### Table 格式
+
+```
+Total: 1 repositories
+
+FullName          Language  WorkflowType  Secret
+--------          --------  ------------  ------
+baidu/icode/test  Go        WORKFLOW_CR   public
+```
+
+## 返回字段说明
+
+| 字段 | 类型 | 说明 |
+|------|------|------|
+| `fullname` | string | 代码库全名 |
+| `language` | string | 主要编程语言 |
+| `pdbProductId` | int | PDB 产品 ID |
+| `accountId` | string | 账户 ID |
+| `repoWorkflowType` | string | 工作流类型（如 WORKFLOW_CR） |
+| `secret` | string | 保密类型（public/private/secret） |
+| `secLevel` | string | 安全等级 |
+| `templateName` | string | 模板名称 |
+
+## 使用场景
+
+1. **了解代码库配置**：查看代码库的基本配置信息
+2. **批量查询**：一次查询多个代码库的配置
+3. **自动化脚本**：根据配置决定后续操作
+
+## 相关命令
+
+- `icode-cli api get_submit_settings`: 获取提交规则配置
+- `icode-cli api check_repo_permission`: 检查代码库权限
+- `icode-cli api get_person_repo`: 查询个人代码库列表

package/comate-engine/assets/skills/icode-comate/references/api/get_repo_members.md

@@ -0,0 +1,118 @@
+# get_repo_members
+
+获取代码库成员列表，返回详细的成员信息（包含用户名、中文名、邮箱、角色等）。
+
+## 命令格式
+
+```bash
+icode-cli api get_repo_members --repo <repo-name> [--role <role>] [-o json|table|yaml]
+```
+
+## 参数说明
+
+| 参数 | 短参数 | 必填 | 默认值 | 说明 |
+|------|--------|------|--------|------|
+| `--repo` | `-r` | 是 | - | 代码库全名，格式如 `baidu/project/repo` |
+| `--role` | - | 否 | - | 成员角色过滤，不传则返回所有成员，见下方角色说明 |
+| `--output` | `-o` | 否 | json | 输出格式：json、table、yaml |
+
+## 角色说明
+
+| 角色 | 权限等级 | 说明 |
+|------|----------|------|
+| `ICODE_ADMIN` | 13 | 超级管理员 |
+| `CHIEF` | 12 | 负责人 |
+| `ADMIN` | 10 | 管理员 |
+| `OWNER` | 9 | 写权限人员 |
+| `MEMBER` | 8 | 读权限人员 |
+| `DELIVERER` | 3 | 交付权限人员 |
+
+> **注意**：`role` 参数为可选，不传时返回所有成员。
+
+## 使用示例
+
+```bash
+# 获取代码库所有成员
+icode-cli api get_repo_members --repo baidu/icode/test
+
+# 获取代码库管理员
+icode-cli api get_repo_members --repo baidu/icode/test --role ADMIN
+
+# 获取代码库负责人
+icode-cli api get_repo_members --repo baidu/icode/test --role CHIEF
+
+# 以表格形式输出
+icode-cli api get_repo_members --repo baidu/icode/test --output table
+```
+
+## 输出格式
+
+### JSON 格式（默认）
+
+```json
+{
+  "status": 200,
+  "message": "OK",
+  "data": [
+    {
+      "userName": "zhangsan",
+      "chineseName": "张三",
+      "email": "zhangsan@baidu.com",
+      "role": "ADMIN",
+      "roleDescription": "管理员"
+    },
+    {
+      "userName": "lisi",
+      "chineseName": "李四",
+      "email": "lisi@baidu.com",
+      "role": "OWNER",
+      "roleDescription": "写权限人员"
+    }
+  ]
+}
+```
+
+### Table 格式
+
+```
+Repository: baidu/icode/test
+Role Filter: All
+Total: 2
+
+Username    ChineseName  Email                  Role   RoleDescription
+--------    -----------  -----                  ----   ---------------
+zhangsan    张三          zhangsan@baidu.com     ADMIN  管理员
+lisi        李四          lisi@baidu.com         OWNER  写权限人员
+```
+
+## 返回字段说明
+
+| 字段 | 类型 | 说明 |
+|------|------|------|
+| `status` | int/string | 状态码，200 表示成功 |
+| `message` | string | 状态消息 |
+| `data` | array | 成员列表 |
+| `data[].userName` | string | 用户名 |
+| `data[].chineseName` | string | 中文名 |
+| `data[].email` | string | 邮箱 |
+| `data[].role` | string | 角色枚举值 |
+| `data[].roleDescription` | string | 角色中文描述 |
+
+## 错误处理
+
+| 错误信息 | 说明 | 解决方案 |
+|----------|------|----------|
+| `代码库不存在: xxx` | 代码库不存在 | 检查代码库名称是否正确 |
+| `没有操作权限！` | 无权查看成员列表 | 确认是否有该代码库的访问权限 |
+
+## 使用场景
+
+1. **查找评审人**：获取代码库成员作为评审人候选
+2. **权限审计**：查看代码库各角色的人员配置
+3. **自动化流程**：在脚本中获取管理员或负责人进行通知
+
+## 相关命令
+
+- `icode-cli api get_person_repo`: 查询个人代码库列表
+- `icode-cli api get_repo_branch`: 查询代码库分支列表
+- `icode-cli api add_reviewers`: 添加评审人

package/comate-engine/assets/skills/icode-comate/references/api/get_repo_reviews.md

@@ -0,0 +1,91 @@
+# get_repo_reviews - 查询代码库评审列表
+
+查询指定代码库的评审（CR）列表。
+
+## 命令格式
+
+```bash
+icode-cli api get_repo_reviews --repo <代码库名称> [--status <状态>] [--start-from <起始位置>] [--output <格式>]
+```
+
+## 参数说明
+
+| 参数 | 短参数 | 必填 | 默认值 | 说明 |
+|------|--------|------|--------|------|
+| `--repo` | `-r` | 是 | - | 代码库名称，三层目录形式 |
+| `--status` | `-s` | 否 | NEW | 评审状态：NEW/MERGED/ABANDONED |
+| `--start-from` | `-f` | 否 | 0 | 分页起始位置 |
+| `--output` | `-o` | 否 | json | 输出格式：json/yaml/table |
+
+## 使用示例
+
+```bash
+# 获取待处理的评审（NEW 状态）
+icode-cli api get_repo_reviews --repo baidu/icode/test
+
+# 获取已合并的评审
+icode-cli api get_repo_reviews --repo baidu/icode/test --status MERGED
+
+# 获取已放弃的评审
+icode-cli api get_repo_reviews -r baidu/icode/test -s ABANDONED
+
+# 分页查询
+icode-cli api get_repo_reviews -r baidu/icode/test --start-from 10
+
+# 表格格式输出
+icode-cli api get_repo_reviews -r baidu/icode/test -o table
+```
+
+## 返回数据
+
+### JSON 格式
+
+```json
+{
+  "status": "OK",
+  "message": "操作成功",
+  "data": {
+    "changes": [
+      {
+        "number": 12345,
+        "subject": "feat: add new feature",
+        "owner": {
+          "username": "zhangsan"
+        },
+        "project": "baidu/icode/test",
+        "branch": "master",
+        "updated": "2024-01-15 14:30:00"
+      }
+    ],
+    "hasMore": true,
+    "startFrom": 0
+  }
+}
+```
+
+### 字段说明
+
+| 字段 | 类型 | 说明 |
+|------|------|------|
+| `number` | int | 评审编号（Change Number） |
+| `subject` | string | 评审主题 |
+| `owner.username` | string | 提交者用户名 |
+| `project` | string | 所属项目 |
+| `branch` | string | 目标分支 |
+| `updated` | string | 最后更新时间 |
+| `hasMore` | bool | 是否有更多数据 |
+| `startFrom` | int | 当前起始位置 |
+
+## 评审状态说明
+
+| 状态 | 含义 |
+|------|------|
+| `NEW` | 待处理的评审，等待审核或合并 |
+| `MERGED` | 已合并的评审 |
+| `ABANDONED` | 已放弃的评审 |
+
+## 注意事项
+
+- 需要有代码库的访问权限
+- 返回结果按更新时间倒序排列
+- 使用 `hasMore` 字段判断是否有更多数据