Install as NPM / Yarn

NPM includes a CLI that can be used to download and install software. npm is installed with Node.js.
This means that you have to install Node.js to get npm installed on your computer. Download Node.js from the official Node.js website.

📘

Note:

To ensure compatibility, install the latest NPM version in your local environment using versions 20, or 22. For information on how to update Node see Install or upgrade to version of Node required for Bright CLI.

Installation

1. Open your terminal.
2. Execute the following command:

npm install -g @brightsec/cli

yarn global add @brightsec/cli

To verify a successful installation, open a terminal window and execute the following command:

bright-cli --version

If the CLI's version information is displayed, the installation was successful.

Troubleshooting

For more details, see the troubleshooting article.