CLI Installation

The Backplane Command Line Interface is developed with full parity with the Open API (aka Swagger) specification. Enabling Cloud engineers to integrate and automate as quickly as possible.

CLI Download & Installation

Download the Backplane CLI either from NPM or a pre-compiled binary for your OS.

Binaries

The easiest way to get started is to download the Backplane CLI executable, available as a ZIP archive containing bp executable and bp.sha256

OS	Download Link
Mac OSX	ARM64
Windows	x64
Linux	x64

Validating download integrity with SHASUM (Mac OSX & Linux)

shasum -a 256 -c bp.sha256
bp: OK

Installation Instructions

Mac OS

• Download bp.zip

  

  If the Web Browser alerts that the bp.zip file is suspicious, allow the file

• Extract bp.zip by double-clicking on the file

Before you can run ‘bp’ for the first time, ‘Right-click’ on the extracted ‘bp’ file and select Open from the context menu and Accept any security warning that appears.

• Open Terminal and from the directory bp has been extracted to, run the following command to move the file to your executable path:

  sudo mv bp /usr/local/bin/
  

• To verify that bp is successfully installed, run:

  bp --version
  1.0.0
  

Windows

• Download bp.zip

• Extract contents to folder

  expand-archive bp.zip c:\backplane
  

• Add bp.exe file system environment path

  $newPath = "C:\backplane"
  $currentPath = [System.Environment]::GetEnvironmentVariable("Path", "Machine")
  [System.Environment]::SetEnvironmentVariable("Path", "$currentPath;$newPath", "Machine")
  

• Verify installation - To check if bp.exe is successfully installed, run:

  bp --version
  1.0.0
  

Linux

• Download bp.zip

• Extract executable from ZIP file.

  sudo apt install unzip
  unzip bp.zip
  

• Move the file to your executable path

  sudo mv ./bp /usr/local/bin/bp
  

• Verify installation to check that bp is successfully installed, run:

  bp --version
  1.0.0
  

NPM

• Install Node.JS on your system and then from a terminal window, initialise an NPM project.

  mkdir backplane-cli
  cd backplane-api
  npm init -y
  npm i @backplane-software/backplane-cli -g
  

• Once the CLI has been installed, within the directory containing the package.json, run the npm link command to make the file executable.

  npm link
  

  Use the below command to verify installation has been successful:

  $ bp -V
  v0.11.0