Skip to main content

​
Overview

The SmolVM CLI provides a set of commands for managing VMs, diagnosing system requirements, and running the dashboard UI. The main entrypoint is the smolvm command.

​
Installation

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

​
Available Commands

The smolvm CLI provides the following commands:
CommandDescription
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

​
Getting Help

Display help for the main command: 
smolvm --help
Display help for a specific subcommand: 
smolvm cleanup --help
smolvm doctor --help
smolvm env --help
smolvm ui --help

​
Script Aliases

The following script aliases are also available:
  • smolvm-cleanup: Equivalent to smolvm cleanup (standalone cleanup command)

​
Next Steps

Cleanup Command

Clean up stale VMs and resources

Doctor Command

Diagnose system requirements

Environment Commands

Manage VM environment variables

UI Command

Launch the dashboard interface
Last modified on March 3, 2026