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
| Command | What it does |
|---|---|
up | Starts the agent (idempotent — no-op if already running). New interactive shells you open will be wrapped and appear on your phone. |
down | Stops the agent and removes its control socket. Existing shells keep running; new ones are completely normal. |
status | Prints UP (with pid) or DOWN, and when up, lists the shells currently registered with the agent. |
pair | Performs 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, soup/downare 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_DISABLEbefore the shell starts, and that shell will never wrap:TERMBRIDGE_DISABLE=1 zshThis is handy for CI, scripts, or any context where you want a guaranteed-vanilla shell.
-
Globally —
termbridge downstops 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
| Path | What it is |
|---|---|
~/.config/termbridge/config | Agent config (relay URL, room, token) written at install. |
/tmp/termbridge-agent.log | Agent log — the first place to look when something’s off. |
~/.zshrc | Holds the marked hook block (# >>> termbridge >>> … # <<< termbridge <<<). |
Next
See Known limitations for the current boundaries.