CLI Overview

Overview of the SmolVM command-line interface and installation

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:

Command	Description
smolvm cleanup	Clean stale SmolVM resources and VMs
smolvm doctor	Run host diagnostics for the selected backend
smolvm env	Manage environment variables on a running VM
smolvm ui	Start 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