CLI referencia

Megtekintés Markdownként Szerkesztés itt: GitHub Dokumentáció itt: 1675df8

Alapvető használat

Csak futtasd a parancsot – nincs szükség argumentumokra:

Shell

npx termbridge

Ezzel minden elindul: a helyi szerver, a tmux munkamenet és az alapértelmezett Cloudflare alagút.

A termbridge alparancs nélküli futtatása egyenértékű ezzel: termbridge start.

A termbridge start parancsot az összes kapcsolóval együtt külön is futtathatod:

Shell

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

Kapcsolók

Kapcsoló	Működése	Alapértelmezés
`--port <port>`	Meghatározott port használata véletlenszerű helyett	Véletlenszerű
`--proxy <port>`	Helyi fejlesztői szerver proxyn továbbítása (engedélyezi a Terminal/Preview nézeteket)	-
`--session <name>`	A tmux munkamenet elnevezése	Automatikusan generált
`--kill-on-exit`	A Termbridge kilépésekor a tmux munkamenetek lezárása	Ki
`--no-qr`	A QR kód kiírásának mellőzése (szkriptekhez hasznos)	Ki
`--no-tunnel`	Az alagút letiltása (a `--public-url` szükséges hozzá)	Ki
`--public-url <url>`	Nyilvános URL, ha az alagút le van tiltva	-
`--tunnel <provider>`	Alagútszolgáltató (`cloudflare` vagy `none`)	cloudflare
`--tunnel-token <token>`	Névvel ellátott Cloudflare Tunnel-token használata (a `--port` szükséges hozzá)	-
`--tunnel-url <url>`	Nyilvános URL a névvel ellátott alagúthoz (a `--tunnel-token` esetén kötelező)	-
`--backend <backend>`	Terminálháttér (`tmux` vagy `sandbox-daytona`)	tmux
`--sandbox-repo <url>`	Repó URL klónozása a Daytona sandboxba	-
`--sandbox-branch <branch>`	A sandboxban kijelentkezendő ág	-
`--sandbox-path <path>`	Repó útvonala a sandboxban	A repó nevéből származtatva
`--sandbox-name <name>`	Sandbox neve	Véletlenszerű `termbridge-<hex>`
`--sandbox-preview-port <port>`	Előnézeti port a sandboxban	-
`--sandbox-public`	Nyilvános sandbox létrehozása	Ki (közvetlen módban be)
`--sandbox-direct`	A szerver futtatása a Daytona sandboxban (alagút nélkül)	Ki
`--dev-proxy-url <url>`	Az előnézeti forgalom továbbítása erre: URL, nem erre: `localhost:<proxy port>` (a fejlesztői szkriptek használják)	-
`-h`, `--help`	Súgószöveg kiírása	-

Minden más beállítási lehetőség hibát eredményez: unknown option: <flag>. Nincs --version kapcsoló.

A kapcsoló felülbírálja a hozzá tartozó környezeti változót, egy kivétellel: a TERMBRIDGE_TUNNEL jelenleg felülbírálja a --tunnel és a --no-tunnel értékét (#5).

Megjegyzés A beépített termbridge --help kimenete továbbra is felsorolja a --daytona-* kapcsolókat és a --backend tmux | daytona értékeket. Ezeket a neveket a rendszer elutasítja; a fenti táblázatban szereplő --sandbox-* kapcsolókat és --backend sandbox-daytona értékeket használd (#1).

Példák

Csatlakozás meglévő tmux munkamenethez

Ha már fut egy tmux munkameneted:

Shell

termbridge --session my-session

Rögzített port és egyéni munkamenet

Shell

termbridge --port 8080 --session codex

Tiszta kilépés (nem maradnak hátra munkamenetek)

Shell

termbridge --kill-on-exit

Szkriptelés (QR kimenet nélkül)

Shell

termbridge --no-qr

Vite fejlesztői szerver proxyn továbbítása

Shell

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

# Then start Termbridge with proxy
termbridge --proxy 5173

A Terminal és a Preview közötti váltáshoz használd a Views gombot. A Preview az alkalmazásodat a proxyn keresztül tölti be, HMR-támogatással.

Névvel ellátott Cloudflare alagút (tokenalapú)

Ha van Cloudflare-fiókod, és el szeretnéd kerülni a trycloudflare sebességkorlátait:

Shell

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

Az alagút letiltása (saját nyilvános URL használata)

Shell

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

Környezeti változók

A Termbridge a shellből és a futtatási könyvtárban található .env fájlból olvassa be a környezeti változókat. A shellben már beállított változók elsőbbséget élveznek az .env fájlban lévőkkel szemben.

Alapbeállítások

Változó	Működése
`TERMBRIDGE_SESSIONS=2`	Több tmux munkamenet létrehozása induláskor
`TERMBRIDGE_TMUX_CWD=/path`	A létrehozandó tmux munkamenetek munkakönyvtára
`TERMBRIDGE_PUBLIC_URL=https://example.com`	Nyilvános URL, ha az alagút le van tiltva
`TERMBRIDGE_TUNNEL=none`	Az alagút letiltása
`TERMBRIDGE_TUNNEL_TOKEN=<token>`	Névvel ellátott alagút tokenje (a `TERMBRIDGE_TUNNEL_URL` szükséges hozzá)
`TERMBRIDGE_TUNNEL_URL=https://term.example.com`	Nyilvános URL a névvel ellátott alagúthoz

Haladó beállítások

A Daytona közvetlen módja ezeket a beállításokat alkalmazza a sandboxon belül futó szerverhez. Saját magad is beállíthatod őket.

Változó	Működése
`TERMBRIDGE_HOST=0.0.0.0`	A cím, amelyhez a szerver kapcsolódik (alapértelmezés: `127.0.0.1`). A kiírt helyi URL mindig `127.0.0.1` értéket mutat.
`TERMBRIDGE_COOKIE_SAMESITE=lax`	A munkamenet-süti `SameSite` értéke: `lax`, `strict` vagy `none` (alapértelmezés: `Lax`, közvetlen módban pedig `None`)
`TERMBRIDGE_SHARE_FILE=/path/share-url.txt`	A megosztási URL mentése ebbe a fájlba is
`TERMBRIDGE_HIDE_TERMINAL_SWITCHER=1`	A terminálváltó elrejtése a UI felületen
`TERMBRIDGE_TMUX_PATH_PREFIX=/path/bin`	Ennek hozzáfűzése a `PATH` értékhez minden olyan tmux munkamenetben, amelyhez a Termbridge csatlakozik vagy amelyet elindít (a munkamenetbe `export` parancsként írja be)

Fejlesztés

Változó	Működése
`TERMBRIDGE_INSECURE_COOKIE=1`	HTTP sütik engedélyezése (csak helyi fejlesztéshez)
`TERMBRIDGE_PROXY_PORT=5173`	Proxyport a dev:beam:proxy szkripthez
`TERMBRIDGE_DEV_UI=http://127.0.0.1:5000`	A Vite fejlesztési UI URL felülbírálása
`TERMBRIDGE_DEV_PORT=3000`	A Termbridge szerverport felülbírálása fejlesztéskor (alapértelmezés: `8787`)
`TERMBRIDGE_DEV_SESSION=codex`	tmux munkamenetnév a `dev:beam` számára (alapértelmezés: `codex`)
`TERMBRIDGE_SKIP_BUILD=1`	A `dev:beam` alatti CLI build kihagyása

Sandbox (Daytona)

Változó	Működése
`TERMBRIDGE_BACKEND=sandbox-daytona`	A Daytona sandbox-háttérrendszer használata
`TERMBRIDGE_SANDBOX_DIRECT=true`	A Termbridge futtatása a sandboxban
`TERMBRIDGE_SANDBOX_SERVER_PORT=8080`	A sandboxban futó szerver portja
`TERMBRIDGE_SANDBOX_AGENTS=claude-code,codex`	Automatikus telepítés és hitelesítés-szinkron az ügynökökhöz
`TERMBRIDGE_SANDBOX_AGENT_ENV=...`	Továbbítandó további környezeti változók
`TERMBRIDGE_SANDBOX_AGENT_AUTH_PATHS=...`	Szinkronizálandó helyi hitelesítési fájlok

A Daytona teljes konfigurációjáért lásd a Daytona útmutatót.

A Termbridge leállítása

Nyomja meg a Ctrl+C billentyűt abban a terminálban, ahol a Termbridge fut. Ez a következőket teszi:

Bezárja az alagutat (ha engedélyezve van)
Leállítja a helyi szervert
Életben tartja a tmux munkameneteket (kivéve, ha a --kill-on-exit opciót használta)

A tmux munkamenetek alapértelmezés szerint megmaradnak, így később újra csatlakozhat.