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 asapproveorset-routeneed 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.
& $mt devices $st northwindsudo multitunnel devices /var/lib/multitunnel northwindCommands 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.
| To | Command |
|---|---|
| Ask to join a network | join <state> auto <this computer's name> [username] <invite> |
| Turn a network on or off here | connect <state> <network>, disconnect <state> <network> |
| Change your details: display name, username, email, this computer's name | me <state> <network> [-display ".."] [-username ..] [-email ..] [-device-name ..] [-follow on|off] |
| Ask for access, or see your requests and their answers | access <state> <network> [ask <device|service:name|lan:gateway> <ports> <8h|3d> <why>] |
| Use or ignore a network's names here | names <state> <network> on|off |
| Call a network by another short name here | relabel <state> <network> <new short name> |
| See a network's devices, and how this computer reaches each | devices <state> <network>, peers <state> <network> |
| Leave a network | leave <state> <network> |
| Details for support | diag <state> |
Commands for administrators
Each links to the page that explains it. Those marked command line have no screen in the app.
| To | Command |
|---|---|
| Running a network | |
| Install, or remove command line | install -yes, remove -yes |
| Create a network command line | init <state> <network> <this computer's name> <username> [-account ..] |
| Describe the network, and set its short name | org-info <state> <network> [-name ..] [-contact ..] [-description ..] [-website ..] [-short ..] |
| Your plan and licence command line | licence-status, licence, licence-seats |
| Invite and approve | |
| Invite | invite <state> <network> [-for username|service:name] [-hours 1-24] [-at elsewhere|-at ..|-to ..] |
| Approve a device | approve <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 devices | self-enrol <state> <network> on N|off |
| Delegations command line | delegate, undelegate, revoke-delegate |
| People and devices | |
| List people and devices | users, devices, peers |
| Add, rename, merge or remove a person, or give one a new ID | add-user <state> <network> "<display name>" [-username ..], set-user, merge-user [-new-id], remove-user [-contact ..] |
| Whether people change their own names | self-service <state> <network> on|off |
| Rename or remove a device | rename-device, revoke |
| Tags | set-tag, tag; remove-tag command line |
| How long devices stay | expire; device-term command line |
| Services | |
| List services | services <state> <network> |
| Create, change or remove a service | service <state> <network> add|set|remove <name> [-purpose server|gateway|relay|kiosk|other] [-contact ..] |
| Move a device to a service or a person | move-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 line | set-rules <state> <network> <file> |
| Names for your services | set-name <state> <network> <name> <device>|none [-broad-ok] |
| Gateways: ranges, domain and names command line | set-route <state> <network> <gateway> <range>[,<range>..] [domain] [-names <name>[=<address>],..] [-broad-ok] |
| Relays | set-relay <state> <network> <device> on|off |
| IPv6 inside the network command line | enable-ipv6 <state> <network> on|off |
| Requests for access | |
| See the network's requests | access <state> <network> |
| Approve, decline, or end early | access <state> <network> approve <n> [8h|3d] | decline <n> | end <n> [-ask <code> -yes] |
| Updates | |
| Hold updates back | hold-updates <state> <network> on|off |
| Take updates from a network | update-authority <state> <network> on|off |
| Approve a release, and versions command line | set-update, require-version, follow-stable |
| What's on offer, our latest release, install now, serve releases command line | update-status, check-update, install-update, host-release |
| Security keys and recovery | |
| Replace the admin key | rotate-admin-key <state> <network> |
| Recovery command line | recover, new-recovery, export-recovery |
| Several administrators | |
| Ask to be an administrator (on their computer), or stop asking | request-admin <state> <network> [-withdraw] |
| Make a computer that asked an administrator | add-admin <state> <network> <device> <admin code> |
| List or remove administrators | admins <state> <network>, remove-admin <state> <network> <device or admin key> |
| Activity and the audit trail | |
| Every change to the network, or save it | audit <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.