MultiTunnel Contact us

The command line

Most things are done in the app. Some administrator tasks are done from the command line. Here is how to open one, and every command in one place.

Before you start

On Windows

For your own networks, open Terminal as yourself, not as administrator: right-click the Start button and choose it. For administrator tasks, such as installing, choose Terminal (Admin) instead. Then set two shortcuts, once each time you open a window:

$mt = "C:\Program Files\MultiTunnel\multitunnel.exe"
$st = "C:\ProgramData\MultiTunnel"

Commands then start & $mt, with $st for the folder MultiTunnel keeps its state in.

On Linux

The command is on the path. Run it with sudo, with /var/lib/multitunnel for the state folder:

sudo multitunnel devices /var/lib/multitunnel northwind

To join a network for yourself, run join as yourself, without sudo: the network is then your account's. Run as root, join needs -service or -account to say whose it is.

  • A network is given by its short name on this computer, such as northwind. The app shows it under the network's Details.
  • People are given by their username, such as dana, or by their display name in quotes, such as "Dana Shah", and devices by name. The app shows people's display names. A name that matches two is refused, with the candidates listed: then give the ID instead, in quotes with # in front, as "#<ID>". On Windows, keep the quotes: without them, # starts a comment.
  • If a command says This needs an administrator terminal. Open Terminal with "Run as administrator" (Linux: put sudo in front) and run it again., do exactly that: on Windows, administrator commands such as approve or set-route need Terminal (Admin), as only administrators can read the admin key. Nothing was changed.
  • Every command on these pages shows both forms. Choose Windows or Linux above any command, and the whole page follows.
Windows
& $mt devices $st northwind
Linux
sudo multitunnel devices /var/lib/multitunnel northwind

Commands for everyone

For you, on the computer you're on: on Windows, run them in your own Terminal, not as administrator. Most have a screen in the app: see Day to day.

ToCommand
Ask to join a networkjoin <state> auto <this computer's name> [username] <invite>
Turn a network on or off hereconnect <state> <network>, disconnect <state> <network>
Change your details: display name, username, email, this computer's nameme <state> <network> [-display ".."] [-username ..] [-email ..] [-device-name ..] [-follow on|off]
Ask for access, or see your requests and their answersaccess <state> <network> [ask <device|service:name|lan:gateway> <ports> <8h|3d> <why>]
Use or ignore a network's names herenames <state> <network> on|off
Call a network by another short name hererelabel <state> <network> <new short name>
See a network's devices, and how this computer reaches eachdevices <state> <network>, peers <state> <network>
Leave a networkleave <state> <network>
Details for supportdiag <state>

Commands for administrators

Each links to the page that explains it. Those marked command line have no screen in the app.

ToCommand
Running a network
Install, or remove command lineinstall -yes, remove -yes
Create a network command lineinit <state> <network> <this computer's name> <username> [-account ..]
Describe the network, and set its short nameorg-info <state> <network> [-name ..] [-contact ..] [-description ..] [-website ..] [-short ..]
Your plan and licence command linelicence-status, licence, licence-seats
Invite and approve
Inviteinvite <state> <network> [-for username|service:name] [-hours 1-24] [-at elsewhere|-at ..|-to ..]
Approve a deviceapprove <state> <network> <reply code> [username] [-new-user] [-same-access] [-service name]
Join a computer for a service, or for a person from no desktop (on it, as its administrator)join <state> auto <this computer's name> [username] <invite> -service|-account ..
Let people add their own devicesself-enrol <state> <network> on N|off
Delegations command linedelegate, undelegate, revoke-delegate
People and devices
List people and devicesusers, devices, peers
Add, rename, merge or remove a person, or give one a new IDadd-user <state> <network> "<display name>" [-username ..], set-user, merge-user [-new-id], remove-user [-contact ..]
Whether people change their own namesself-service <state> <network> on|off
Rename or remove a devicerename-device, revoke
Tagsset-tag, tag; remove-tag command line
How long devices stayexpire; device-term command line
Services
List servicesservices <state> <network>
Create, change or remove a serviceservice <state> <network> add|set|remove <name> [-purpose server|gateway|relay|kiosk|other] [-contact ..]
Move a device to a service or a personmove-device <state> <network> <device> service:<name>|user:<person>
Run a moved device's membership for its service (on it)owner <state> <network> service
Make a network set up for everyone on a computer yours (Make it mine; on it, signed in as yourself)owner <state> <network> me
Access rules and names
Access rules and groups command lineset-rules <state> <network> <file>
Names for your servicesset-name <state> <network> <name> <device>|none [-broad-ok]
Gateways: ranges, domain and names command lineset-route <state> <network> <gateway> <range>[,<range>..] [domain] [-names <name>[=<address>],..] [-broad-ok]
Relaysset-relay <state> <network> <device> on|off
IPv6 inside the network command lineenable-ipv6 <state> <network> on|off
Requests for access
See the network's requestsaccess <state> <network>
Approve, decline, or end earlyaccess <state> <network> approve <n> [8h|3d] | decline <n> | end <n> [-ask <code> -yes]
Updates
Hold updates backhold-updates <state> <network> on|off
Take updates from a networkupdate-authority <state> <network> on|off
Approve a release, and versions command lineset-update, require-version, follow-stable
What's on offer, our latest release, install now, serve releases command lineupdate-status, check-update, install-update, host-release
Security keys and recovery
Replace the admin keyrotate-admin-key <state> <network>
Recovery command linerecover, new-recovery, export-recovery
Several administrators
Ask to be an administrator (on their computer), or stop askingrequest-admin <state> <network> [-withdraw]
Make a computer that asked an administratoradd-admin <state> <network> <device> <admin code>
List or remove administratorsadmins <state> <network>, remove-admin <state> <network> <device or admin key>
Activity and the audit trail
Every change to the network, or save itaudit <state> <network> [-since 2026-11-01] [-format text|csv|json]

Still stuck?

Email us and a person will reply. For a security problem, write to security@multitunnel.co.uk instead.

enquiries@multitunnel.co.uk