​
Mac and Linux

This installs the Beam SDK and CLI in your Python environment.

pip install beam-client

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

​
Homebrew

You can install the CLI separately from the SDK using Homebrew:

brew tap beam-cloud/beam

brew install beam

​
Windows

You can install Beam on Windows using Windows Subsystem for Linux (WSL).

1

Install WSL

wsl —-install
2

Install the required WSL Version

wsl install Ubuntu-22.04 wsl -d Ubuntu-22.04

3

Set the default WSL Version

wsl --set-version Ubuntu-22.04 1

4

Install pip

sudo apt update && sudo apt install python3-pip -y

5

Install Beam SDK

bash pip install beam-client

​
Upgrading

Once installed, you can upgrade the CLI by running:

python3 -m pip install --upgrade beam-client

​
Uninstalling

The Python SDK can be uninstalled using pip:

python3 -m pip uninstall beam-client