brightsec/cli repository overview

⁠Bright CLI

Bright CLI is a Command Line Interface (CLI⁠) tool for Bright's solutions⁠. You can use Bright CLI for full control over scans such as: initialize, stop, poll, maintain and more. In addition, Bright CLI can serve as a Repeater⁠ to scan local targets, without exposing them to the internet.

⁠Features:

• Supports official API
• Configurable using JSON / XML / YML / JS formats
• Can generate real interaction data (.har files) from mock interactions (Unit Tests), more info about NexMock here⁠
• Can serve as a Repeater⁠ for communication from the cloud to a local target

⁠🔎 Table of Contents

• Quick Start⁠
• Documentation⁠
• License⁠

⁠🚀 Quick Start

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

• An active user in the Bright app⁠
• A valid TOKEN
  • For the quick start these scopes are required: bot, scans:run and scans:read
  • More info about setting up an API key⁠
• An active ID
  • More info about Setting up a New Repeater⁠

⁠1. Install Bright CLI globally

npm install @brightsec/cli -g

You can validate the installation by going to the directory of your project and running the command:

bright-cli -h

This will show you a list of possible commands for Bright CLI, for a full list go here⁠

⁠2. Activate the Repeater

bright-cli repeater \
  --token {TOKEN} \
  --id {ID} \
  --bus amqps://amq.app.brightsec.com:5672

⁠3. Start a new scan with a Crawler

bright-cli scan:run \
  --token {TOKEN} \
  --repeater {ID} \
  --name "My First Scan" \
  --crawler https://www.example.com \
  --smart

This command will initialize a new scan engine in the cloud, which will start scanning the target via the local Repeater⁠.

⁠4. Check out the scan results

You can follow the scan status here: https://app.brightsec.com/scans⁠, or by using the Bright CLI polling⁠ command.

⁠📚 Full Documentation

Bright CLI can do so much more! A full documentation with usage examples is available on Bright's knowledgebase⁠

⁠📝 License

Copyright © 2021 Bright⁠.

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