Skip to main content
The SmolVM CLI lets you manage sandboxes, start browser sessions, and inspect the runtime from your terminal. Use it when you want to work with SmolVM outside of Python code.

​
Installation

Install SmolVM via pip: 
pip install smolvm
For dashboard support, install with the dashboard extra: 
pip install 'smolvm[dashboard]'

​
Available commands

CommandDescription
smolvm setupOne-time host setup (installs runtime dependencies)
smolvm createCreate an SSH-ready VM (name is optional)
smolvm listList VMs and their current status
smolvm stopStop a running VM and release its resources
smolvm sshSSH into an existing VM (auto-starts if stopped)
smolvm browserManage disposable browser sessions
smolvm snapshotCreate, restore, list, and delete VM snapshots
smolvm cleanupClean stale SmolVM resources and VMs
smolvm doctorRun host diagnostics for the selected backend
smolvm envManage environment variables on a running VM
smolvm uiStart the SmolVM dashboard UI server

​
Snapshot commands

The smolvm snapshot command has its own subcommands for managing Firecracker VM snapshots:
CommandDescription
smolvm snapshot createCreate a full snapshot from a running or paused VM
smolvm snapshot restoreRestore a snapshot back into its original VM
smolvm snapshot listList all snapshots
smolvm snapshot deleteDelete a snapshot and its files
Create a snapshot and restore it later: 
smolvm snapshot create my-vm --snapshot-id my-checkpoint
smolvm snapshot restore my-checkpoint --resume

​
Browser commands

The smolvm browser command has its own subcommands for managing disposable browser sessions:
CommandDescription
smolvm browser startCreate and start a browser session
smolvm browser listList browser sessions
smolvm browser stopStop and delete a browser session
smolvm browser openOpen a live session in your default browser
smolvm browser logsPrint browser session logs
Start a disposable browser session with live view: 
smolvm browser start --live --json
The JSON response includes the session_id plus local browser URLs. Use the session ID with other browser commands: 
smolvm browser list
smolvm browser open <session_id>
smolvm browser stop <session_id>

​
Getting help

Display help for the main command: 
smolvm --help
Display help for a specific subcommand: 
smolvm create --help
smolvm browser start --help

​
Script aliases

  • smolvm-cleanup: Equivalent to smolvm cleanup (standalone cleanup command)

​
Next steps

List VMs

View running VMs and their status

Create a VM

Spin up an SSH-ready VM

SSH into a VM

Connect to a VM via SSH

Cleanup

Clean up stale VMs and resources

Doctor

Diagnose system requirements

Environment

Manage VM environment variables

Snapshots

Save and restore VM state

Dashboard UI

Launch the dashboard interface
Last modified on April 5, 2026