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 the Juju SDK 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

Multipass is fully open source. 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 docker-tutorial Run a Docker container in Multipass
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 share-data-with-an-instance Share data with an instance
3 remove-an-instance Remove an instance
3 primary-instance Use the primary instance
3 using-aliases Use command aliases
3 additional-networks Add network interfaces
3 using-a-custom-dns Use a custom DNS
2 Manage Multipass
3 using-virtualbox-in-multipass-macos Use VirtualBox on macOS
3 using-virtualbox-in-multipass-windows Use VirtualBox on Windows
3 using-libvirt Use libvirt
3 changing-macos-terminal Use a different macOS terminal
3 how-to-use-multipass-remotely-a-preview Use Multipass remotely
3 improve-mount-performance Improve mount performance
3 building-multipass-images-with-packer Building Multipass images with Packer
3 graphical-desktop-in-multipass Graphical desktop in Multipass
3 stand-alone-windows-in-multipass Stand-alone windows in Multipass
2 Troubleshoot
3 accessing-logs Access logs
3 troubleshooting-networking-on-macos Troubleshoot networking on macOS
3 troubleshooting-networking-on-windows Troubleshoot networking on Windows
1 reference Reference
2 multipass commands
3 alias-command alias
3 aliases-command aliases
3 authenticate-command authenticate
3 delete-command delete
3 exec-command exec
3 find-command find
3 get-command get
3 get-command-preview get (preview)
3 help-command help
3 info-command info
3 launch-command launch
3 list-command list
3 mount-command mount
3 networks-command networks
3 purge-command purge
3 recover-command recover
3 set-command set
3 shell-command shell
3 start-command start
3 stop-command stop
3 suspend-command suspend
3 transfer-command transfer
3 umount-command umount
3 unalias-command unalias
3 version-command version
2 get & set keys
3 bridged-network local.bridged-network
3 driver local.driver
3 gui-autostart client.gui.autostart
3 gui-hotkey client.gui.hotkey
3 passphrase local.passphrase
3 primary-name client.primary-name
3 privileged-mounts local.privileged-mounts
3 winterm-profiles client.apps.windows-terminal.profiles
2 Basic notions
3 alias Alias
3 driver Driver
3 host Host
3 instance Instance
3 mount Mount
3 multipass-cli-client Multipass CLI client
3 multipass-gui-client Multipass GUI client
3 platform Platform
3 service Service
3 settings-explanation Setting
3 instance-mod Instance modification
3 exec-shells How exec and shells interact
3 authenticating-clients Client authentication

| 1 | explanation | Explanation |

Redirects

Mapping table
Location Path
/docs/networks-command/19542 /docs/networks-command
/docs/working-with-instances /docs/create-an-instance

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!