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.
Install and update
curl -fsSL https://github.com/PlugOvr-ai/meshvpn/releases/latest/download/install.sh | sudo sh | Install on Linux, macOS |
irm https://github.com/PlugOvr-ai/meshvpn/releases/latest/download/install.ps1 | iex | Install on Windows (PowerShell as administrator) |
sudo meshvpn update | Latest signed release, restarts meshvpn |
meshvpn --version | Which version runs here |
meshvpn doctor | Check the setup, say how to fix problems |
Networks
sudo meshvpn init --network home | New network, this machine first; prints an invite |
sudo meshvpn invite | Invite 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 networks | The networks this machine is in |
sudo meshvpn rename laptop | New name; IP and permissions stay |
sudo meshvpn leave | Leave the network, remove its keys here |
Service
sudo meshvpn install | Run at boot: systemd, launchd or Task Scheduler |
sudo meshvpn restart | Restart, the same on every system |
sudo meshvpn uninstall | Stop and remove the service |
sudo meshvpn up | Run in the foreground instead |
sudo meshvpn dht on / off | Find moved nodes through the DHT; restarts |
Status and connections
meshvpn status | This node, its peers, paths, reconnects |
meshvpn nodes | Nodes with tags, hardware and GPUs |
meshvpn net why laptop | Why there is no direct connection, and what to do |
meshvpn net matrix | Latency, throughput and LAN paths between nodes |
sudo meshvpn connect host.example.com | Reach a node the network can't find by itself |
sudo meshvpn forget old-pc | Remove an offline node everywhere |
Logins and desktops
sudo meshvpn ssh | Edit who may log in here, without a password |
sudo meshvpn ssh allow alice@laptop --as alice | Let one user of a node in, as a local account |
ssh server.mesh | Log in by name |
meshvpn console | All nodes, shells as tabs (also plain meshvpn) |
meshvpn desktop server | The node's graphical desktop in the browser |
sudo meshvpn desktop setup --desktop xfce | Install a full desktop on this node (also mate, cinnamon) |
install.sh --user --desktop xfce | Xfce without root, e.g. in a Docker image (packed, 650 MB) |
meshvpn desktop setup --gpu | 3D on the GPU in desktop sessions; without sudo for your account only |
vglrun blender | In the packed desktop: start a 3D program on the GPU |
Many nodes at once
sudo meshvpn tag add gpu | Label this node; select it as tag:gpu |
meshvpn exec tag:gpu -- nvidia-smi | Run a command on several nodes |
meshvpn cp ./data tag:gpu:/srv/ | Copy files to or from nodes |
meshvpn share ./dataset · fetch ID DIR | Share a dataset; download it from every node that has it |
GPUs and training
meshvpn gpu list | GPUs: free, busy or reserved |
meshvpn gpu reserve -n 2 --one tag:gpu | Reserve 2 GPUs on the best node (2 h); prints CUDA_VISIBLE_DEVICES |
meshvpn gpu release ID · gpu renew | Give them back, or keep them longer |
meshvpn net check tag:gpu | Before training: do all pairs connect? |
meshvpn launch tag:gpu -- torchrun --nproc_per_node=8 train.py | Distributed job, environment set on every node |
meshvpn jobs · jobs logs ID · jobs stop ID | Your jobs |
Exit nodes and admins
sudo meshvpn exit offer | Offer this node's internet connection |
sudo meshvpn exit use server · exit off | Send internet traffic through a node, or not |
meshvpn admin status | Managed or open, who the admins are |
sudo meshvpn admin enable | Make an open network managed, this node admin |
sudo meshvpn admin trust hub | Open network: accept hub as admin on this node |
sudo meshvpn admin add alice-pc · admin rm | Make a node admin, or not any more |
sudo meshvpn ban old-pc | Ban a node for good; new network key |
Everything else: meshvpn help, the tutorial, troubleshooting and the README. AI agents: meshvpn guide.