Install and Sign In
If you ran the install command on the introduction page, the CLI is installed and you’re signed in. Skip to Create a VM.beam whoami to check your workspace.
Create a VM
beam vm desktop devbox. Type exit to leave SSH. The VM keeps running.
A running VM accrues usage until you stop, pause, or remove it, or until an idle timeout puts it to sleep. You’ll set one below.
Put a Project on It
Sync a local directory into/workspace, then run commands there:
sync uploads the directory’s contents and needs rsync installed locally. Add --watch to keep uploading as you edit.
The whole root disk persists. Files, apt packages, virtual environments, and systemd units are still there after beam vm stop devbox and beam vm start devbox.
Share a Private URL
Start a web server, publish its port as protected, and open it in your browser:--expires-in 10m for a shorter window. Use --public instead of --protected to serve without authentication.
See networking for traffic tokens, private port forwarding, and outbound rules.
Sleep When Idle
Fork It
Hand It to an Agent
Coding agents can do everything above through the Beam MCP server. Runbeam setup agent to connect Cursor, Claude Code, Codex, Windsurf, or Claude Desktop, then ask your agent to work on devbox.
The VM also comes with the Claude Code and Codex CLIs, so an agent can run on the VM itself. See coding agents for credentials and background sessions.
To drive the VM from your own code, connect to it by name:
- Python
- JavaScript
Install
beam-client in your project’s environment with python -m pip install --upgrade beam-client, then run:context="default" uses the sign-in from beam login.Clean Up
beam vm start devbox boots it again. beam vm rm devbox deletes the VM and its root disk.
Next Steps
Desktop
Screenshot, click, and type in a Linux desktop from Python or JavaScript.
Secrets
Keep real keys off the VM and scope them to approved hosts.
Storage and Snapshots
Save restore points and launch new VMs from templates.
Sandboxes
Run agent code in disposable environments, with GPUs.