CLI uzziņu rokasgrāmata

Skatīt kā Markdown Rediģēt vietnē GitHub Dokumentācija vietnē 1675df8

Pamata lietojums

Vienkārši palaidiet komandu — argumenti nav nepieciešami:

Apvalks

npx termbridge

Tiek palaists viss: lokālais serveris, tmux sesija un noklusējuma Cloudflare tunelis.

termbridge palaišana bez apakškomandas ir līdzvērtīga termbridge start.

Varat arī palaist termbridge start tieši, norādot visus karodziņus:

Apvalks

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

Karodziņi

Karodziņš	Ko tas dara	Noklusējums
`--port <port>`	Izmanto konkrētu portu nejauša porta vietā	Nejaušs
`--proxy <port>`	Izmanto starpniekserveri lokālam izstrādes serverim (iespējo skatus Terminal/Preview)	-
`--session <name>`	Piešķir nosaukumu savai tmux sesijai	Ģenerēts automātiski
`--kill-on-exit`	Aizver tmux sesijas, kad Termbridge tiek aizvērts	Izslēgts
`--no-qr`	Nerāda QR kodu (noder skriptiem)	Izslēgts
`--no-tunnel`	Atspējo tuneli (nepieciešams `--public-url`)	Izslēgts
`--public-url <url>`	Publisks URL, ja tunelis ir atspējots	-
`--tunnel <provider>`	Tuneļa nodrošinātājs (`cloudflare` vai `none`)	cloudflare
`--tunnel-token <token>`	Izmanto nosaukta Cloudflare tuneļa tokenu (nepieciešams `--port`)	-
`--tunnel-url <url>`	Publisks URL nosauktajam tunelim (nepieciešams kopā ar `--tunnel-token`)	-
`--backend <backend>`	Termināļa aizmugursistēma (`tmux` vai `sandbox-daytona`)	tmux
`--sandbox-repo <url>`	Repozitorijs URL, ko klonēt Daytona smilškastē	-
`--sandbox-branch <branch>`	Atzarojums, ko izrakstīt smilškastē	-
`--sandbox-path <path>`	Repozitorija ceļš smilškastē	Atvasināts no repozitorija nosaukuma
`--sandbox-name <name>`	Smilškastes nosaukums	Nejaušs `termbridge-<hex>`
`--sandbox-preview-port <port>`	Priekšskatījuma ports smilškastē	-
`--sandbox-public`	Izveido publisku smilškasti	Izslēgts (ieslēgts tiešajā režīmā)
`--sandbox-direct`	Palaiž serveri Daytona smilškastē (bez tuneļa)	Izslēgts
`--dev-proxy-url <url>`	Novirza priekšskatījuma datplūsmu uz šo URL, nevis uz `localhost:<proxy port>` (izmanto izstrādes skripti)	-
`-h`, `--help`	Parāda palīdzības tekstu	-

Jebkura cita opcija izraisa kļūdu unknown option: <flag>. Karodziņa --version nav.

Karodziņam ir priekšroka pār tā vides mainīgo, izņemot vienu gadījumu: TERMBRIDGE_TUNNEL pašlaik pārraksta --tunnel un --no-tunnel (#5).

Piezīme Iebūvētajā termbridge --help izvadē joprojām ir norādīti --daytona-* karodziņi un --backend tmux | daytona. Šie nosaukumi tiek noraidīti; izmantojiet iepriekšējā tabulā norādītos --sandbox-* karodziņus un --backend sandbox-daytona (#1).

Piemēri

Pievienoties esošai tmux sesijai

Ja tmux sesija jau darbojas:

Apvalks

termbridge --session my-session

Fiksēts ports un pielāgota sesija

Apvalks

termbridge --port 8080 --session codex

Tīra aizvēršana (nepaliek sesijas)

Apvalks

termbridge --kill-on-exit

Skriptēšana (bez QR izvades)

Apvalks

termbridge --no-qr

Starpniekserveris Vite izstrādes serverim

Apvalks

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

# Then start Termbridge with proxy
termbridge --proxy 5173

Izmantojiet pogu Skati, lai pārslēgtos starp Terminal un Preview. Preview ielādē jūsu lietotni caur starpniekserveri un atbalsta HMR.

Nosaukts Cloudflare tunelis (ar tokenu)

Ja jums ir Cloudflare konts un vēlaties izvairīties no trycloudflare ātruma ierobežojumiem:

Apvalks

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

Atspējot tuneli (izmantot savu publisko URL)

Apvalks

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

Vides mainīgie

Termbridge nolasa vides mainīgos no čaulas un .env faila direktorijā, no kuras to palaižat. Čaulā jau iestatītiem mainīgajiem ir priekšroka pār mainīgajiem .env failā.

Pamatiestatījumi

Mainīgais	Ko tas dara
`TERMBRIDGE_SESSIONS=2`	Startējot izveido vairākas tmux sesijas
`TERMBRIDGE_TMUX_CWD=/path`	Darba direktorija jaunām tmux sesijām
`TERMBRIDGE_PUBLIC_URL=https://example.com`	Publisks URL, ja tunelis ir atspējots
`TERMBRIDGE_TUNNEL=none`	Atspējo tuneli
`TERMBRIDGE_TUNNEL_TOKEN=<token>`	Nosaukta tuneļa tokens (nepieciešams `TERMBRIDGE_TUNNEL_URL`)
`TERMBRIDGE_TUNNEL_URL=https://term.example.com`	Publisks URL nosauktajam tunelim

Papildu iestatījumi

Daytona tiešajā režīmā iestata šīs vērtības serverim, ko tas palaiž smilškastē. Varat tās iestatīt arī paši.

Mainīgais	Ko tas dara
`TERMBRIDGE_HOST=0.0.0.0`	Adrese, ar kuru serveris piesaistās (noklusējums `127.0.0.1`). Izdrukātajā lokālajā URL vienmēr tiek rādīts `127.0.0.1`.
`TERMBRIDGE_COOKIE_SAMESITE=lax`	Sesijas sīkdatnes `SameSite` vērtība: `lax`, `strict` vai `none` (noklusējums `Lax`, vai `None` tiešajā režīmā)
`TERMBRIDGE_SHARE_FILE=/path/share-url.txt`	Papildus ieraksta kopīgošanas URL šajā failā
`TERMBRIDGE_HIDE_TERMINAL_SWITCHER=1`	Paslēpj termināļa pārslēdzēju UI
`TERMBRIDGE_TMUX_PATH_PREFIX=/path/bin`	Pievieno šo pirms `PATH` katrā tmux sesijā, kuru Termbridge palaiž vai kurai pievienojas (tiek ievadīta sesijā kā `export` komanda)

Izstrāde

Mainīgais	Ko tas dara
`TERMBRIDGE_INSECURE_COOKIE=1`	Atļauj HTTP sīkdatnes (tikai lokālajā izstrādē)
`TERMBRIDGE_PROXY_PORT=5173`	Starpniekservera ports dev:beam:proxy skriptam
`TERMBRIDGE_DEV_UI=http://127.0.0.1:5000`	Pārraksta Vite izstrādes UI URL
`TERMBRIDGE_DEV_PORT=3000`	Pārraksta Termbridge servera portu izstrādes režīmā (noklusējums `8787`)
`TERMBRIDGE_DEV_SESSION=codex`	tmux sesijas nosaukums platformai `dev:beam` (noklusējums `codex`)
`TERMBRIDGE_SKIP_BUILD=1`	Izlaiž CLI būvēšanu `dev:beam` vidē

Smilškaste (Daytona)

Mainīgais	Ko tas dara
`TERMBRIDGE_BACKEND=sandbox-daytona`	Izmanto Daytona smilškastes aizmugursistēmu
`TERMBRIDGE_SANDBOX_DIRECT=true`	Palaiž Termbridge smilškastē
`TERMBRIDGE_SANDBOX_SERVER_PORT=8080`	Ports serverim smilškastē
`TERMBRIDGE_SANDBOX_AGENTS=claude-code,codex`	Automātiski instalē un sinhronizē autentifikāciju aģentiem
`TERMBRIDGE_SANDBOX_AGENT_ENV=...`	Papildu vides mainīgie, ko pārsūtīt
`TERMBRIDGE_SANDBOX_AGENT_AUTH_PATHS=...`	Lokālie autentifikācijas faili, ko sinhronizēt

Pilnu Daytona konfigurāciju skatiet Daytona rokasgrāmatā.

Termbridge apturēšana

Nospiediet Ctrl+C terminālī, kurā darbojas Termbridge. Tas:

Aizver tuneli (ja tas ir iespējots)
Aptur lokālo serveri
Atstāj tmux sesijas aktīvas (ja vien neizmantojāt --kill-on-exit)

Jūsu tmux sesijas pēc noklusējuma saglabājas, tāpēc vēlāk varat izveidot savienojumu no jauna.