Skip to content

Run a virtual iPhone on an Apple Silicon Mac.

Swift
3.5 KB
Raw Blame

vphone Manual

New to vphone? Read Overview, then follow Quick Start.

Get Started

Page Use it for
Overview What vphone is, what it needs, and the programs it ships
Quick Start Your first VM with Launchpad, or with a coding agent
Host Setup SIP, AMFI and Research Guests settings on the Mac
Downloads Notarized Launchpad versions and matching VPhone.bundle versions

Machines

Page Use it for
Create and Run Creating, starting and stopping a VM from Terminal
Boot ROMs Switching between OpenAVB/OpenSEP and Apple's ROMs
Automation API The optional local HTTP and WebSocket interface
Device Name and Clock What the guest takes from the VM name and the Mac's clock
Package Environment Installing and removing a package manager in the guest

Firmware and Devices

Page Use it for
Compatibility Verified iPhone and cloudOS firmware pairs
Firmware Preparation GPU driver restore, kernelcache mixes for newer cloudOS
Other iPhone Models Running iOS from another iPhone model's IPSW
iPadOS Guests Running iPadOS instead of iOS

Storage and Backups

Page Use it for
Library and Backups Where VMs and caches live, clones and exports
Snapshots Saving a stopped VM's disk and reverting to it
Templates Reusing one restore for many VMs
Building Templates Turning a VM into a template and finding templates
Sharing Disk Space vm rebase for VMs restored separately
Create Many Machines vm create-bulk from a plist
Shader Caches Persistent shader caches on an existing VM

Networking

Page Use it for
Network Modes Choosing a mode, unplugging a running VM
Tunnel Mode A Mac behind a VPN or proxy app
MAC and IP Addresses The saved MAC, old leases, fixed addresses
Port Forwarding Carrying a port on the Mac into the guest
Names on the Network The guest's .local name and the Mac's name in the guest
Machines Reaching Each Other nat machines on one shared network

Launchpad and Bundles

Page Use it for
Launchpad Command Line Driving Launchpad with vphone-launchpad-cli
Core Bundles and Local Builds Binding machines to bundles, testing local builds
Bundle Integration What VPhone.bundle contains and how an app uses it

Help

Page Use it for
Troubleshooting Launch refusals, restore failures, guest problems

Implementation notes, patch records and the full API reference are in the research notes, in English only.