cnb-api

CNB 平台交互命令,支持代码仓库、Issue、PR、CI、制品库读写等操作。

SKILL.md

GitHub

cnb-api

操作 CNB 平台资源的 CLI 工具。

快捷命令

issues:

  • cnb issues get — 获取详情
  • cnb issues list-comments — 获取评论列表
  • cnb issues comment --body 内容 — 评论
  • cnb issues close — 关闭
  • cnb issues open — 打开
  • cnb issues list-labels — 查看标签
  • cnb issues add-labels --labels bug --labels feature — 添加标签
  • cnb issues list-assignees — 查看处理人
  • cnb issues add-assignees --assignees username — 添加处理人
  • cnb issues get-imgs --img-path 图片路径 — 获取 issue 图片
  • cnb issues get-files --file-path 附件路径 — 获取 issue 附件

pulls:

  • cnb pulls get — 获取详情
  • cnb pulls list-files — 获取文件变更
  • cnb pulls list-commits — 获取提交记录
  • cnb pulls list-comments — 获取评论列表
  • cnb pulls comment --body 内容 — 评论
  • cnb pulls list-labels — 查看标签
  • cnb pulls add-labels --labels ready --labels approved — 添加标签
  • cnb pulls check-status — 查看 CI 状态
  • cnb pulls list-reviews — 查看评审列表
  • cnb pulls list-assignees — 查看处理人
  • cnb pulls get-ci-logs --sn 构建号(可选) — 获取 CI 失败日志
  • cnb pulls get-ci-timing --sn 构建号(可选) — 分析 CI 耗时瓶颈
  • cnb pulls get-imgs --img-path 图片路径 — 获取 PR 图片
  • cnb pulls get-files --file-path 附件路径 — 获取 PR 附件

注意事项:

  • 参数自动识别:快捷命令中的 Issue/PR 编号会自动从环境变量识别,无需额外传递。
  • 默认仅需摘要:默认会精简响应输出结果,添加 --verbose 输出完整数据。
  • 单引号传参:当 bash 的参数为多行文本时,使用单引号可减少防止命令注入攻击。
  • 快捷命令适用范围: 快捷命令只能操作当前仓库的当前 Issue/PR,跨仓库或跨编号操作请参考 更多 API。
  • 关于提及和召唤: 评论中直接 @npc 会召唤 npc 干活,如果只提及不召唤,应使用反引号包裹 @npc。

常用链接

在生成链接时请遵循下面的结构:

  • Issue: <host>/<slug>/-/issues/<number>
  • PR: <host>/<slug>/-/pulls/<number>

更多 API

  1. cnb --help 查看所有模块
  2. cnb <module> --help 查看模块下的工具列表
  3. cnb <module> <tool> --help 查看工具参数