Installation Instructions

Nitro is no longer supported. Please see our announcement and DDEV migration guide.

# Installing Nitro

# macOS and Linux

  1. Install Multipass (opens new window) (requires 1.5.0+).

  2. Run this terminal command:

    bash <(curl -sLS https://raw.githubusercontent.com/craftcms/nitro/v1/install.sh)

  3. Follow the prompts to create your machine.

# Windows 10 Pro (with Hyper-V enabled)

Windows doesn’t currently have an automated install script, so installation and updating must be done manually.

  1. Install Multipass (opens new window) (requires 1.5.0+).
  2. Download nitro_windows_x86_64.zip from the latest release (opens new window)
  3. Create a Nitro folder in your home folder, if it does not exist. i.e. C:\Users\<username>\Nitro
  4. Extract the zip file and copy nitro.exe into the Nitro folder you just created in your home folder.
  5. If this is your first installation, run this from the command line to add nitro to your global path: setx path "%PATH%;%USERPROFILE%\Nitro"
  6. Start the Windows terminal (cmd.exe) with Administrator permissions and run nitro init to create your first machine.

Once complete, you will have a Multipass machine called nitro-dev, and a new configuration file for the machine stored at ~/.nitro/nitro-dev.yaml.

# Uninstalling Nitro

To completely remove Nitro, first destroy your machine:

nitro destroy

If you have multiple machines, you can destroy them all using the multipass delete command:

multipass delete --all -p

Then remove your nitro command:

sudo rm /usr/local/bin/nitro

You can optionally remove your machine configs as well:

rm -rf ~/.nitro

If you wish to uninstall Multipass, uninstall instructions can be found on your platform’s installation guide: