Multipass

Multipass is a tool to generate cloud-style Ubuntu VMs quickly on Linux, macOS and Windows. It provides a simple but powerful CLI that enables you to quickly access an Ubuntu command line or create your own local mini-cloud.

Local development and testing can be challenging, but Multipass simplifies these processes by automating setup and teardown. Multipass has a growing library of images that you can use to launch purpose-built VMs or custom VMs you’ve configured yourself through its powerful cloud-init interface.

Developers can use Multipass to prototype cloud deployments and to create fresh, customised Linux dev environments on any machine. Multipass is the quickest way for Mac and Windows users to get an Ubuntu command line on their systems. You can also use it as a sandbox to try new things without affecting your host machine or requiring a dual boot.

---

In this documentation

Basics

Start here to install and launch your first Multipass instance.

• Tutorial: Getting stated with Multipass • Install Multipass • Setup the driver • Migrate from Hyperkit to QEMU

Using Multipass

Learn the complete lifecycle of a virtual machine.

• Instance management: Create an instance • Use an instance • Modify an instance • Use the primary instance • Use instance command aliases • Remove an instance

• Instance customization: cloud-init • Build Multipass images with Packer • Set up a graphical interface • Run a Docker container in Multipass

• Interfaces (CLI/GUI): Command-line interface • GUI client • Use a different terminal from the system icon • How to integrate with Windows Terminal

• Troubleshooting: Access logs • Troubleshoot launch/start issues

Understanding Multipass

• Core concepts: Instance • Image • Snapshot • Alias • Service • Multipass exec and shells • ID mapping • Reference architecture

• Virtualization: Driver • How to set up the driver • Migrate from Hyperkit to QEMU on macOS • Platform • Host

• Configuration: Settings • Settings keys and values • Logging levels • Configure Multipass’s default logging level • Instance name format • Instance states

Resources and networking

• Storage: Share data with an instance • Configure where Multipass stores external data • Mount • Mount an encrypted home folder

• Networking: Add a network to an existing instance • Configure static IPs • Troubleshoot networking

Security and performance

• Security: Authenticate users with the Multipass service • Authentication • About security

• Performance: About performance

---

How this documentation is organized

This documentation uses the Diátaxis documentation structure.

• Tutorial takes you step-by-step through your first Multipass workflow, from installation to launching and working with instances.

• How-to guides assume you have basic familiarity with Multipass. They cover practical tasks such as instance management, configuration, networking, and troubleshooting.

• Reference provides technical details on CLI commands, settings, architecture, and platform-specific behavior.

• Explanation includes conceptual overviews, background context, and deeper discussion of how Multipass works.

---

Project and community

We value your input and contributions! Here are some ways you can join our community or get help with your Multipass questions:

• Read our Code of Conduct

• Read our quick guide: Contribute to Multipass docs

• Join the Discourse forum

• Report an issue or contribute to the code on GitHub