CNB CLI

408 字约 1 分钟

概述

CNB CLI 是 CNB 平台 OpenAPI 的命令行工具，通过一条 cnb 命令即可访问 CNB 平台的全部 OpenAPI 能力，覆盖代码托管、构建、制品库、组织成员、知识库等场景。

npm 包：@cnbcool/cnb-cli
Docker 镜像：cnbcool/cnb-cli

安装与使用

本地安装（需要 Node.js LTS）

npm install -g @cnbcool/cnb-cli
cnb --help

使用 Docker（无需安装）

docker run --rm -v $(pwd):$(pwd) -w $(pwd) cnbcool/cnb-cli cnb users get-user-info

在 `.cnb.yml` 流水线中使用

以下示例在 main 分支收到 push 事件时执行，CNB_TOKEN 由流水线自动注入，无需登录：

.cnb.yml
main:
  push:
    - docker:
        image: cnbcool/cnb-cli
      stages:
        - name: get-user-info
          script: cnb users get-user-info

鉴权

本地终端推荐使用 OAuth2 设备授权登录：

cnb login
cnb status
cnb logout

也可通过环境变量 CNB_TOKEN 提供令牌，CI 场景下会自动注入。

命令示例

cnb issues list-issues --repo my-org/my-repo
cnb issues create-issue --repo my-org/my-repo --title "Bug" --body "复现步骤..."
cnb pulls merge-pull --repo my-org/my-repo --number 42 --merge-style squash
cnb build start-build --repo my-org/my-repo --branch main

当 CI 由 Issue 或 PR 事件触发时，CNB 会注入 CNB_REPO_SLUG、CNB_ISSUE_IID、CNB_PULL_REQUEST_IID 等环境变量。 CLI 快捷命令会自动读取这些变量作为 --repo / --number 参数，无需手动传入：

cnb issues get
cnb issues comment --body "..."
cnb pulls get
cnb pulls check-status