@brightsec/cli

中文文档
13.17.2发布于 2026/11/16MIT构建来源已验证近 30 天下载 3840

Bright CLI是一个CLI工具,可以在Bright解决方案中初始化,停止,民意调查和维护扫描.

中文使用文档
文档目录4 节
  1. 目录
  2. QQ 快速启动
  3. * 完整文档
  4. 许可证

亮亮的 CLI

亮点 是一个强大的动态应用程序和API安全测试(DAST)平台. 凭借其有效的自动化和集成能力,Bright允许开发人员扫描多个目标,在不出现假阳性的情况下发现安全弱点,获得关于每项发现的详细报告,并遵循补救准则来快速解决安全问题.

国家防范机制允许您在您的机器上安装亮指令行接口(CLI). 你可以用这个 亮亮的 CLI 直接从您的开发环境运行和管理安全扫描。 此外,集装箱包括一个预配置的 中继器(扫描代理),这使得你能够安全地扫描局部目标,而不会暴露于互联网.

特征 :
  • 轻而易举地控制"明亮的REST API".
  • 转发模式,这使得"亮云"引擎能够安全地连接到本地目标,将所有扫描请求都拉出流量,而不将目标暴露在互联网上.
  • 灵活的代理配置,允许您在内部和外部控制CLI请求.
  • 连接站点(地)售票服务. 例如,您可以让Bright 与 permises Jira 的集成,为检测到的每个安全弱点自动打开门票.
  • 把Bright和你的CI管道融合起来 请看我们的 bright和CI管道集成指南 更多信息.
  • 从配置文件运行命令 。 您可以从控制台运行 CLI 命令, 或者把它们保存为 JSON, XML, YML, 或者 JavaScript 文件 。 从预配置文件运行 CLI 会进一步简化扫描.

目录

QQ 快速启动

在你用之前,你用不着 亮亮的 CLI 请确保您有以下内容:

  • 活动用户在 亮相应用程序
  • 您在您的机器上安装了 Docker( 可选的, 只有在您以 Docker 容器的形式运行 Bright CLI 时才需要) .
  • 你有一个有效的 aPI 键 或一个 个人 API 密钥 范围如下: bot, (中文(简体) ), scans:run 财务报告和审定财务报表 scans:read。 。 。 .
  • 您在 Bright app 中注册了( 创建了) 转发器, 并复制了生成的转发器 ID 。 关于如何注册转发器的说明,见 这里。 。 。 .
  • 您复制了您想要扫描的 Bright 工程 ID 。 需要一个项目ID。 如果没有自定义工程,请使用默认工程ID.

1. 在全球安装亮度CLI

npm install @brightsec/cli -g

您可以通过执行以下命令来确保安装工作:

bright-cli --version

它应该返回最新的Bright CLI版本.

2. 启动中继器

bright-cli repeater \
  --token {TOKEN} \
  --id {ID}

3. 用Crawler开始新的扫描

bright-cli scan:run \
  --token {TOKEN} \
  --repeater {ID} \
  --name "Bright scan" \
  --crawler {TARGET_URL} \
  --project {PROJECT_ID}  \ #If you do not have any custom projects, specify the Default Project ID.
  --smart

此命令会初始化云上的新扫描引擎,它会以中继器模式开始扫描目标.

我们建议您使用 --smart 选项以优化扫描覆盖和时间。 这使得您能够使用自动智能决定,例如参数跳过,检测相等.

4. 检查扫描结果

您可以在 亮相应用程序 或使用 亮亮的 CLI 投票 命令.

* 完整文档

这个 亮亮的 CLI 还能做这么多事! 您可以在 亮文件。 。 。 .

许可证

版权 2026 光明安全股份有限公司.

这个项目根据麻省理工学院许可证颁发——见 自由文件 详细情况.

版本与发布记录

@brightsec/cli 共发布 269 个版本,首次发布于 2023/03/10;过去 12 个月发布了 105 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
13.17.2latest2026/11/16今天
13.17.2-next.4next2026/11/16今天
13.17.2-next.32026/10/2819 天前
13.17.2-next.22026/10/2720 天前
13.17.2-next.12026/10/2324 天前
13.17.12026/10/161 个月前

其他发布通道:alpha → 11.0.0-alpha.3,next → 13.17.2-next.4。

关于 @brightsec/cli 的常见问题

@brightsec/cli 是什么?

Bright CLI是一个CLI工具,可以在Bright解决方案中初始化,停止,民意调查和维护扫描.

如何安装 @brightsec/cli?

在项目目录运行 npm install @brightsec/cli,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 bright-cli,可以用 npx bright-cli 直接运行。

@brightsec/cli 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/brightsec__cli 是否存在。

@brightsec/cli 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=24 <=26。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@brightsec/cli 可以商用吗?

@brightsec/cli 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@brightsec/cli 的下载量有多少?

根据 npm 官方下载统计,@brightsec/cli 在 2026/10/09 – 2026/11/07 这 30 天内被下载 3,840 次,日均约 128 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@brightsec/cli 还在维护吗?

最新版本 13.17.2 发布于 2026/11/16(今天);至今共发布 269 个版本,其中过去 12 个月发布了 105 个;首次发布于 2023/03/10。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。