TermBridge logo TermBridge Docs

CLI reference

When you install via the menu-bar app, the background agent is managed for you under launchd — you don’t normally need the command line. But a termbridge CLI ships alongside the agent for status checks, manual control, and scripting.

Commands

termbridge up        # start the agent — new shells will connect
termbridge down      # stop the agent — new shells are normal again
termbridge status    # is the agent up? list the registered shells
termbridge pair      # run the pairing exchange from the terminal
CommandWhat it does
upStarts the agent (idempotent — no-op if already running). New interactive shells you open will be wrapped and appear on your phone.
downStops the agent and removes its control socket. Existing shells keep running; new ones are completely normal.
statusPrints UP (with pid) or DOWN, and when up, lists the shells currently registered with the agent.
pairPerforms the pairing key exchange from the terminal (the menu-bar QR is the usual path — see Pairing).

Menu-bar app vs. CLI. The shipped app keeps the agent running under launchd, so up/down are mainly for manual or scripted control. The gating that matters day-to-day is the control socket: when the agent is up, new shells wrap; when it’s down, they don’t.

Turning wrapping off without uninstalling

You don’t have to uninstall to get a plain shell. Two ways:

  • Per shell / per session — set TERMBRIDGE_DISABLE before the shell starts, and that shell will never wrap:

    TERMBRIDGE_DISABLE=1 zsh

    This is handy for CI, scripts, or any context where you want a guaranteed-vanilla shell.

  • Globallytermbridge down stops the agent, so all new shells are normal until you bring it back up.

Either way, the hook always fails safe: if the agent is down or the wrapper is missing, you simply get a normal shell.

Files & paths

PathWhat it is
~/.config/termbridge/configAgent config (relay URL, room, token) written at install.
/tmp/termbridge-agent.logAgent log — the first place to look when something’s off.
~/.zshrcHolds the marked hook block (# >>> termbridge >>># <<< termbridge <<<).

Next

See Known limitations for the current boundaries.