CLI Commands

CLI Overview

heyvm is the user-facing command-line tool. It doubles as a TUI, a local HTTP API server, and an MCP server.

heyvm <command> [options]
heyvm --help

Global flags

Flag Purpose
-V, --version Print version
--api Run the local HTTP API server
--port <u16> API port (default 3000)
--msb-host <host> microsandbox server host
--dev Use local dev URLs
--cloud-url <url> Override the cloud URL
--auth-url <url> Override the auth URL
--debug Verbose logging
--mcp Run as an MCP server over stdio
--upgrade / --update Self-update (--pre for prereleases)

Command groups

Area Commands
Sandboxes create, start, stop, restart, get, rm, fork, list, list-inactive, prune, checkpoint, snapshot, resize, edit-ttl, edit-start-command, update, wait-for, backends, transfer, exec, run, sh, run-host, logs, wt
Images & Volumes pull, images, mvm, archive, archive-dir, mount, mount-add, volume, sync, export
Networking & Sharing bind, proxy, connect, ssh, ssh-proxy, share, expose, unexpose, display, port-forward, network, webhook
Databases db / sqlite
Auth login, session reset
Editor integration ide, install-skills, install-claude-plugin, install-codex-plugin, install-opencode, install-amp-plugin
System system check-gpu, macos-bootstrap

Run heyvm <command> --help to see the flags for any individual command.