(reference-gui-client)=

GUI client

See also: Instance, Service, Settings

{caution}

The GUI was introduced in Multipass version 1.14. It is still in its MVP (Minimum Viable Product) stage, so it is likely to see some changes in design as it evolves.

The Multipass GUI (Graphical User Interface) is an application that acts as a client for interacting with the Multipass service. It aims to make the process of managing instances easier for users who do not want to interact with the CLI (Command Line Interface) client. You can launch the GUI either using your system's application launcher or by running multipass.gui in a terminal.

For more information on GUI logs, see How to access logs.

As of now, the Multipass GUI provides the following set of capabilities, grouped under four tabs:

{ref}gui-client-catalogue-tab
{ref}gui-client-instances-tab
{ref}gui-client-settings-tab

as well as a {ref}gui-client-tray-icon menu.

(gui-client-catalogue-tab)=

Catalogue tab

Here you can browse the available Ubuntu images. The output is equivalent to the one given by multipass find --only-images.

{figure}

   :width: 720px
   :alt: GUI client - Catalogue tab

You can configure an instance's launch options, specifying parameters such as its name, allocated resources and mounts.

{figure}

   :width: 720px
   :alt: GUI client - Configure instance

When you launch a VM, you can see details on all the steps taken and be notified of errors.

{figure}

   :width: 720px
   :alt: GUI client - Launching instance

(gui-client-instances-tab)=

Instances tab

Here you can see an overview of all your instances and perform bulk actions such as starting, stopping, suspending or deleting the selected ones. You can also filter instances by name and by state ("running" or "stopped").

{figure}

   :width: 720px
   :alt: GUI client - Instances tab

You can perform actions on an individual instance, such as starting, stopping, suspending or deleting it. You can also open shells within a running instance, where you can do all of your work that is specific to that instance.

{figure}

   :width: 720px
   :alt: GUI client - Instance shell

{caution}

Please note that when you delete an instance using the GUI client, Multipass removes it permanently and they cannot be recovered. This behaviour is equivalent to running the [`multipass delete --purge`](/reference/command-line-interface/delete) command.

You can also edit an instance; in particular, you can change its allocated resources, connect it to a bridged network or edit its mounts. Some of these settings require the instance to be stopped before they can be applied.

{figure}

   :width: 720px
   :alt: GUI client - Edit instance

(gui-client-settings-tab)=

Settings tab

Here you can change various Multipass settings, although not all settings that are available in the CLI are present in the GUI and vice versa.

{figure}

   :width: 720px
   :alt: GUI client - Settings tab

(gui-client-tray-icon)=

Tray icon

You can manage your instances using the tray icon menu as well.

{figure}

   :width: 419px
   :alt: GUI client - Tray icon menu