`multipass get` command


Get

The multipass get command retrieves the value of a single setting specified by a “key” argument. This key takes the form of a dot-separated path in a hierarchical settings tree:

$ multipass get client.gui.autostart
true

The following keys are currently available:

  • client.apps.windows-terminal.profiles (Windows only)
    • A string describing which profiles Multipass should enable in Windows Terminal (when installed)
    • Default: primary (a profile for primary is added when Windows Terminal is found)
  • client.gui.autostart
    • A boolean that identifies whether or not the Multipass GUI should automatically launch on startup.
    • Default: true (on Linux and macOS it only takes effect after the client (CLI or GUI) is run a first time).
  • client.gui.hotkey [Since version 1.4.0]
    • A keyboard shortcut for the GUI to open a shell into the primary instance.
    • Default:
      • Ctrl+Alt+U on Linux and Windows
      • ⌥⌘U on macOS
  • client.primary-name
    • The name of the instance that is launched/recognized as primary.
    • Default: primary.
  • local.driver
    • A string identifying the hypervisor back-end in use.
    • Default:
      • qemu on Linux.
      • hyperv on Windows.
      • hyperkit on macOS.

For details on allowed values, see the documentation of set.


The full multipass help get output explains the available options:

$ multipass help get
Usage: multipass get [options] <key>
Get the configuration setting corresponding to the given key.

Keys:
  client.gui.autostart
  client.gui.hotkey
  client.primary-name
  local.driver

Options:
  -h, --help     Display this help
  -v, --verbose  Increase logging verbosity. Repeat the 'v' in the short option
                 for more detail. Maximum verbosity is obtained with 4 (or more)
                 v's, i.e. -vvvv.
  --raw          Output in raw format. For now, this affects only the
                 representation of empty values (i.e. "" instead of "<empty>").

Arguments:
  key            Path to the setting whose configured value should be obtained.

Last updated 23 days ago.