CNB CLI

407 字约 1 分钟

概述

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

使用场景：想在命令行或脚本中操作 CNB 时使用——例如在流水线里批量创建 Issue、查询构建状态、操作制品，或让 NPC 借它调用平台能力，省去自行拼接 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 场景下自动注入。

探索可用命令

平台能力按模块组织，可用 -s / --short 查看当前仓库/事件下可用的快捷命令，也可通过 cnb --help 查看全部模块，并按 cnb <module> --help、 cnb <module> <tool> --help 逐层查看参数说明。