Mac and Linux
This installs the Beam SDK and CLI in your Python environment.~/.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:Windows
You can install Beam on Windows using Windows Subsystem for Linux (WSL). These steps assume you’re starting fresh, but note that some systems (e.g. with Docker Desktop) may already have WSL distributions installed.1
Install WSL with Ubuntu 22.04
After installation, you may be prompted to set up a new user for the Ubuntu
environment:
wsl --install Ubuntu-22.04
2
Set WSL Version to 1 (Optional)
Only do this if you explicitly need WSL 1. Most users should stick with WSL
2:
wsl --set-version Ubuntu-22.04 1
3
Launch Ubuntu
This ensures you’re using the correct distribution (not docker-desktop or
others):
wsl -d Ubuntu-22.04
4
Install pip
sudo apt update && sudo apt install python3-pip -y
5
Install Beam SDK
python3 -m pip install beam-client
Upgrading
Once installed, you can upgrade the CLI by running:Uninstalling
The Python SDK can be uninstalled usingpip
: