Back to downloads
Installation
Pick your platform below and copy one command — the vyomi launcher boots the full appliance inside Multipass.
Step 1
Install Homebrew (one-time, if you don't have it)
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"After install, brew will print 2 lines to add to your shell rc. Run them, then open a NEW terminal so `brew` is on PATH.
Step 2
Install vyomi
brew tap vyomi-cloud/tap
brew install vyomi
Step 3
Start the appliance
vyomi upOn first run the launcher will:
- detect missing Multipass and offer to install it
via `brew install --cask multipass` (macOS will
ask for your sudo password to install the .pkg)
- boot the appliance VM (~3-5 min first time)
- open your browser at https://localhost:9443/ with
a green padlock (mkcert-trusted, zero config)
Day-2
upgrade / stop
brew upgrade vyomi # then re-run `vyomi up`
vyomi down # stop the appliance VM
Optional
use Docker Compose as the front door
curl -fsSL https://raw.githubusercontent.com/vyomi-cloud/appliance/main/packaging/compose-provider/docker-compose.yml -o docker-compose.yml
docker compose -p vyomi up # → vyomi up (boots the appliance)
docker compose -p vyomi down # → vyomi down (stops it)Prefer `docker compose`? Once the launcher is installed (above), it becomes the Compose provider — `docker compose up` runs `vyomi up`, booting the SAME appliance inside Multipass (full EC2/LXD compute). Needs Docker on your machine.
Step 1
Install vyomi
wget https://github.com/vyomi-cloud/appliance/releases/download/v2.1.0.1/cloud-learn_2.1.0.1_all.deb
sudo apt install -y ./cloud-learn_2.1.0.1_all.deb(artifact filename keeps the legacy `cloud-learn_*.deb` name through v2.x for back-compat; both `vyomi` and `cloud-learn` shims are installed to /usr/bin.)
Step 2
Start the appliance
vyomi upOn first run the launcher will:
- detect missing Multipass and offer to install it
via `sudo snap install multipass` (snapd is
preinstalled on Ubuntu; on Debian see note below)
- boot the appliance VM (~3-5 min first time)
- open your browser at https://localhost:9443/
(green padlock via mkcert-trusted local CA)
Day-2
stop / upgrade
vyomi down # stop the applianceUpgrade — re-run Step 1 with the new version number (signed APT repo is in the roadmap)
Optional
use Docker Compose as the front door
curl -fsSL https://raw.githubusercontent.com/vyomi-cloud/appliance/main/packaging/compose-provider/docker-compose.yml -o docker-compose.yml
docker compose -p vyomi up # → vyomi up (boots the appliance)
docker compose -p vyomi down # → vyomi down (stops it)Prefer `docker compose`? Once the launcher is installed (above), it becomes the Compose provider — `docker compose up` runs `vyomi up`, booting the SAME appliance inside Multipass (full EC2/LXD compute). Needs Docker on your machine.
Step 1
Install vyomi
wget https://github.com/vyomi-cloud/appliance/releases/download/v2.1.0.1/cloud-learn-2.1.0.1-1.noarch.rpm
sudo dnf install -y ./cloud-learn-2.1.0.1-1.noarch.rpm(artifact filename keeps the legacy `cloud-learn-*.rpm` name through v2.x for back-compat; both `vyomi` and `cloud-learn` shims are installed to /usr/bin.)
Step 2
Bootstrap snapd if it isn't there yet (minimal images)
sudo dnf install -y snapd
sudo systemctl enable --now snapd.socket
sudo ln -s /var/lib/snapd/snap /snap # classic-confinement symlinkFedora / RHEL / CentOS often ship without snapd. The launcher will print these commands for you if Multipass install fails. (skip this step entirely if `snap --version` already works)
Step 3
Start the appliance
vyomi upOn first run the launcher will:
- detect missing Multipass and run `sudo snap install multipass`
(which is why snapd from Step 2 needs to be ready)
- boot the appliance VM (~3-5 min first time)
- open your browser at https://localhost:9443/
(green padlock via mkcert-trusted local CA)
Optional
use Docker Compose as the front door
curl -fsSL https://raw.githubusercontent.com/vyomi-cloud/appliance/main/packaging/compose-provider/docker-compose.yml -o docker-compose.yml
docker compose -p vyomi up # → vyomi up (boots the appliance)
docker compose -p vyomi down # → vyomi down (stops it)Prefer `docker compose`? Once the launcher is installed (above), it becomes the Compose provider — `docker compose up` runs `vyomi up`, booting the SAME appliance inside Multipass (full EC2/LXD compute). Needs Docker on your machine.
Step 1
Install vyomi
winget install Vyomi.Vyomi
Step 2
Start the appliance
vyomi upOpen a NEW terminal so `vyomi` is on PATH, then: (Optional) If `vyomi` or `multipass` isn't recognized, this shell's PATH is stale - open a fresh PowerShell, or run once: $env:Path = "C:\Program Files\Multipass\bin;$env:Path" First run auto-installs Multipass (UAC prompt), sizes the VM to leave the host headroom, pulls the stack, then opens http://localhost:9000/
Day-2
upgrade / stop
winget upgrade Vyomi.Vyomi
vyomi down
Optional
use Docker Compose as the front door
curl -fsSL https://raw.githubusercontent.com/vyomi-cloud/appliance/main/packaging/compose-provider/docker-compose.yml -o docker-compose.yml
docker compose -p vyomi up # → vyomi up (boots the appliance)
docker compose -p vyomi down # → vyomi down (stops it)Prefer `docker compose`? Once the launcher is installed (above), it becomes the Compose provider — `docker compose up` runs `vyomi up`, booting the SAME appliance inside Multipass (full EC2/LXD compute). Needs Docker on your machine.
Step 1
Download + run the installer
https://github.com/vyomi-cloud/appliance/releases/download/v2.1.0.1/cloud-learn-2.1.0.1-x64.msiDownload, then double-click. SmartScreen (unsigned): More info -> Run anyway. Accept the UAC prompt.
Step 2
Start the appliance
vyomi upOpen a NEW terminal so `vyomi` is on PATH, then: (Optional) If `vyomi` or `multipass` isn't recognized, this shell's PATH is stale - open a fresh PowerShell, or run once: $env:Path = "C:\Program Files\Multipass\bin;$env:Path" First run auto-installs Multipass (UAC), sizes the VM to your RAM, pulls the stack, and opens http://localhost:9000/
Day-2
upgrade / stop
vyomi downRe-download the new MSI from the latest release and run it, or `winget upgrade Vyomi.Vyomi` once winget is live.
Optional
use Docker Compose as the front door
curl -fsSL https://raw.githubusercontent.com/vyomi-cloud/appliance/main/packaging/compose-provider/docker-compose.yml -o docker-compose.yml
docker compose -p vyomi up # → vyomi up (boots the appliance)
docker compose -p vyomi down # → vyomi down (stops it)Prefer `docker compose`? Once the launcher is installed (above), it becomes the Compose provider — `docker compose up` runs `vyomi up`, booting the SAME appliance inside Multipass (full EC2/LXD compute). Needs Docker on your machine.
Step 1
Install Scoop (one-time, if you don't have it)
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
irm get.scoop.sh | iexRun in PowerShell (not cmd.exe):
Step 2
Add the vyomi bucket + install
scoop bucket add vyomi https://github.com/vyomi-cloud/scoop-bucket
scoop install vyomi
Step 3
Start the appliance
vyomi upOn first run the launcher will:
- detect missing Multipass and offer to install it via
`winget install Canonical.Multipass` (UAC prompt for
the .exe install)
- boot the appliance VM (~3-5 min first time)
- open your browser at https://localhost:9443/
(green padlock via mkcert-trusted local CA)
Day-2
upgrade / stop
scoop update vyomi
vyomi down
Optional
use Docker Compose as the front door
curl -fsSL https://raw.githubusercontent.com/vyomi-cloud/appliance/main/packaging/compose-provider/docker-compose.yml -o docker-compose.yml
docker compose -p vyomi up # → vyomi up (boots the appliance)
docker compose -p vyomi down # → vyomi down (stops it)Prefer `docker compose`? Once the launcher is installed (above), it becomes the Compose provider — `docker compose up` runs `vyomi up`, booting the SAME appliance inside Multipass (full EC2/LXD compute). Needs Docker on your machine.