Skip to main content

​
Get Started

This installs or upgrades the CLI, signs you in through the browser, installs the Beam skill, and registers the Beam MCP server with each supported agent it finds. It doesn’t create any resources. Restart your agent after setup. Cursor, Claude Code, Codex, Windsurf, and Claude Desktop are supported.

​
Create a First VM

To also create a VM for your agent, add --vm:
Setup checks credits, asks before creating a VM with 4 CPUs, 8 GiB of RAM, a 50 GiB disk, and a browser desktop, and then verifies that commands run in it. If funding is needed, complete checkout in the browser; setup resumes when credits arrive. Running the command again resumes the same VM. Add --no-desktop to skip the desktop, --name NAME to name the VM, or --yes to approve creation without a prompt. With the CLI already installed, beam setup vm does the same. Other starting points use the same sh -s -- form:

​
Configure an Existing Installation

Omit --client to detect installed clients. Use --context NAME for another workspace profile. For remote clients, connect directly with OAuth.