These docs are for v1.1. Click to read the latest docs for v1.2.

Installation Guide

Suggest Edits

❗️

Deprecation notice:

This page is no longer available. To learn how to install Brith CLI, see the new article.

Each major Bright version release is accompanied by a correlating Bright CLI version that supports it. To enjoy the full functionality of the Bright CLI, we recommend that you periodically check for a new version of the CLI and reinstall it if needed. Thus, you will also avoid potential errors that may be caused by some critical changes issued with a release.

To install the Bright CLI for the first time and reinstall it to update the version, use the installation options given below. For release notes describing the changes in each new version, see here.

Prerequisites

  • Make sure you have the proper access rights to install components on your machine.
  • If you are already using the Bright CLI, but you have decided to use another installation option, please remove the initial Bright CLI service first to avoid possible conflicts of the installers.

Installation options

  • If you have already created an account, but have not got the Bright CLI installed, you can use one of the options below.

👍

Tip:

You can always return to the onboarding wizard and complete the initial setup, including installing the CLI and connecting the Repeater. For that, on the top right of the app, click , and then select Repeater setup wizard.

Docker

A preconfigured Repeater Docker version is available on https://hub.docker.com/r/neuralegion/repeater

🚧

Important:

There is a temporary issue when apps started from the Docker containers don't have access to ports of the physical PC where the Docker is started. So as a result the “CONNECTION_ERR” message appears because the Repeater is trying to link by the virtual port, where are no started apps.

There are two ways to interact with the Repeater, started from the Docker container, and target apps running on the local machine:

  • The target app is running in a Docker container
    In this way, an extra parameter --network host should be added. The whole command for launching the dockerized Repeater should be:
    docker run -it --network host neuralegion/repeater repeater --id YOUR_REPEATER_ID --token YOUR_TOKEN --cluster YOUR_CLUSTER.
  • The target app is running on a physical port of the local machine outside of the Docker container
    To avoid this situation, use thehttp://host.docker.internal target URL Instead of specifying http://localhost.

NPM

👍

Important:

Currently, Bright CLI works with v10+, and not higher than 18 (included), but we recommend using v14, v16, and v18.

To install the CLI using , run the following command:

npm install @brightsec/cli

📘

Note

The installation command may not be supported by some Linux distributions. In this case, you need to download the installation package from GitHub and deploy it manually.

More information can be found on our npm page.

❗️

When re-installing or updating the Bright-CLI:

  • Install as non-root (that creates insufficient rights issues)
  • Use either a Node version manager or custom NPM’s default directory
  • Some environments additionally require explicitly adding this flag: \--unsafe-perm

Windows installer

To install the CLI using a Windows installer:

  1. Go to the installation page.
  2. Under Assets, download the bright-cli.msi file.
  3. Follow the instructions given in the installation wizard.

Updated 9 months ago