Skip to content

Commands

/port help

The help panel shows the commands available to you. Hover for details or click a command to fill the input. Console access is supported; console controls include the matching command as text.


The main command is /port; /portbridge and /pb are aliases. Each action uses its own permission.

CommandPurposePermission
/port or /port statusShow state, target, relay, uptime, latency, retries, and the latest errorportbridge.status
/port helpOpen command help and clickable suggestionsportbridge.status
/port address or /port ipShow and copy the public Minecraft addressportbridge.address
/port startPrepare the executable and start a tunnel in the backgroundportbridge.manage
/port stopClose the tunnel and cancel pending retriesportbridge.manage
/port restartStart a replacement tunnel sessionportbridge.manage
/port reloadValidate configuration and messages, then reconnect an active tunnelportbridge.reload

All permissions default to operators. portbridge.admin grants all four command permissions.


/port status
/port address

The status panel reports the resolved local listener, relay, public-check policy, connection timing, and latest diagnostic. The address panel provides Copy Address when a public address is available.

Copy controls use the Minecraft client’s clipboard action. Share the copied address with friends for Multiplayer > Direct Connection. An allocated address with public checks disabled does not establish a verified Minecraft route; see tunnels and relays.


/port start
/port stop
/port restart

Start prepares the connection asynchronously. Starting an already running or preparing tunnel reports its current condition. Stop closes the tunnel and cancels retries; stopping an already stopped tunnel reports that it is stopped.

Restart opens a replacement session. Remote players can disconnect and the public address can change, so request the current address again afterward.


/port reload

Reload validates both config.yml and messages.yml before applying replacements. Invalid settings or messages reject the reload and leave the previous configuration active.

An active tunnel reconnects with the new settings. An explicitly stopped tunnel stays stopped. If startup was still scheduled, reload cancels the pending task and reschedules it only when automatic startup remains enabled.


Panels show Start, Stop, Restart, and Refresh according to the sender’s command permissions. These buttons dispatch the same handlers as typed commands.

All labels, hover text, command replies, and framework permission/error replies are configurable through messages.yml. Diagnostic reasons can contain original I/O or Bore output.