Introduction

The Bright Command Line Interface (CLI) is a toolkit designed for ease of use when working with the Bright solutions as part of your CI/CD and automation tools. Using multiple Bright CLI commands and options, you can have full control over the entire scanning process, take advantage of CI integrations and achieve maximum flexibility for your automation needs.

Bright provides two ways of installing Bright CLI: in-app installation using a Quick start wizard, or manual installation for automation testing.

👍

Note:

Keep the Bright CLI updated for the best experience. Get the latest version for each major release and avoid errors.

In-app CLI installation

📘

Update Tip:

Before updating the Repeater, copy your settings and stop all running Repeater instances.

This page describes how to install Bright CLI via the in-app Quick start wizard. To install Bright CLI:

1. Open the wizard from any page of the Bright app: click → Quick-start wizard.
2. Select the Scan my own application (full installation guide) option and click Next
3. The information about general installation steps will appear. Click Next to move to the next step.
4. After learning the basic installation steps, click Next to start the installation.
5. Select the installation option from Docker, NPM and Windows installer and follow the instructions.
   
6. Make sure Bright CLI has been installed successfully by commands:
   1. Docker: docker run -it brightsec/cli -v
   2. NPM: bright-cli --version
   3. Windows: bright-cli --version
      The successful result for all options should be: v12.4.0.
7. If you have issues with installation, use the Troubleshooting section at the bottom of the wizard.
8. Optional. You can also install a Repeater using this wizard by clicking Next, if needed.

Step-by-step installation

Prerequisites

• Signing up / Signing in
• Minimal service requirements
• Getting an API key
• Getting a Repeater ID

Installation Guide

• Docker
• NPM (Linux / MacOS)
• Windows