Referencia CLI

Zobraziť ako Markdown Upraviť na GitHub Dokumentácia na 1675df8

Základné používanie

Stačí spustiť príkaz, argumenty nie sú potrebné:

Shell

npx termbridge

Tým sa spustí všetko: lokálny server, relácia tmux a predvolený tunel Cloudflare.

Spustenie termbridge bez podpríkazu je ekvivalentné príkazu termbridge start.

Môžete tiež explicitne spustiť termbridge start so všetkými príznakmi:

Shell

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

Príznaky

Príznak	Čo robí	Predvolená hodnota
`--port <port>`	Použije konkrétny port namiesto náhodného	Náhodný
`--proxy <port>`	Presmeruje lokálny vývojový server (povolí zobrazenia Terminál/Náhľad)	-
`--session <name>`	Pomenuje vašu reláciu tmux	Vygenerované automaticky
`--kill-on-exit`	Vyčistí relácie tmux po ukončení Termbridge	Vypnuté
`--no-qr`	Nevypíše kód QR (užitočné pre skripty)	Vypnuté
`--no-tunnel`	Vypne tunel (vyžaduje `--public-url`)	Vypnuté
`--public-url <url>`	Verejné URL pri vypnutom tuneli	-
`--tunnel <provider>`	Poskytovateľ tunela (`cloudflare` alebo `none`)	cloudflare
`--tunnel-token <token>`	Použije token pomenovaného tunela Cloudflare (vyžaduje `--port`)	-
`--tunnel-url <url>`	Verejné URL pre pomenovaný tunel (vyžaduje sa spolu s `--tunnel-token`)	-
`--backend <backend>`	Backend terminálu (`tmux` alebo `sandbox-daytona`)	tmux
`--sandbox-repo <url>`	Daytona sandbox, do ktorého sa klonuje URL URL repozitára	-
`--sandbox-branch <branch>`	Vetva, na ktorú sa v sandboxe prepne	-
`--sandbox-path <path>`	Cesta k repozitáru v sandboxe	Odvodená od názvu repozitára
`--sandbox-name <name>`	Názov sandboxu	Náhodný `termbridge-<hex>`
`--sandbox-preview-port <port>`	Port náhľadu v sandboxe	-
`--sandbox-public`	Vytvorí verejný sandbox	Vypnuté (v priamom režime zapnuté)
`--sandbox-direct`	Spustí server v sandboxe Daytona (bez tunela)	Vypnuté
`--dev-proxy-url <url>`	Presmeruje prevádzku náhľadu na tento URL namiesto `localhost:<proxy port>` (používajú ho vývojové skripty)	-
`-h`, `--help`	Vypíše text pomocníka	-

Každá iná možnosť spôsobí chybu unknown option: <flag>. Príznak --version neexistuje.

Príznak má prednosť pred premennou prostredia, s jednou výnimkou: TERMBRIDGE_TUNNEL momentálne prepisuje --tunnel a --no-tunnel (#5).

Poznámka Vstavaný výstup termbridge --help stále uvádza príznaky --daytona-* a --backend tmux | daytona. Tieto názvy sa odmietajú; použite príznaky --sandbox-* a --backend sandbox-daytona z tabuľky vyššie (#1).

Príklady

Pripojenie k existujúcej relácii tmux

Ak už máte spustenú reláciu tmux:

Shell

termbridge --session my-session

Pevný port a vlastná relácia

Shell

termbridge --port 8080 --session codex

Čisté ukončenie (bez zostávajúcich relácií)

Shell

termbridge --kill-on-exit

Skriptovanie (bez výstupu QR)

Shell

termbridge --no-qr

Presmerovanie vývojového servera Vite

Shell

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

# Then start Termbridge with proxy
termbridge --proxy 5173

Pomocou tlačidla Views môžete prepínať medzi zobrazeniami Terminál a Náhľad. Náhľad načíta vašu aplikáciu cez proxy s podporou HMR.

Pomenovaný tunel Cloudflare (založený na tokene)

Ak máte účet Cloudflare a chcete sa vyhnúť limitom frekvencie služby trycloudflare:

Shell

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

Vypnutie tunela (použitie vlastného verejného URL)

Shell

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

Premenné prostredia

Termbridge načítava premenné prostredia zo shellu a zo súboru .env v adresári, z ktorého ho spúšťate. Premenné nastavené v shelli majú prednosť pred súborom .env.

Základné nastavenia

Premenná	Čo robí
`TERMBRIDGE_SESSIONS=2`	Pri spustení vytvorí viacero relácií tmux
`TERMBRIDGE_TMUX_CWD=/path`	Pracovný adresár pre nové relácie tmux
`TERMBRIDGE_PUBLIC_URL=https://example.com`	Verejné URL pri vypnutom tuneli
`TERMBRIDGE_TUNNEL=none`	Vypne tunel
`TERMBRIDGE_TUNNEL_TOKEN=<token>`	Token pomenovaného tunela (vyžaduje `TERMBRIDGE_TUNNEL_URL`)
`TERMBRIDGE_TUNNEL_URL=https://term.example.com`	Verejné URL pre pomenovaný tunel

Rozšírené nastavenia

Priamy režim Daytona nastavuje tieto premenné pre server spustený v sandboxe. Môžete ich nastaviť aj sami.

Premenná	Čo robí
`TERMBRIDGE_HOST=0.0.0.0`	Adresa, na ktorej server počúva (predvolene `127.0.0.1`). Vypísaná lokálna adresa URL vždy zobrazuje `127.0.0.1`.
`TERMBRIDGE_COOKIE_SAMESITE=lax`	Hodnota `SameSite` relačnej cookie: `lax`, `strict` alebo `none` (predvolene `Lax`, alebo `None` v priamom režime)
`TERMBRIDGE_SHARE_FILE=/path/share-url.txt`	Zapíše zdieľací URL aj do tohto súboru
`TERMBRIDGE_HIDE_TERMINAL_SWITCHER=1`	Skryje prepínač terminálov v UI
`TERMBRIDGE_TMUX_PATH_PREFIX=/path/bin`	Pridá tento text pred `PATH` v každej relácii tmux, ktorú Termbridge spustí alebo ku ktorej sa pripojí (zadá sa do relácie ako príkaz `export`)

Vývoj

Premenná	Čo robí
`TERMBRIDGE_INSECURE_COOKIE=1`	Povolí cookies HTTP (iba lokálny vývoj)
`TERMBRIDGE_PROXY_PORT=5173`	Port proxy pre skript dev:beam:proxy
`TERMBRIDGE_DEV_UI=http://127.0.0.1:5000`	Prepíše vývojové UI Vite URL
`TERMBRIDGE_DEV_PORT=3000`	Prepíše port servera Termbridge vo vývoji (predvolene `8787`)
`TERMBRIDGE_DEV_SESSION=codex`	Názov relácie tmux pre `dev:beam` (predvolene `codex`)
`TERMBRIDGE_SKIP_BUILD=1`	Preskočí zostavenie CLI v `dev:beam`

Sandbox (Daytona)

Premenná	Čo robí
`TERMBRIDGE_BACKEND=sandbox-daytona`	Použije backend sandboxu Daytona
`TERMBRIDGE_SANDBOX_DIRECT=true`	Spustí Termbridge v sandboxe
`TERMBRIDGE_SANDBOX_SERVER_PORT=8080`	Port servera v sandboxe
`TERMBRIDGE_SANDBOX_AGENTS=claude-code,codex`	Automatická inštalácia a synchronizácia overovacích údajov pre agentov
`TERMBRIDGE_SANDBOX_AGENT_ENV=...`	Ďalšie premenné prostredia na preposlanie
`TERMBRIDGE_SANDBOX_AGENT_AUTH_PATHS=...`	Lokálne súbory overovacích údajov na synchronizáciu

Úplnú konfiguráciu Daytona nájdete v Daytona príručke.

Zastavenie Termbridge

Stlačte Ctrl+C v termináli, v ktorom beží Termbridge. Tým sa:

Zatvorí tunel (ak je povolený)
Zastaví lokálny server
Ponechajú aktívne relácie tmux (pokiaľ ste nepoužili --kill-on-exit)

Relácie tmux sú predvolene trvalé, takže sa k nim môžete neskôr znova pripojiť.