meshvpn

Reference · one page

Cheat sheet

The commands you need most. Every command has --help; --net NAME picks one of several networks, --json gives machine-readable output.

Linux and macOS: sudo where markedWindows: an administrator terminal (not PowerShell ISE), no sudo

Install and update

curl -fsSL https://github.com/PlugOvr-ai/meshvpn/releases/latest/download/install.sh | sudo shInstall on Linux, macOS
irm https://github.com/PlugOvr-ai/meshvpn/releases/latest/download/install.ps1 | iexInstall on Windows (PowerShell as administrator)
sudo meshvpn updateLatest signed release, restarts meshvpn
meshvpn --versionWhich version runs here
meshvpn doctorCheck the setup, say how to fix problems

Networks

sudo meshvpn init --network homeNew network, this machine first; prints an invite
sudo meshvpn inviteInvite code for one more machine (24 h)
sudo meshvpn join mesh1-…Join with an invite code
sudo meshvpn --net work join mesh1-…Join a second network too
meshvpn networksThe networks this machine is in
sudo meshvpn rename laptopNew name; IP and permissions stay
sudo meshvpn leaveLeave the network, remove its keys here

Service

sudo meshvpn installRun at boot: systemd, launchd or Task Scheduler
sudo meshvpn restartRestart, the same on every system
sudo meshvpn uninstallStop and remove the service
sudo meshvpn upRun in the foreground instead
sudo meshvpn dht on / offFind moved nodes through the DHT; restarts

Status and connections

meshvpn statusThis node, its peers, paths, reconnects
meshvpn nodesNodes with tags, hardware and GPUs
meshvpn net why laptopWhy there is no direct connection, and what to do
meshvpn net matrixLatency, throughput and LAN paths between nodes
sudo meshvpn connect host.example.comReach a node the network can't find by itself
sudo meshvpn forget old-pcRemove an offline node everywhere

Logins and desktops

sudo meshvpn sshEdit who may log in here, without a password
sudo meshvpn ssh allow alice@laptop --as aliceLet one user of a node in, as a local account
ssh server.meshLog in by name
meshvpn consoleAll nodes, shells as tabs (also plain meshvpn)
meshvpn desktop serverThe node's graphical desktop in the browser
sudo meshvpn desktop setup --desktop xfceInstall a full desktop on this node (also mate, cinnamon)
install.sh --user --desktop xfceXfce without root, e.g. in a Docker image (packed, 650 MB)
meshvpn desktop setup --gpu3D on the GPU in desktop sessions; without sudo for your account only
vglrun blenderIn the packed desktop: start a 3D program on the GPU

Many nodes at once

sudo meshvpn tag add gpuLabel this node; select it as tag:gpu
meshvpn exec tag:gpu -- nvidia-smiRun a command on several nodes
meshvpn cp ./data tag:gpu:/srv/Copy files to or from nodes
meshvpn share ./dataset · fetch ID DIRShare a dataset; download it from every node that has it

GPUs and training

meshvpn gpu listGPUs: free, busy or reserved
meshvpn gpu reserve -n 2 --one tag:gpuReserve 2 GPUs on the best node (2 h); prints CUDA_VISIBLE_DEVICES
meshvpn gpu release ID · gpu renewGive them back, or keep them longer
meshvpn net check tag:gpuBefore training: do all pairs connect?
meshvpn launch tag:gpu -- torchrun --nproc_per_node=8 train.pyDistributed job, environment set on every node
meshvpn jobs · jobs logs ID · jobs stop IDYour jobs

Exit nodes and admins

sudo meshvpn exit offerOffer this node's internet connection
sudo meshvpn exit use server · exit offSend internet traffic through a node, or not
meshvpn admin statusManaged or open, who the admins are
sudo meshvpn admin enableMake an open network managed, this node admin
sudo meshvpn admin trust hubOpen network: accept hub as admin on this node
sudo meshvpn admin add alice-pc · admin rmMake a node admin, or not any more
sudo meshvpn ban old-pcBan a node for good; new network key

Everything else: meshvpn help, the tutorial, troubleshooting and the README. AI agents: meshvpn guide.