Reference CLI

Zobrazit jako Markdown Upravit na GitHub Dokumentace na 1675df8

Základní použití

Stačí spustit příkaz – bez argumentů:

Shell

npx termbridge

Tím se spustí vše: místní server, relace tmux a výchozí tunel Cloudflare.

Spuštění termbridge bez podřízeného příkazu odpovídá příkazu termbridge start.

Můžete také spustit termbridge start výslovně se všemi příznaky:

Shell

termbridge start --port 8080 --proxy 5173 --session dev --kill-on-exit --no-qr --tunnel cloudflare

Příznaky

Příznak	Funkce	Výchozí hodnota
`--port <port>`	Použije konkrétní port místo náhodného	Náhodný
`--proxy <port>`	Předává místní vývojový server proxy (povolí pohledy Terminál/Náhled)	-
`--session <name>`	Pojmenuje relaci tmux	Vygenerováno automaticky
`--kill-on-exit`	Po ukončení Termbridge uklidí relace tmux	Vypnuto
`--no-qr`	Nevypisuje kód QR (užitečné pro skripty)	Vypnuto
`--no-tunnel`	Zakáže tunel (vyžaduje `--public-url`)	Vypnuto
`--public-url <url>`	Veřejné URL při vypnutém tunelu	-
`--tunnel <provider>`	Poskytovatel tunelu (`cloudflare` nebo `none`)	cloudflare
`--tunnel-token <token>`	Použije token pojmenovaného tunelu Cloudflare (vyžaduje `--port`)	-
`--tunnel-url <url>`	Veřejné URL pro pojmenovaný tunel (vyžadováno s `--tunnel-token`)	-
`--backend <backend>`	Backend terminálu (`tmux` nebo `sandbox-daytona`)	tmux
`--sandbox-repo <url>`	Repo URL ke klonování do sandboxu Daytona	-
`--sandbox-branch <branch>`	Větev k přepnutí v sandboxu	-
`--sandbox-path <path>`	Cesta k repozitáři v sandboxu	Odvozeno z názvu repozitáře
`--sandbox-name <name>`	Název sandboxu	Náhodný `termbridge-<hex>`
`--sandbox-preview-port <port>`	Port náhledu v sandboxu	-
`--sandbox-public`	Vytvoří veřejný sandbox	Vypnuto (v přímém režimu zapnuto)
`--sandbox-direct`	Spustí server uvnitř sandboxu Daytona (bez tunelu)	Vypnuto
`--dev-proxy-url <url>`	Předává provoz náhledu na tento URL místo `localhost:<proxy port>` (používají vývojové skripty)	-
`-h`, `--help`	Vypíše text nápovědy	-

Jakákoli jiná možnost skončí chybou unknown option: <flag>. Příznak --version neexistuje.

Příznak má přednost před proměnnou prostředí, s jedinou výjimkou: TERMBRIDGE_TUNNEL aktuálně přebíjí --tunnel a --no-tunnel (#5).

Poznámka Vestavěný výstup termbridge --help stále uvádí příznaky --daytona-* a --backend tmux | daytona. Tyto názvy jsou odmítnuty; použijte příznaky --sandbox-* a --backend sandbox-daytona z výše uvedené tabulky (#1).

Příklady

Připojení k existující relaci tmux

Pokud už máte spuštěnou relaci tmux:

Shell

termbridge --session my-session

Pevný port a vlastní relace

Shell

termbridge --port 8080 --session codex

Čisté ukončení (bez zbývajících relací)

Shell

termbridge --kill-on-exit

Skriptování (bez výstupu QR)

Shell

termbridge --no-qr

Předávání vývojového serveru Vite přes proxy

Shell

# Start your Vite app first
cd my-app && npm run dev  # runs on port 5173

# Then start Termbridge with proxy
termbridge --proxy 5173

Tlačítkem Pohledy přepnete mezi Terminálem a Náhledem. Náhled načítá vaši aplikaci přes proxy s podporou HMR.

Pojmenovaný tunel Cloudflare (na základě tokenu)

Pokud máte účet Cloudflare a chcete se vyhnout limitům četnosti služby trycloudflare:

Shell

termbridge --port 8080 --tunnel-token <TOKEN> --tunnel-url https://term.example.com

Vypnutí tunelu (použijte vlastní veřejné URL)

Shell

termbridge --no-tunnel --public-url https://example.com

Proměnné prostředí

Termbridge načítá proměnné prostředí ze shellu a ze souboru .env v adresáři, ze kterého jej spustíte. Proměnné již nastavené v shellu mají přednost před souborem .env.

Základní nastavení

Proměnná	Funkce
`TERMBRIDGE_SESSIONS=2`	Při spuštění vytvoří více relací tmux
`TERMBRIDGE_TMUX_CWD=/path`	Pracovní adresář pro nové relace tmux
`TERMBRIDGE_PUBLIC_URL=https://example.com`	Veřejné URL při vypnutém tunelu
`TERMBRIDGE_TUNNEL=none`	Zakáže tunel
`TERMBRIDGE_TUNNEL_TOKEN=<token>`	Token pojmenovaného tunelu (vyžaduje `TERMBRIDGE_TUNNEL_URL`)
`TERMBRIDGE_TUNNEL_URL=https://term.example.com`	Veřejné URL pro pojmenovaný tunel

Pokročilé nastavení

Přímý režim Daytona nastaví tyto proměnné pro server spuštěný uvnitř sandboxu. Nastavit je můžete také sami.

Proměnná	Funkce
`TERMBRIDGE_HOST=0.0.0.0`	Adresa, na které server naslouchá (výchozí `127.0.0.1`). Vypsaná místní adresa URL vždy zobrazuje `127.0.0.1`.
`TERMBRIDGE_COOKIE_SAMESITE=lax`	Hodnota relační cookie `SameSite`: `lax`, `strict` nebo `none` (výchozí `Lax`, v přímém režimu `None`)
`TERMBRIDGE_SHARE_FILE=/path/share-url.txt`	Zapíše také sdílecí URL do tohoto souboru
`TERMBRIDGE_HIDE_TERMINAL_SWITCHER=1`	Skryje přepínač terminálu v UI
`TERMBRIDGE_TMUX_PATH_PREFIX=/path/bin`	Přidá tento text před `PATH` v každé relaci tmux, ke které se Termbridge připojí nebo kterou spustí (zadá se do relace jako příkaz `export`)

Vývoj

Proměnná	Funkce
`TERMBRIDGE_INSECURE_COOKIE=1`	Povolí cookie HTTP (pouze místní vývoj)
`TERMBRIDGE_PROXY_PORT=5173`	Port proxy pro skript dev:beam:proxy
`TERMBRIDGE_DEV_UI=http://127.0.0.1:5000`	Přepíše vývojové UI URL Vite
`TERMBRIDGE_DEV_PORT=3000`	Přepíše port serveru Termbridge ve vývojovém režimu (výchozí `8787`)
`TERMBRIDGE_DEV_SESSION=codex`	Název relace tmux pro `dev:beam` (výchozí `codex`)
`TERMBRIDGE_SKIP_BUILD=1`	Přeskočí sestavení CLI v `dev:beam`

Sandbox (Daytona)

Proměnná	Funkce
`TERMBRIDGE_BACKEND=sandbox-daytona`	Použije backend sandboxu Daytona
`TERMBRIDGE_SANDBOX_DIRECT=true`	Spustí Termbridge uvnitř sandboxu
`TERMBRIDGE_SANDBOX_SERVER_PORT=8080`	Port serveru v sandboxu
`TERMBRIDGE_SANDBOX_AGENTS=claude-code,codex`	Automatická instalace + synchronizace ověřovacích údajů pro agenty
`TERMBRIDGE_SANDBOX_AGENT_ENV=...`	Další proměnné prostředí k předání
`TERMBRIDGE_SANDBOX_AGENT_AUTH_PATHS=...`	Místní ověřovací soubory k synchronizaci

Úplnou konfiguraci Daytona najdete v Daytona příručce.

Ukončení Termbridge

Stiskněte Ctrl+C v terminálu, ve kterém běží Termbridge. Tím se:

Zavře tunel (pokud je povolen)
Zastaví místní server
Zachovají relace tmux (pokud jste nepoužili --kill-on-exit)

Vaše relace tmux ve výchozím nastavení přetrvají, takže se k nim můžete později znovu připojit.