@backplane-software/backplane-cli v1.0.2

backplane-cli

Backplane CLI client.

CLI Download & Installation

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

• Access the CLI User Guide from:

  https://getbackplane.io/docs/cli-userguide

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 | Operating System | 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

• Download bp.zip

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

• 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

• 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

• 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

Creating Binaries with pkg

Install pkg globally, then use the pkg command as follows:

npm install -g pkg

Create Mac OSX executable

pkg . --targets node16-macos-arm64 --output dist/mac/bp

Create Windows executable

pkg . --targets node16-win-arm64 --output dist/win/bp.exe

Create Linux executable

pkg . --targets node16-linux-arm64 --output dist/linux/bp

Support

Backplane is an Open Source Cloud Abstraction API and CLI and support is provided on a best endeavour basis.

Use the Slack Support Channel here