@brightsec/cli

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

Bright CLI is a CLI tool that can initialize, stop, poll and maintain scans in Bright solutions.

原始使用文档
文档目录4 节
  1. 🔎 Table of Contents
  2. 🚀 Quick Start
  3. 📚 Full Documentation
  4. 📝 License

Bright CLI

Bright is a powerful dynamic application & API security testing (DAST) platform. With its effective automation and integration capabilities, Bright allows developers to scan multiple targets, uncover security vulnerabilities without false positives, get detailed reports on every finding, and quickly fix security issues by following the remediation guidelines.

The NPM allows you to install the Bright Command Line Interface (CLI) on your machine. You can use the Bright CLI to run and manage security scans directly from your development environment. In addition, the container includes a preconfigured Repeater (scan proxy), which enables you to scan local targets securely, without exposing them to the Internet.

Features:
  • Easy control of the Bright REST API.
  • Repeater mode, which allows the Bright cloud engine to connect to local targets securely, pulling all scan requests as outbound traffic, without exposing the targets to the Internet.
  • Flexible proxy configuration, which allows you to control the CLI requests both internally and externally.
  • Connector to on-premises (local) ticketing services. For example, you can enable the Bright integration with on-premises Jira, for tickets to be automatically opened for each security vulnerability detected.
  • Integration of Bright with your CI pipelines. Please see our guide on integrating Bright with CI pipelines for more information.
  • Running commands from a configuration file. You can run the CLI commands from your console or save them as a JSON, XML, YML, or JavaScript file. Running the CLI from a pre-configured file will simplify further scanning.

🔎 Table of Contents

🚀 Quick Start

Before you can use Bright CLI make sure you have the following:

  • An active user in the Bright app
  • You have Docker installed on your machine (optional, required only if you run Bright CLI as a Docker container).
  • You have a valid organization API key or a personal API key with the following scopes: bot, scans:run and scans:read.
  • You have registered (created) a Repeater in the Bright app and copied the generated Repeater ID. For the instructions on how to register a Repeater, see here.
  • You have copied the Bright Project ID under which you want to run a scan. A Project ID is required. If you do not have any custom projects, use the Default Project ID.

1. Install Bright CLI globally

npm install @brightsec/cli -g

You can make sure the installation worked by executing the following command:

bright-cli --version

It should return the latest Bright CLI version.

2. Activate the Repeater

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

3. Start a new scan with a 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

This command will initialize a new scan engine on the cloud, which will start scanning the target in the Repeater mode.

We recommend that you use the --smart option to optimize the scan coverage and time. This enables you to use automatic smart decisions, such as parameter skipping, detection phases and so on.

4. Check out the scan results

You can follow the scan status in the Bright app or by using the Bright CLI polling command.

📚 Full Documentation

The Bright CLI can do so much more! You can find a full guide with the usage examples in the Bright docs.

📝 License

Copyright © 2026 Bright Security Inc.

This project is licensed under the MIT License - see the LICENSE file for details.

版本与发布记录

@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 is a CLI tool that can initialize, stop, poll and maintain scans in Bright solutions.

如何安装 @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 和提交记录判断。