Docs · 参考

1vm 命令行

完整命令参考。应用中的每个操作都有对应命令,因为两个前端都是同一核心的客户端。

1vm 不是应用的外壳,应用也不是 1vm 的外壳。两者都是同一库的客户端, 因此你在界面上能点的操作,脚本里都能做。

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 会恢复已挂起的机器;添加 --discard-saved-state 可改为冷启动。 --hold-on-crash 会在屏幕上保留 Windows 蓝屏/错误检查画面,而不是自动重置。

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 是让脚本可靠的关键——它会阻塞到 guest 真正可达,而不仅仅是 “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 用于机器可读输出,--quiet / -q 仅输出错误, --force / --yes 跳过确认,--detach 将 start 放到后台,以及 --version。

Exit codes

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

破坏性命令会以退出码 4 拒绝执行,除非你传入 --force。设计上没有任何 交互式提示。