Multipass Documentation

Multipass is a tool to generate cloud-style Ubuntu VMs quickly on Linux, macOS, and Windows.

It gives you a simple but powerful CLI that allows you to quickly access an Ubuntu command line or create your own local mini-cloud.

Local development and testing is a pain, but Multipass makes it easier by automating all of your setup and teardown. Multipass has a growing library of images that give you the ability 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, customized Linux dev environments on any machine. Mac and Windows users can use Multipass as the quickest way to get an Ubuntu command line on their system. New Ubuntu users can use it as a sandbox to try new things without affecting their host machine, and without the need to dual boot.


In this documentation

Tutorials
Get started - a hands-on introduction to Multipass for new users
How-to guides
Step-by-step guides covering key operations and common tasks
Explanation
Concepts - discussion and clarification of key topics
Reference
Technical information - specifications, APIs, architecture

Project and community

We value your input and contributions! There are a few ways you can join our community or get help with your Multipass questions.

Navigation

Navigation
Level Path Navlink
1 Home
1 tutorials Tutorials
2 linux-tutorial Multipass tutorial - Linux
2 windows-tutorial Multipass tutorial - Windows
2 mac-tutorial Multipass tutorial - macOS
1 how-to-guides How-to guides
2 Install Multipass
3 installing-on-linux on Linux
3 installing-on-macos on macOS
3 installing-on-windows on Windows
2 Manage instances
3 create-an-instance Create an instance
3 modify-an-instance Modify an instance
3 use-an-instance Use an instance
3 primary-instance Use the primary instance
3 using-aliases Use instance command aliases
3 share-data-with-an-instance Share data with an instance
3 remove-an-instance Remove an instance
3 docker-tutorial Run a Docker container in Multipass
2 Manage Multipass
3 set-up-the-driver Set up the driver
3 authenticating-clients Authenticate clients with the Multipass service
3 how-to-use-multipass-remotely-a-preview Use Multipass remotely
3 improve-mount-performance Improve mount performance
3 building-multipass-images-with-packer Build Multipass images with Packer
3 set-up-a-graphical-interface Set up a graphical interface
3 changing-terminal Use a different terminal from the system icon
3 configure-multipass-storage Configure where Multipass stores external data
2 Troubleshoot
3 accessing-logs Access logs
3 troubleshoot-networking Troubleshoot networking
1 reference Reference
2 alias Alias
2 driver Driver
2 host Host
2 instance Instance
2 mount Mount
2 multipass-cli-client Multipass CLI client >
3 multipass-cli-commands Multipass CLI commands
2 multipass-gui-client Multipass GUI client
2 platform Platform
2 service Service
2 settings-explanation Setting >
3 get-and-set-keys get and set keys
1 explanation Explanation
2 about-security About security
2 exec-shells multipass exec and shells
multipass commands
alias-command alias
aliases-command aliases
authenticate-command authenticate
delete-command delete
exec-command exec
find-command find
get-command get
get-command-preview get (preview)
help-command help
info-command info
launch-command launch
list-command list
mount-command mount
networks-command networks
purge-command purge
recover-command recover
set-command set
shell-command shell
start-command start
stop-command stop
suspend-command suspend
transfer-command transfer
umount-command umount
unalias-command unalias
version-command version
get & set keys
gui-autostart client.gui.autostart
gui-hotkey client.gui.hotkey
primary-name client.primary-name
bridged-network local.bridged-network
local-driver local.driver
passphrase local.passphrase
privileged-mounts local.privileged-mounts
winterm-profiles client.apps.windows-terminal.profiles
local.<instance-name>.cpus local.<instance-name>.cpus
local.<instance-name>.disk local.<instance-name>.memory
local.<instance-name>.memory local.<instance-name>.memory

Redirects

Mapping table
Location Path
/docs/networks-command/19542 /docs/networks-command
/docs/working-with-instances /docs/create-an-instance
/docs/primary-instance /docs/instance
/docs/instance-mod /docs/modify-an-instance
/docs/additional-networks /docs/create-an-instance
/docs/using-a-custom-dns /docs/create-an-instance
/docs/using-libvirt /docs/set-up-the-driver
/docs/using-virtualbox-in-multipass-macos /docs/set-up-the-driver
/docs/using-virtualbox-in-multipass-windows /docs/set-up-the-driver
/docs/troubleshooting-networking-on-macos /docs/troubleshoot-networking
/docs/troubleshooting-networking-on-windows /docs/troubleshoot-networking
/docs/stand-alone-windows-in-multipass /docs/set-up-a-graphical-interface
/docs/graphical-desktop-in-multipass /docs/set-up-a-graphical-interface
/docs/changing-macos-terminal /docs/changing-terminal

Documentation is a subcategory used to collect user documentation about the Multipass project. This first topic bootstraps the structure of the documentation we want to provide.

Feel free to add a comment below about topics that you think we should document. Thanks!

Missing topics:

Basic usage

  • snapcraft
  • Communicating with instances

Command-line reference

  • shell
  • suspend
  • delete
  • recover
  • purge

Advanced usage

  • cloud-init

Debugging and Contributing

  • Troubleshooting networking
    • on Linux
  • Reporting problems
  • Getting help
  • Building from source
1 Like

Hi @saviq,
I’m evaluating multipass for my personal needs (non-work related) and saw that the https://multipass.run/docs seems to be missing quite some important commands, like stop, umount, delete and so on.
Is there an alternative documentation page for multipass, besides the built-in --help option in the tool itself?
If not, since this is an easy effort, would you accept contributions to add the missing commands?

1 Like

Hi @rosuvladimir, we certainly would!

As you can see above we have a “Missing topics” section. Just start a new topic under this category:

And we’ll hook it up :slight_smile:

Thanks!