VS Code Extension

The BeamCLI extension integrates terminal sharing directly into VS Code, Cursor, and Antigravity.

Installation

From VS Code Marketplace (coming soon)

Marketplace listing is in progress. Use the VSIX method below until it is published.

Open VS Code
Press Ctrl+Shift+X (Windows/Linux) or Cmd+Shift+X (macOS)
Search for “BeamCLI”
Click Install

From VSIX File

Download the .vsix file from releases
In VS Code, press Ctrl+Shift+P → “Extensions: Install from VSIX”
Select the downloaded file

Getting Started

Open the BeamCLI Terminal

The BeamCLI Terminal panel appears in the bottom panel area by default.

Open it via:

View menu → BeamCLI Terminal
Command Palette (Ctrl+Shift+P) → “Beam: Focus Terminal”

Using as a Normal Terminal

The BeamCLI Terminal works like any other terminal:

Run commands
Navigate directories
Use your shell (bash, zsh, PowerShell, etc.)

No network connection is needed until you start sharing.

Click the “BeamCLI” button in the terminal toolbar
Sign in when prompted
Choose permission level:
- Read-only: Viewers can only watch
- Interactive: Viewers can type
A session code will be displayed

Share the 5-character code with your collaborators:

Direct message
Email
Or share the URL: https://beamcli.com/app?code=XXXXX

Click the “Stop” button or close the terminal to end the session.

Features

Permission Control

Permission	Viewers Can	Best For
Read-only	Watch only	Demos, teaching
Interactive	Watch and type	Pair programming

Session Status

The status bar shows:

Not sharing: No active session
Sharing (code): Active session with code
Viewers: N: Number of connected viewers

Multiple Terminals

You can have multiple BeamCLI Terminal instances. Each has independent sharing state.

Settings

Access settings via:

File → Preferences → Settings → Extensions → BeamCLI
Or search for “beam” in settings

Available Settings

Setting	Description	Default
`beam.defaultServer`	WebSocket server URL	Production
`beam.defaultPermission`	Default permission level	`read`
`beam.showStatusBar`	Show status bar item	`true`

Commands

Open the Command Palette (Ctrl+Shift+P) and type “Beam”:

Command	Description
`Beam: Focus Terminal`	Open and focus the BeamCLI Terminal
`Beam: Start Sharing`	Start a sharing session
`Beam: Stop Sharing`	End the current session
`Beam: Copy Session Code`	Copy the active session code
`Beam: Sign Out`	Sign out of your account

Keyboard Shortcuts

Action	Windows/Linux	macOS
Focus terminal	`Ctrl+Shift+T`	`Cmd+Shift+T`
Start sharing	Configure in shortcuts	Configure in shortcuts

To customize shortcuts:

File → Preferences → Keyboard Shortcuts
Search for “beam”
Assign your preferred shortcuts

Compatibility

VS Code Versions

VS Code 1.80.0 or later
Cursor (any version)
Antigravity (any version)
VSCodium

Operating Systems

Windows 10/11
macOS 10.15+
Linux (most distributions)

Shells

The extension works with your default shell:

bash, zsh, fish
PowerShell
cmd.exe
Any shell VS Code supports

Troubleshooting

Terminal Not Appearing

Check the extension is installed and enabled
Restart VS Code
Check View → BeamCLI Terminal

Check your internet connection
View the Output panel (View → Output → BeamCLI)
Try signing out and back in

“node-pty” Errors

If you see node-pty errors:

# In the extension directory
npx @electron/rebuild -w node-pty -v <electron-version>

Replace <electron-version> with your VS Code’s Electron version (check Help → About).

Extension Crashes

Disable other terminal extensions temporarily
Check the Developer Tools console (Help → Toggle Developer Tools)
Report issues on GitHub

Security Notes

Your terminal data is not sent until you click “BeamCLI”
All shared data is end-to-end encrypted
Sessions automatically end when you stop sharing
Credentials are stored in VS Code’s secure storage