NeuraLegion/bright-cli

# Bright CLI [Bright](https://brightsec.com) 是一个强大的动态应用程序和 API 安全测试 (DAST) 平台。凭借其高效的自动化和集成能力，Bright 允许开发者扫描多个目标，发现安全漏洞且无误报，获取每个发现的详细报告，并通过遵循修复指南快速修复安全问题。 该 NPM 允许您在本地计算机上安装 Bright 命令行界面 (CLI)。您可以使用 **Bright CLI** 直接从您的开发环境运行和管理安全扫描。此外，该容器包含一个预配置的 [Repeater（扫描代理）](https://docs.brightsec.com/docs/on-premises-repeater-local-agent)，使您能够安全地扫描本地目标，而无需将其暴露给互联网。 ##### 功能特性： - 轻松控制 Bright REST API。 - [Repeater 模式](https://docs.brightsec.com/docs/on-premises-repeater-local-agent)，允许 Bright 云引擎安全地连接到本地目标，将所有扫描请求作为出站流量进行拉取，而无需将目标暴露给互联网。 - 灵活的代理配置，允许您在内部和外部控制 CLI 请求。 - 连接到本地（内部）工单服务。例如，您可以启用 Bright 与本地 Jira 的集成，以便为检测到的每个安全漏洞自动创建工单。 - 将 Bright 集成到您的 CI pipeline 中。请参阅我们的[将 Bright 与 CI pipeline 集成的指南](https://docs.brightsec.com/docs/integrate-bright-with-your-cicd-pipeline)了解更多信息。 - 从配置文件运行命令。您可以从控制台运行 CLI 命令，或将它们保存为 JSON、XML、YML 或 JavaScript 文件。从预配置的文件运行 CLI 将简化后续的扫描过程。 ## 🔎 目录 - [快速入门](#-quick-start) - [完整文档](#-full-documentation) - [许可证](#-license) ## 🚀 快速入门 在您可以使用 **Bright CLI** 之前，请确保您具备以下条件： - 在 [Bright 应用程序](https://app.brightsec.com/)中拥有一个活跃用户 - 您的机器上已安装 Docker。 - 您拥有有效的[组织 API 密钥](https://docs.brightsec.com/docs/manage-your-organization#manage-organization-apicli-authentication-tokens)或[个人 API 密钥](https://docs.brightsec.com/docs/manage-your-personal-account#manage-your-personal-api-keys-authentication-tokens)，并且具有以下权限范围：`bot`、`scans:run` 和 `scans:read`。 - 您已经在 Bright 应用程序中注册（创建）了一个 Repeater，并复制了生成的 Repeater ID。有关如何注册 Repeater 的说明，请参见[此处](https://docs.brightsec.com/docs/manage-repeaters#create-a-new-repeater)。 - 您已复制要在其下运行扫描的 Bright Project ID。Project ID 是必需的。如果您没有任何自定义项目，请使用默认的 Project ID。 #### 1. 全局安装 Bright CLI ``` npm install @brightsec/cli -g ``` 您可以通过执行以下命令来确认安装是否成功： ``` bright-cli --version ``` 该命令应返回最新的 Bright CLI 版本。 #### 2. 激活 Repeater ``` 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 ``` 此命令将在云端初始化一个新的扫描引擎，该引擎将在 Repeater 模式下开始扫描目标。 我们建议您使用 `--smart` 选项来优化扫描覆盖范围和时间。这使您能够使用自动智能决策，例如参数跳过、检测阶段等。 #### 4. 查看扫描结果 您可以在 [Bright 应用程序](https://app.brightsec.com/scans)中或使用 [**Bright CLI** 轮询](https://docs.brightsec.com/docs/cli-checking-scan-status)命令来跟踪扫描状态。 ## 📚 完整文档 **Bright CLI** 的功能远不止于此！您可以在 [Bright 文档](https://docs.brightsec.com/docs/about-bright-cli)中找到包含使用示例的完整指南。 ## 📝 许可证 版权所有 © 2026 [Bright Security Inc.](https://brightsec.com/) 本项目基于 MIT 许可证授权 - 有关详细信息，请参阅 [LICENSE 文件](LICENSE)。

标签：API安全, DAST, JSON输出, MITM代理, 恶意软件分析, 自动化攻击, 请求拦截