Docs · संदर्भ

1vm command line

पूरा command reference। App में हर action का command है, क्योंकि दोनों front ends same core के clients हैं।

1vm app का wrapper नहीं, app 1vm का wrapper नहीं। दोनों same library के clients, इसीलिए जो click कर सकते वह script नहीं कर सकते impossible नहीं।

1vm <command> [options]
1vm --help
1vm snapshot --help

Machines

CommandWhat it does
listEvery machine, with state and address
create <name>Create a machine
info <vm>Everything about one machine
config <vm>Print the machine's definition file
get <vm> [key]Read one setting, or list all dotted keys
set <vm> <key> <value>Change a setting, live where supported
rm <vm> --forceDelete a machine and all its snapshots
clone <vm> <name>Linked clone (--full, --rekey-ssh)
archive <vm>Compress a stopped machine; run again to restore
rollback <vm> on|offDiscard all changes at power-off
duDisk usage across the library
logs <vm>Guest serial and host lifecycle logs

logs --source all|guest|host, --lines N और --follow लेता है।

Running

CommandWhat it does
start <vm>Run in the foreground; --detach to background it
stop <vm> [--force]Ask the guest to shut down, or pull the plug
pause / resume <vm>Freeze and unfreeze
suspend <vm>Save memory to disk and power off
eject <vm>Detach the installer once the guest boots on its own
console <vm>Open the guest display
configure <vm>Open the settings window
ip <vm>The guest address, bare, for scripting

start suspended machine resume; cold-boot --discard-saved-state। --hold-on-crash Windows bug-check screen पर reset away नहीं।

Snapshots

CommandWhat it does
snapshot take <vm> [name]Capture state
snapshot list <vm>The snapshot tree
snapshot restore <vm> <ref>Go back to a snapshot
snapshot rm <vm> <ref> [-r]Delete one, or a branch
reset <vm> --forceBack to the clean state
discard-session <vm> --forceBack to the snapshot this boot started from

Host

CommandWhat it does
capabilitiesWhat this Mac can and cannot do
doctorHost, entitlements, library, engines
guide <linux|macos|windows|omarchy>What a guest supports, and what it does not
guide rosettaRunning x86 binaries in a Linux guest
passport [<vm>]Capability matrix as markdown, or --json
macos images|downloadCached restore images, and Apple's latest
debug metrics <vm>Engine performance counters

Guest access

CommandWhat it does
wait-ready <vm>Poll SSH (Linux) or the guest agent (Windows)
exec <vm> -- <cmd…>Run one command in the guest
ssh <vm> [-- <cmd…>]Interactive SSH
ssh enable|disable <vm>Turn Mac-to-guest SSH on or off
ssh config --installAdd the Include line to ~/.ssh/config
ssh keys <vm>Machine key (--regenerate, --print-public)
ssh trust <vm>Pin the guest host key (--relearn)

wait-ready scripts reliable बनाता है — guest actually reachable होने तक block, merely running नहीं।

Automation

CommandWhat it does
task run -- <cmd…>Clone a golden image, wait, exec, dispose
template pin|unpin|listThe golden image library
golden capture <vm>Record a firmware and first-boot golden
agent gcDelete stopped machines an agent created
mcp serveMCP JSON-RPC on stdio
mcp install-snippet [host]Config JSON for Claude, Cursor or generic

Create options

OptionMeaning
--guest linux|macos|windowsGuest type, default linux
--hypervisor apple|nativeEngine. Windows defaults to native
--cpu <n>CPU count, default 4
--memory <size>e.g. 4GiB, default 4 GiB
--disk <size>e.g. 64GiB, default 64 GiB
--iso <path>Installer media, attached until ejected
--from-folder <path>A host folder as removable install media
--drivers <path>virtio-win ISO for a Windows guest
--restore-image <path|build>macOS restore image
--from <golden>Linked-clone a pinned golden (--full to copy)
--storage virtio-block|nvmeDisk controller; nvme for Windows
--network nat|host-only|bridged:en0Networking
--share tag:/host/path[:ro]Shared folder, repeatable
--clipboardShare the Mac clipboard both directions
--rosettax86 translation in a Linux guest
--agent-readyGenerate an SSH key and cloud-init for exec
--preset omarchyThe Omarchy recipe

Global options

--json machine-readable output, --quiet / -q errors only, --force / --yes confirmation skip, --detach start background, और --version.

Exit codes

CodeMeaning
0ok
1failed
2usage
3not found
4wrong state
5unsupported

Destructive commands exit 4 refuse unless --force। Interactive prompts nowhere, by design.