Installation

​

Installation for Mac, Linux, and WSL

This installs the Beam executable in /usr/local/bin. It will also check if you have the Beam SDK Python Package installed, and install it if you don’t.

curl https://raw.githubusercontent.com/slai-labs/get-beam/main/get-beam.sh -sSfL | sh

Beam will also create a credentials file in ~/.beam/config. When you run beam configure, your API keys will be saved to this file.

You can maintain many different sets of credentials. Your default credentials will always live at the top of the file.

client_id=ND3ocyaSRceHTPmA32WcejFNjK2InHfT
client_secret=W4cT1oo5W9lmmNzghgOFCZi9QGsLqSzj

[staging]
client_id=ND3ocyaSRceHTPmA32WcejFNjK2InHfT
client_secret=W4cT1oo5W9lmmNzghgOFCZi9QGsLqSzj

[prod]
client_id=ND3ocyaSRceHTPmA32WcejFNjK2InHfT
client_secret=W4cT1oo5W9lmmNzghgOFCZi9QGsLqSzj

​

Windows Installation

Beam does not currently provide a native Windows build. In the meantime, you can install Beam using Windows Subsystem for Linux.

wsl —-install

​

Upgrading

Once installed, you can upgrade the CLI by running:

beam update

The Python SDK can be upgraded using pip:

python3 -m pip install --upgrade beam-sdk

​

Uninstalling

Beam’s binary is located in /usr/local/bin. You can delete it like this:

rm -rf /usr/local/bin/beam

The Python SDK can be uninstalled using pip:

python3 -m pip uninstall beam-sdk