Installing Multipass on macOS

Installing Multipass on macOS

Prerequisites

Hypervisor.framework / hyperkit

The default backend on macOS is hyperkit, wrapping Apple’s Hypervisor.framework. You need macOS Yosemite, version 10.10.3 or later installed on a 2010 or newer Mac.

VirtualBox

Multipass also supports using VirtualBox as a virtualization provider. You can download the latest version and check the requirements on the VirtualBox website.

Installation

To install Multipass on macOS, you have two options: the installer package or brew:

Installer

Download the latest installer from our GitHub releases page - it’s the .pkg package.

If you want Tab completion on the command line, install bash-completion from brew first.

Activate the downloaded installer and it will guide you through the steps necessary. You will need an account with Administrator privileges to complete the installation.

Multipass installer on macOS

There’s a script to uninstall:

$ sudo sh "/Library/Application Support/com.canonical.multipass/uninstall.sh"

Brew

Have a look at brew.sh on instructions to install Brew itself. Then, it’s a simple:

$ brew cask install multipass

To uninstall:

$ brew cask uninstall multipass
# or
$ brew cask zap multipass # to destroy all data, too

First run

Once installed, open the Terminal app and you can use multipass launch to create your first instance.

If you’d like to use VirtualBox, run:

$ sudo multipass set local.driver=virtualbox

With multipass version you can check which version you have running:

$ multipass version
multipass 1.0.0+mac
multipassd 1.0.0+mac

Have a look at Working with instances to quickly get off the ground!

1 Like

How do you uninstall multipass on Mac OS?

If we have Homebrew, we can install/uninstall multipass with the following commands:

Install

$ brew cask install multipass
$ multipass version
multipass  0.8.0+mac
multipassd 0.8.0+mac

Uninstall

$ brew cask uninstall multipass
1 Like

Thanks @shuuji3 I’ve now incorporated that into the main post above.

1 Like

Thanks for improving the documentation!
It should help many developers. :slight_smile:

By the way, you’ve left off the “cask” part of the uninstall commands, so they don’t work, and give an “Error: Unknown command: zap” message, which isn’t very helpful. It’s brew cask uninstall multipass and brew cask zap multipass. Otherwise, thanks for the info!

Hi @henryschreineriii sorry about that, thanks for noticing! Updated the post.

1 Like

Hi, many thanks for the tool and documentation.

Two things come to my mind:

  1. Could you provide information here (as on the Windows installation page) which prerequisites, especially virtualisation methods are used/available?

  2. With the 1.0 release of today, can you update the output of multipass version at this page?

Thanks

Hi @sven, I’ve now made the changes you mentioned. Thanks for prompting :).

1 Like

Is OS X El Capitan (10.11) and macOS Sierra (10.12) included in the operating environment of multipass?
With these versions, in my environment the multipass command issued an error and could not be started.

It seems that there is no problem in the version environment after macOS High Sierra (10.13).
The version of multipass I checked at this time is 1.0.0.

kurosawa-no-Mac:~ kurosawa$ multipass version
dyld: Symbol not found: __ZNSt19bad_optional_accessD1Ev
Referenced from: /usr/local/bin/multipass
Expected in: /usr/lib/libc++.1.dylib
in /usr/local/bin/multipass
Trace/BPT trap: 5
kurosawa-no-Mac:~ kurosawa$ sw_vers
ProductName: Mac OS X
ProductVersion: 10.11.6
BuildVersion: 15G22010

kurosawanoMac:~ kurosawa$ multipass version
dyld: Symbol not found: __ZNSt19bad_optional_accessD1Ev
Referenced from: /usr/local/bin/multipass
Expected in: /usr/lib/libc++.1.dylib
in /usr/local/bin/multipass
Abort trap: 6
kurosawanoMac:~ kurosawa$ sw_vers
ProductName: Mac OS X
ProductVersion: 10.12.6
BuildVersion: 16G2136

kurosawanomakku:~ kurosawa$ multipass version
multipass 1.0.0+mac
multipassd 1.0.0+mac
kurosawanomakku:~ kurosawa$ sw_vers
ProductName: Mac OS X
ProductVersion: 10.13.6
BuildVersion: 17G66