Installation
Beam consists of a CLI executable and a Python package.
Installation for Mac and Linux
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.
Installation for Windows
You can install Beam on Windows using Windows Subsystem for Linux (WSL).
Install WSL
wsl —-install
Install the required WSL Version
wsl install Ubuntu-22.04 wsl -d Ubuntu-22.04
Set the default WSL Version
wsl --set-version Ubuntu-22.04 1
Install pip
sudo apt update && sudo apt install python3-pip -y
Install Beam CLI
curl https://raw.githubusercontent.com/slai-labs/get-beam/main/get-beam.sh -sSfL | sh
Configure Beam
beam configure
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
Was this page helpful?