Documentation

Commands

The complete TailMux CLI surface. The core is headless and scriptable — the GUI and menu bar are thin wrappers over these commands.

View as Markdown

Service#

tailmux initGenerate a starter config file.
tailmux config validateValidate the config, including suffix-overlap rejection.
tailmux upStart the router, PAC listener, and profiles in the foreground.
tailmux diag path <url> [--netcheck]Full route report: owner, peer visibility, direct vs. DERP, HTTP timing.
tailmux diag fetch --modes … <url>Repeated timing samples across transport modes.

License#

tailmux license statusShow activation status, the updates window, and devices used (e.g. 2/5).
tailmux license status -o jsonMachine-readable status for scripts and CI.
tailmux license activate <key>Activate TailMux and register this machine as a device (counts toward your device limit).
tailmux license deactivateRemove the key from this machine and free its device slot for another machine.
tailmux license purchaseOpen the page to buy a license.

Profiles#

tailmux profile listList configured profiles and their backends.
tailmux profile login <name>Authenticate a profile against its tailnet.
tailmux profile login --hostname <h>Log in with an explicit device hostname.
tailmux profile login <profile> --resetReset and re-authenticate a tailscaled compatibility profile. The recommended tsnet backend does not support --reset.
tailmux profile logout <name>Log a profile out of its tailnet.
tailmux profile status <name>Show one profile's connection status.
tailmux statusShow router and all profile status.

Routing#

tailmux test <host>Show which profile owns a hostname.
tailmux connect <host> <port>Open a raw TCP tunnel through the owning profile.
tailmux ssh [ssh args...] <host>Open an interactive SSH session routed through the profile that owns the host — wraps your system ssh with the right ProxyCommand.
tailmux dns query --profile <p> <host>Resolve a name through one selected profile.

PAC & proxy#

tailmux pac printPrint the generated proxy auto-config.
tailmux pac serveServe /proxy.pac on the PAC listener.
tailmux envPrint shell proxy exports for the current profiles.

Access#

tailmux run <cmd> …Run a command with HTTP traffic routed by profile.
tailmux tunnel --profile <p> --listen <addr> <target>Loopback TCP forward to a profile/IP target (RDP, SMB).
tailmux tunnel --listen <addr> <host:port>Loopback TCP forward without --profile; the profile is chosen from the target's suffix.

GUI & TUI#

tailmux gui serveStart the local web GUI and JSON API.
tailmux tui --target <url> --watchOpen the terminal dashboard for profiles and path reports.