Installation

Pick your platform below and copy one command — the vyomi launcher boots the full appliance inside Multipass.

Free — Docker: full API/SDK conformance, no compute.

Step 1 Install Docker (one-time, if you don't have it)

docker --version      # verify Docker is running

macOS / Windows: install Docker Desktop — https://docker.com/products/docker-desktop
Linux: install Docker Engine — https://docs.docker.com/engine/install/

docker --version      # verify Docker is running

Step 2 Get the compose file + start

curl -fsSL https://raw.githubusercontent.com/vyomi-cloud/appliance/main/docker-compose.cloudlite.yml -o docker-compose.yml
docker compose up -d

curl -fsSL https://raw.githubusercontent.com/vyomi-cloud/appliance/main/docker-compose.cloudlite.yml -o docker-compose.yml
docker compose up -d

Step 3 Open the console

Wait ~30s for the simulator to pull + boot, then open:
  http://localhost:9000
Pro tier: launch an EC2 instance in the console, then
  ssh ubuntu@<instance-ip>   (key is injected at launch)

Day-2 stop / update

docker compose down            # stop
docker compose pull && docker compose up -d   # update to latest

docker compose down            # stop
docker compose pull && docker compose up -d   # update to latest

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.

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Step 2 Install vyomi

brew tap vyomi-cloud/tap
brew install vyomi

brew tap vyomi-cloud/tap
brew install vyomi

Step 3 Start the appliance

vyomi up

On 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)

vyomi up

Day-2 upgrade / stop

brew upgrade vyomi       # then re-run `vyomi up`
vyomi down               # stop the appliance VM

brew upgrade vyomi       # then re-run `vyomi up`
vyomi down               # stop the appliance VM

Step 1 Install Docker (one-time, if you don't have it)

docker --version      # verify Docker is running

macOS / Windows: install Docker Desktop — https://docker.com/products/docker-desktop
Linux: install Docker Engine — https://docs.docker.com/engine/install/

docker --version      # verify Docker is running

Step 2 Get the compose file + start

curl -fsSL https://raw.githubusercontent.com/vyomi-cloud/appliance/main/docker-compose.cloudlite.yml -o docker-compose.yml
docker compose up -d

curl -fsSL https://raw.githubusercontent.com/vyomi-cloud/appliance/main/docker-compose.cloudlite.yml -o docker-compose.yml
docker compose up -d

Step 3 Open the console

Wait ~30s for the simulator to pull + boot, then open:
  http://localhost:9000
Pro tier: launch an EC2 instance in the console, then
  ssh ubuntu@<instance-ip>   (key is injected at launch)

Day-2 stop / update

docker compose down            # stop
docker compose pull && docker compose up -d   # update to latest

docker compose down            # stop
docker compose pull && docker compose up -d   # update to latest

Step 1 Install vyomi

wget https://github.com/vyomi-cloud/appliance/releases/download/v2.2.2/cloud-learn_2.2.2_all.deb
sudo apt install -y ./cloud-learn_2.2.2_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.)

wget https://github.com/vyomi-cloud/appliance/releases/download/v2.2.2/cloud-learn_2.2.2_all.deb
sudo apt install -y ./cloud-learn_2.2.2_all.deb

Step 2 Start the appliance

vyomi up

On 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)

vyomi up

Day-2 stop / upgrade

vyomi down                                # stop the appliance

Upgrade — re-run Step 1 with the new version number
(signed APT repo is in the roadmap)

vyomi down                                # stop the appliance

Step 1 Install vyomi

wget https://github.com/vyomi-cloud/appliance/releases/download/v2.2.2/cloud-learn-2.2.2-1.noarch.rpm
sudo dnf install -y ./cloud-learn-2.2.2-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.)

wget https://github.com/vyomi-cloud/appliance/releases/download/v2.2.2/cloud-learn-2.2.2-1.noarch.rpm
sudo dnf install -y ./cloud-learn-2.2.2-1.noarch.rpm

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 symlink

Fedora / 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)

sudo dnf install -y snapd
sudo systemctl enable --now snapd.socket
sudo ln -s /var/lib/snapd/snap /snap   # classic-confinement symlink

Step 3 Start the appliance

vyomi up

On 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)

vyomi up

Step 1 Install Docker (one-time, if you don't have it)

docker --version      # verify Docker is running

macOS / Windows: install Docker Desktop — https://docker.com/products/docker-desktop
Linux: install Docker Engine — https://docs.docker.com/engine/install/

docker --version      # verify Docker is running

Step 2 Get the compose file + start

curl -fsSL https://raw.githubusercontent.com/vyomi-cloud/appliance/main/docker-compose.cloudlite.yml -o docker-compose.yml
docker compose up -d

curl -fsSL https://raw.githubusercontent.com/vyomi-cloud/appliance/main/docker-compose.cloudlite.yml -o docker-compose.yml
docker compose up -d

Step 3 Open the console

Wait ~30s for the simulator to pull + boot, then open:
  http://localhost:9000
Pro tier: launch an EC2 instance in the console, then
  ssh ubuntu@<instance-ip>   (key is injected at launch)

Day-2 stop / update

docker compose down            # stop
docker compose pull && docker compose up -d   # update to latest

docker compose down            # stop
docker compose pull && docker compose up -d   # update to latest

Step 1 Install vyomi

winget install Vyomi.Vyomi

winget install Vyomi.Vyomi

Step 2 Start the appliance

vyomi up

Open 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/

vyomi up

Day-2 upgrade / stop

winget upgrade Vyomi.Vyomi
vyomi down

winget upgrade Vyomi.Vyomi
vyomi down

Step 1 Download + run the installer

https://github.com/vyomi-cloud/appliance/releases/download/v2.2.2/cloud-learn-2.2.2-x64.msi

Download, then double-click. SmartScreen (unsigned):
  More info -> Run anyway. Accept the UAC prompt.

https://github.com/vyomi-cloud/appliance/releases/download/v2.2.2/cloud-learn-2.2.2-x64.msi

Step 2 Start the appliance

vyomi up

Open 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/

vyomi up

Day-2 upgrade / stop

vyomi down

Re-download the new MSI from the latest release and run it,
or `winget upgrade Vyomi.Vyomi` once winget is live.

vyomi down

Step 1 Install Scoop (one-time, if you don't have it)

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
irm get.scoop.sh | iex

Run in a NORMAL (non-admin) PowerShell - Scoop blocks elevated installs:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
irm get.scoop.sh | iex

Step 2 Add the vyomi bucket + install

scoop install git
scoop bucket add vyomi https://github.com/vyomi-cloud/scoop-bucket
scoop install vyomi

Buckets are git repos, so Scoop needs git first:

scoop install git
scoop bucket add vyomi https://github.com/vyomi-cloud/scoop-bucket
scoop install vyomi

Step 3 Start the appliance

vyomi up

On 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)

vyomi up

Day-2 upgrade / stop

scoop update vyomi
vyomi down

scoop update vyomi
vyomi down