Multipass Documentation outline


Welcome to the Multipass Guide!

Multipass is a mini-cloud on your workstation using native hypervisors of all the supported plaforms (Windows, macOS and Linux), it will give you an Ubuntu command line in just a click (“Open shell”) or a simple multipass shell command, or even a keyboard shortcut. Find what images are available with multipass find and create new instances with multipass launch.

You can initialize instances through cloud-init as you normally would on all the clouds Ubuntu is supported on, just pass the configuration to multipass launch --cloud-init.

Accessing files from your host machine is supported through the multipass mount command, and to move files between the host and instances, you can use multipass transfer.

Please learn more details in the linked documentation topics.



Basic usage

Command-line reference

Advanced usage

Debugging and Contributing


Mapping table
Topic Path
Installing Multipass on Linux /docs/installing-on-linux
Installing Multipass on macOS /docs/installing-on-macos
Installing Multipass for Windows /docs/installing-on-windows
Working with Multipass instances /docs/working-with-instances
Primary instance /docs/primary-instance
`multipass set` command /docs/set-command
`multipass help` command /docs/help-command
`multipass find` command /docs/find-command
`multipass launch` command /docs/launch-command
`multipass info` command /docs/info-command
`multipass list` command /docs/list-command
`multipass get` command /docs/get-command
`multipass shell` command /docs/shell-command
`multipass start` command /docs/start-command
`multipass exec` command /docs/exec-command
'multipass version` command /docs/version-command
Using libvirt in Multipass /docs/using-libvirt
Troubleshooting networking on macOS /docs/troubleshooting-networking-on-macos
Troubleshooting networking on Windows /docs/troubleshooting-networking-on-windows

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

Command-line reference

  • mount
  • shell
  • umount
  • transfer
  • stop
  • suspend
  • delete
  • recover
  • purge

Advanced usage

  • cloud-init

Debugging and Contributing

  • Troubleshooting networking
    • on Linux
  • Accessing logs
  • Reporting problems
  • Getting help
  • Building from source

Ok, shell has been added.

1 Like

get and set are now in too.

suspend also missing