Referenca CLI

Prikaži kot Markdown Uredi na GitHub Dokumentacija za 1675df8

Osnovna uporaba

Preprosto zaženite ukaz – argumenti niso potrebni:

Lupina

npx termbridge

S tem zaženete vse: lokalni strežnik, sejo tmux in privzeti tunel Cloudflare.

Zagon termbridge brez podukaza je enakovreden zagonu termbridge start.

termbridge start lahko zaženete tudi izrecno z vsemi zastavicami:

Lupina

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

Zastavice

Zastavica	Kaj počne	Privzeto
`--port <port>`	Uporabi določena vrata namesto naključnih	Naključno
`--proxy <port>`	Posreduje lokalni razvojni strežnik (omogoči pogleda Terminal/Preview)	-
`--session <name>`	Poimenujte sejo tmux	Samodejno ustvarjeno
`--kill-on-exit`	Ob izhodu Termbridge počisti seje tmux	Izklopljeno
`--no-qr`	Ne izpiše kode QR (uporabno za skripte)	Izklopljeno
`--no-tunnel`	Onemogoči tunel (zahteva `--public-url`)	Izklopljeno
`--public-url <url>`	Javni URL, ko je tunel onemogočen	-
`--tunnel <provider>`	Ponudnik tunela (`cloudflare` ali `none`)	cloudflare
`--tunnel-token <token>`	Uporabi žeton poimenovanega tunela Cloudflare (zahteva `--port`)	-
`--tunnel-url <url>`	Javni URL za poimenovani tunel (obvezen z `--tunnel-token`)	-
`--backend <backend>`	Zaledje terminala (`tmux` ali `sandbox-daytona`)	tmux
`--sandbox-repo <url>`	Naslov repozitorija URL za kloniranje v peskovnik Daytona	-
`--sandbox-branch <branch>`	Veja, ki jo želite prevzeti v peskovniku	-
`--sandbox-path <path>`	Pot do repozitorija v peskovniku	Izpeljana iz imena repozitorija
`--sandbox-name <name>`	Ime peskovnika	Naključno `termbridge-<hex>`
`--sandbox-preview-port <port>`	Vrata predogleda v peskovniku	-
`--sandbox-public`	Ustvari javni peskovnik	Izklopljeno (v neposrednem načinu vklopljeno)
`--sandbox-direct`	Zažene strežnik v peskovniku Daytona (brez tunela)	Izklopljeno
`--dev-proxy-url <url>`	Promet predogleda posreduje na ta URL namesto na `localhost:<proxy port>` (uporabljajo ga razvojne skripte)	-
`-h`, `--help`	Izpiše besedilo pomoči	-

Vsaka druga možnost povzroči napako unknown option: <flag>. Zastavice --version ni.

Zastavica ima prednost pred spremenljivko okolja, z eno izjemo: TERMBRIDGE_TUNNEL trenutno preglasi --tunnel in --no-tunnel (#5).

Opomba Vgrajeni izpis termbridge --help še vedno navaja zastavice --daytona-* in --backend tmux | daytona. Ta imena so zavrnjena; uporabite zastavice --sandbox-* in --backend sandbox-daytona iz zgornje tabele (#1).

Primeri

Povezava z obstoječo sejo tmux

Če seja tmux že teče:

Lupina

termbridge --session my-session

Fiksna vrata in seja po meri

Lupina

termbridge --port 8080 --session codex

Čist izhod (brez ostankov sej)

Lupina

termbridge --kill-on-exit

Skriptiranje (brez izpisa QR)

Lupina

termbridge --no-qr

Posredovanje razvojnega strežnika Vite

Lupina

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

# Then start Termbridge with proxy
termbridge --proxy 5173

Z gumbom Views preklapljajte med Terminalom in Preview. Preview naloži vašo aplikacijo prek posrednika s podporo za HMR.

Poimenovani tunel Cloudflare (na podlagi žetona)

Če imate račun Cloudflare in se želite izogniti omejitvam hitrosti za trycloudflare:

Lupina

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

Onemogočanje tunela (uporabite svoj javni URL)

Lupina

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

Spremenljivke okolja

Termbridge bere spremenljivke okolja iz lupine in datoteke .env v imeniku, iz katerega ga zaženete. Spremenljivke, ki so že nastavljene v lupini, imajo prednost pred datoteko .env.

Osnovne nastavitve

Spremenljivka	Kaj počne
`TERMBRIDGE_SESSIONS=2`	Ob zagonu ustvari več sej tmux
`TERMBRIDGE_TMUX_CWD=/path`	Delovni imenik za nove seje tmux
`TERMBRIDGE_PUBLIC_URL=https://example.com`	Javni URL, ko je tunel onemogočen
`TERMBRIDGE_TUNNEL=none`	Onemogoči tunel
`TERMBRIDGE_TUNNEL_TOKEN=<token>`	Žeton poimenovanega tunela (zahteva `TERMBRIDGE_TUNNEL_URL`)
`TERMBRIDGE_TUNNEL_URL=https://term.example.com`	Javni URL za poimenovani tunel

Napredno

Neposredni način Daytona nastavi te vrednosti za strežnik, ki ga zažene v peskovniku. Nastavite jih lahko tudi sami.

Spremenljivka	Kaj počne
`TERMBRIDGE_HOST=0.0.0.0`	Naslov, na katerem strežnik sprejema povezave (privzeto `127.0.0.1`). Izpisani lokalni URL vedno prikazuje `127.0.0.1`.
`TERMBRIDGE_COOKIE_SAMESITE=lax`	Vrednost `SameSite` sejnega piškotka: `lax`, `strict` ali `none` (privzeto `Lax` oziroma `None` v neposrednem načinu)
`TERMBRIDGE_SHARE_FILE=/path/share-url.txt`	Deljeni URL zapiše tudi v to datoteko
`TERMBRIDGE_HIDE_TERMINAL_SWITCHER=1`	Skrije preklopnik terminalov v UI
`TERMBRIDGE_TMUX_PATH_PREFIX=/path/bin`	To doda pred `PATH` v vsaki seji tmux, ki jo Termbridge zažene ali se nanjo poveže (v sejo vnese kot ukaz `export`)

Razvoj

Spremenljivka	Kaj počne
`TERMBRIDGE_INSECURE_COOKIE=1`	Dovoli piškotke HTTP (samo lokalni razvoj)
`TERMBRIDGE_PROXY_PORT=5173`	Vrata posrednika za skripto dev:beam:proxy
`TERMBRIDGE_DEV_UI=http://127.0.0.1:5000`	Preglasi razvojni UI za Vite URL
`TERMBRIDGE_DEV_PORT=3000`	Preglasi vrata strežnika Termbridge v razvojnem načinu (privzeto `8787`)
`TERMBRIDGE_DEV_SESSION=codex`	Ime seje tmux za `dev:beam` (privzeto `codex`)
`TERMBRIDGE_SKIP_BUILD=1`	Preskoči gradnjo CLI v `dev:beam`

Peskovnik (Daytona)

Spremenljivka	Kaj počne
`TERMBRIDGE_BACKEND=sandbox-daytona`	Uporabi zaledje peskovnika Daytona
`TERMBRIDGE_SANDBOX_DIRECT=true`	Zažene Termbridge v peskovniku
`TERMBRIDGE_SANDBOX_SERVER_PORT=8080`	Vrata strežnika v peskovniku
`TERMBRIDGE_SANDBOX_AGENTS=claude-code,codex`	Samodejna namestitev in sinhronizacija preverjanja pristnosti za agente
`TERMBRIDGE_SANDBOX_AGENT_ENV=...`	Dodatne spremenljivke okolja za posredovanje
`TERMBRIDGE_SANDBOX_AGENT_AUTH_PATHS=...`	Lokalne datoteke za preverjanje pristnosti, ki jih želite sinhronizirati

Za celotno konfiguracijo Daytona glejte vodnik Daytona.

Zaustavitev Termbridge

Pritisnite Ctrl+C v terminalu, kjer se izvaja Termbridge. S tem:

Zapre tunel (če je omogočen)
Ustavi lokalni strežnik
Pusti seje tmux aktivne (razen če ste uporabili --kill-on-exit)

Seje tmux so privzeto obstojne, zato se lahko pozneje znova povežete.