Skip to main content

​
CLI for Containers and Coding Agents

Install the CLI in an isolated tool environment with uv:
beam login opens your browser to sign in or create an account. On a remote machine, use beam login --browserless.
To import beam in Python, install the SDK in your project environment too.

​
Python SDK and CLI

Install the SDK and CLI in your project’s virtual environment:
For a project managed by uv, use uv add beam-client, then uv run beam login and uv run python app.py.

​
TypeScript and JavaScript SDK

Set beamOpts.token to an API token. See the TypeScript reference. The CLI is installed separately.

​
Homebrew

You can install the CLI with Homebrew:

​
Windows

Use Windows Subsystem for Linux with Ubuntu. In PowerShell, install WSL with wsl --install -d Ubuntu, then open Ubuntu and install Python:
Follow the Python SDK steps above inside Ubuntu. Use beam login --browserless if the browser does not open from WSL.

​
Upgrade or Uninstall

Use the same package manager and environment you used to install: Check your version with beam --version or troubleshoot with beam doctor. See authentication for CI and multiple workspaces.