Command Palette & Keys¶

Everything in vmup is reachable from the keyboard. Most actions have a single-key shortcut, and all of them are discoverable through the command palette.

The command palette¶

Press : anywhere in the main view to open the palette. Type to fuzzy-filter commands by name or description, use Left/Right to cycle category tabs, and Enter to run the highlighted command.

Typing filters the list live, and Left/Right jumps between categories — the loop below shows both:

──────────────────────────────────────────────────────────────────
  : ▎
──────────────────────────────────────────────────────────────────

  All Create & Connect Modify & Inspect Stop & Destroy Utility

> new-instance (n)        Create a new VM instance
  start-instance (s)      Start VM & connect tunnels
  connect (c)             Connect through SSH
  edit-instance (e)       Edit VM configuration
  info (i)                View VM info
  attach-disk (a)         Attach disk to VM
  stop-instance (x)       Stop VM
  destroy-instance (D)    Destroy VM
  filter (/)              Filter list
  ↓ more

↑/↓ navigate • ←/→ category • enter run • esc close

──────────────────────────────────────────────────────────────────
  : d▎
──────────────────────────────────────────────────────────────────

  All Create & Connect Modify & Inspect Stop & Destroy Utility

> edit-instance (e)       Edit VM configuration
  attach-disk (a)         Attach disk to VM
  detach-disk (d)         Detach disk from VM
  destroy-instance (D)    Destroy VM

↑/↓ navigate • ←/→ category • enter run • esc close

──────────────────────────────────────────────────────────────────
  : di▎
──────────────────────────────────────────────────────────────────

  All Create & Connect Modify & Inspect Stop & Destroy Utility

> edit-instance (e)       Edit VM configuration
  attach-disk (a)         Attach disk to VM
  detach-disk (d)         Detach disk from VM

↑/↓ navigate • ←/→ category • enter run • esc close

──────────────────────────────────────────────────────────────────
  : dis▎
──────────────────────────────────────────────────────────────────

  All Create & Connect Modify & Inspect Stop & Destroy Utility

> attach-disk (a)         Attach disk to VM
  detach-disk (d)         Detach disk from VM

↑/↓ navigate • ←/→ category • enter run • esc close

──────────────────────────────────────────────────────────────────
  : ▎
──────────────────────────────────────────────────────────────────

  All Create & Connect Modify & Inspect Stop & Destroy Utility

> new-instance (n)        Create a new VM instance
  start-instance (s)      Start VM & connect tunnels
  connect (c)             Connect through SSH

↑/↓ navigate • ←/→ category • enter run • esc close

──────────────────────────────────────────────────────────────────
  : ▎
──────────────────────────────────────────────────────────────────

  All Create & Connect Modify & Inspect Stop & Destroy Utility

> stop-instance (x)       Stop VM
  stop-all (X)            Stop all VMs & tunnels
  destroy-instance (D)    Destroy VM

↑/↓ navigate • ←/→ category • enter run • esc close

Create & Connect¶

Key	Command	Description
`N`	`new-instance`	Create a new VM instance (or a new disk on the Data Disks tab)
`S`	`start-instance`	Start a VM and connect its tunnels
`C`	`connect`	Open an SSH session (running VMs only)
`Shift`+`I`	`import-disk`	Import an existing disk (Data Disks tab)

Modify & Inspect¶

Key	Command	Description
`E`	`edit-instance`	Edit a VM's configuration / resize a disk
`I`	`info`	View VM details
`A`	`attach-disk`	Attach a disk to a VM
`D`	`detach-disk`	Detach a disk from a VM

Stop & Destroy¶

Key	Command	Description
`X`	`stop-instance`	Stop tunnels for a VM, optionally stop the VM
`Shift`+`X`	`stop-all`	Stop all tunnels and VMs
`Shift`+`D`	`destroy-instance`	Destroy a VM / delete a disk (two-step confirm)

Utility¶

Key	Command	Description
`/`	`filter`	Filter the list (free text or `property:value`)
`R`	`refresh`	Reload the list from GCP
`P`	`progress`	View the streaming log of the current or last operation
`Tab`	`switch-tab`	Toggle between Instances and Data Disks
`,`	`settings`	Open settings
`Q`	`quit`	Exit vmup

Keys	Action
`Up` / `Down` or `J` / `K`	Move through the list
`Left` / `Right` or `H` / `L`	Switch tabs
`Tab` / `Shift`+`Tab`	Next / previous tab
`1` / `2`	Jump straight to Instances / Data Disks
`?`	Toggle the help dialog
`Esc`	Back / cancel / close dialog
`Ctrl`+`C`	Cancel form, or quit
`Ctrl`+`D`	Force quit from any screen

The help dialog¶

Press ? on any list screen for an in-app cheat sheet of the current tab's bindings:

  ╭──────────────────────────────────────╮
  │ Commands                             │
  │                                      │
  │  ↑/↓/j/k     Navigate list           │
  │  ←/→/h/l     Switch tabs             │
  │  n           Create a new VM         │
  │  e           Edit VM configuration   │
  │  s           Start VM & connect      │
  │  c           Connect through SSH     │
  │  x           Stop VM                 │
  │  D           Destroy VM              │
  │  :           Command palette         │
  │  /           Filter list             │
  │  ⋮                                    │
  │  Press any key to close              │
  ╰──────────────────────────────────────╯

Tip

The in-app help dialog (?) always shows the bindings for the tab you're on — it's the quickest reference while working.