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
cnb --help查看所有模块cnb <module> --help查看模块下的工具列表cnb <module> <tool> --help查看工具参数