Skip to main content
Brightnode CLI is an open source command-line interface tool for managing your Brightnode resources remotely from your local machine. You can transfer files and data between your local system and Brightnode, execute code on remote Bnodes, and automate Bnode deployment workflows.

​
Install Brightnode CLI locally

Every Bnode you deploy comes preinstalled with the brightnodectl command and a Bnode-scoped API key. You can also install it on your local machine to manage your Bnodes remotely from your own system.

​
Step 1: Choose an installation method

Choose the installation method that matches your operating system.
  • macOS
  • Linux
  • Windows
  • Google Colab / Jupyter Notebook
Homebrew:
brew install Brightnode/brightnodectl/brightnodectl
ARM (Apple Silicon):
wget --quiet --show-progress https://github.com/Brightnode/brightnodectl/releases/download/v1.14.3/brightnodectl-darwin-arm64 -O brightnodectl && chmod +x brightnodectl && sudo mv brightnodectl /usr/local/bin/brightnodectl
AMD (Intel):
wget --quiet --show-progress https://github.com/Brightnode/brightnodectl/releases/download/v1.14.3/brightnodectl-darwin-amd64 -O brightnodectl && chmod +x brightnodectl && sudo mv brightnodectl /usr/local/bin/brightnodectl
This installs brightnodectl globally on your system, so you can run commands from any directory.

​
Step 2: Configure your API key

Before you can use brightnodectl locally, you must configure it with an API key. Run the following command to add your API key to brightnodectl, replacing YOUR_API_KEY with your API key: 
brightnodectl config --apiKey YOUR_API_KEY
After running the command, you should see a confirmation message similar to this: 
saved apiKey into config file: /Users/Brightnode/.Brightnode/config.toml

​
Step 3: Verify installation

To verify that brightnodectl installed successfully, run this command: 
brightnodectl version
You should see which version is installed: 
brightnodectl v1.14.4

​
Help and reference

Learn how to use Brightnode CLI commands by browsing the CLI reference using the sidebar to the left, or by running the help command: 
brightnodectl help
Learn more about a particular command by running: 
brightnodectl [command] help