Use the terminal UI
This guide shows you how to manage your VMs from Pomme’s interactive terminal UI (TUI). The TUI lists your VMs and offers menus for the common lifecycle, security, and snapshot operations, so you don’t need to remember each command.
Before you begin
Section titled “Before you begin”- Install Pomme.
- Use an interactive terminal. The TUI doesn’t run when standard input or standard output is redirected.
Open the terminal UI
Section titled “Open the terminal UI”To open the TUI, run the following command:
pomme tuiTo open the TUI with a specific VM selected, pass its name:
pomme tui VM_NAMEReplace VM_NAME with the name of the VM.
The TUI opens on the VM dashboard, which lists the VMs that Pomme manages with their run state and boot mode.
Move around the dashboard
Section titled “Move around the dashboard”The dashboard accepts the following keys:
| Key | Action |
|---|---|
Up arrow, Down arrow, k, j |
Move the selection. |
Return |
Open the actions menu for the selected VM. |
r |
Refresh the VM list. |
c |
Create a VM. |
d |
Delete the selected VM. |
q, Esc |
Quit the TUI. |
Run an action on a VM
Section titled “Run an action on a VM”To run an action on a VM, do the following:
-
On the dashboard, select the VM and press
Return. -
Select an action and press
Return, or press the action’s shortcut key. The following table lists the actions:Action Shortcut Description Start Normal nStart or resume normal macOS. Boot Recovery bStart macOS Recovery. Stop xStop the VM. Pause pPause the running VM. Resume rResume the paused VM. Status sShow the VM status. Inspect iShow detailed inspection output. Health hShow the VM health details. Security gOpen the SIP and AMFI menu. Snapshots vOpen the snapshot menu. Destroy dDelete the VM after you type its name. Back Return to the dashboard. -
Wait for the action to finish. While an operation runs, you can’t cancel it. When it finishes, press
Return,q, orEscto go back, or pressrto go back and refresh.
If you start a VM in a boot mode that differs from the mode it’s running in, the TUI asks you to confirm that it can stop and restart the VM.
In any menu, use the arrow keys or j and k to move, and press q or Esc
to go back.
Change SIP or AMFI
Section titled “Change SIP or AMFI”The Security menu shows, turns on, and turns off System Integrity
Protection (SIP) and Apple Mobile File Integrity (AMFI). Its actions run the
same workflows as the pomme sip and pomme amfi commands. Before you use them, read
Change SIP and AMFI.
Manage snapshots
Section titled “Manage snapshots”The Snapshots menu lists the VM’s snapshots, newest first. From this menu, you can create a snapshot, refresh the list, or select a snapshot to restore or delete it. Restoring or deleting a snapshot asks you to type a confirmation. For details about how snapshots work, see Save and restore snapshots.
Create a VM from the terminal UI
Section titled “Create a VM from the terminal UI”To create a VM from the TUI, do the following:
- On the dashboard, press
c. - Enter a name for the VM. Use 1 to 64 characters: ASCII letters, numbers, periods, underscores, and hyphens.
- Choose a restore source:
- Latest IPSW: the latest signed macOS version.
- Version or Build: a macOS version or build that you enter, with an optional Mac model override.
- Local Restore Image: the path to a restore image (IPSW) on the host.
- Enter a disk size and memory size, or accept the defaults of
60GBand8GB. - Choose the state after installation: Do Not Boot, Boot Normal, or Boot Recovery.
The TUI doesn’t create VMs from templates or config files. For those options,
use pomme create. For details, see Create a VM.
Delete a VM from the terminal UI
Section titled “Delete a VM from the terminal UI”To delete a VM, do the following:
- On the dashboard, select the VM and press
d. - Read the bundle path that the TUI shows.
- Type the VM name to confirm, and press
Return.
You can’t undo a deletion.