(how-to-guides-customise-multipass-integrate-with-windows-terminal)=

How to integrate with Windows Terminal

If you are on Windows and you want to use Windows Terminal, Multipass can integrate with it to offer you an automatic primary profile.

Multipass profile

Currently, Multipass can add a profile to Windows Terminal for the {ref}primary-instance. When you open a Windows Terminal tab with this profile, you'll automatically find yourself in a primary instance shell. Multipass automatically starts or launches the primary instance if needed.

{figure}

   :width: 680px
   :alt: Screenshot: primary shell

Install Windows Terminal

The first step is to install Windows Terminal. Once you have it along Multipass, you can enable the integration.

Enable integration

Open a terminal (Windows Terminal or any other) and enable the integration with the following command:

{code-block}

multipass set client.apps.windows-terminal.profiles=primary

For more information on this setting, see client.apps.windows-terminal.profiles. Until you modify it, Multipass will try to add the profile if it finds it missing. To remove the profile see {ref}integrate-with-windows-terminal-revert below.

Open a Multipass tab

You can now open a "Multipass" tab to get a shell in the primary instance. That can be achieved by clicking the new-tab drop-down and selecting the Multipass profile:

{figure}

   :width: 680px
   :alt: Screenshot: drop-down menu

That's it!

(integrate-with-windows-terminal-revert)=

Revert

If you want to disable the profile again, you can do so with:

{code-block}

multipass set client.apps.windows-terminal.profiles=none

Multipass will then remove the profile if it exists.