Liigu sisu juurde

CLI viide

Vaata Markdownina Muuda teenuses GitHub Dokumentatsioon: 1675df8

Põhikasutus

Käivitage lihtsalt käsk – argumente pole vaja:

Shell
npx termbridge

See käivitab kõik vajaliku: kohaliku serveri, tmux-seansi ja vaikimisi tunneli Cloudflare kaudu.

Käsu termbridge käivitamine ilma alamkäsuta on samaväärne käsuga termbridge start.

Samuti saate käivitada termbridge start selgesõnaliselt koos kõigi lippudega:

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

Lipud

Lipp Funktsioon Vaikimisi
--port <port> Kasutab juhusliku pordi asemel kindlat porti Juhuslik
--proxy <port> Suunab kohaliku arendusserveri puhverserveri kaudu (lubab Terminali/eelvaate vaated) -
--session <name> Annab tmux-seansile nime Automaatselt loodud
--kill-on-exit Koristab tmux-seansid, kui Termbridge sulgub Väljas
--no-qr Ei prindi QR-koodi (kasulik skriptides) Väljas
--no-tunnel Keelab tunneli (nõuab valikut --public-url) Väljas
--public-url <url> Avalik URL, kui tunnel on keelatud -
--tunnel <provider> Tunneli pakkuja (cloudflare või none) cloudflare
--tunnel-token <token> Kasutab nimega Cloudflare Tunneli tokenit (nõuab valikut --port) -
--tunnel-url <url> Nimega tunneli avalik URL (kohustuslik koos valikuga --tunnel-token) -
--backend <backend> Terminali taustaprogramm (tmux või sandbox-daytona) tmux
--sandbox-repo <url> Hoidla URL, mis kloonitakse Daytona-liivakasti -
--sandbox-branch <branch> Liivakastis väljaregistreeritav haru -
--sandbox-path <path> Hoidla asukoht liivakastis Tuletatakse hoidla nimest
--sandbox-name <name> Liivakasti nimi Juhuslik termbridge-<hex>
--sandbox-preview-port <port> Eelvaate port liivakastis -
--sandbox-public Loob avaliku liivakasti Väljas (otseses režiimis sees)
--sandbox-direct Käivitab serveri liivakastis Daytona (tunnelita) Väljas
--dev-proxy-url <url> Suunab eelvaateliikluse sellesse URL-i, mitte väärtusesse localhost:<proxy port> (kasutavad arendusskriptid) -
-h, --help Prindib abiteksti -

Kõik muud suvandid põhjustavad vea unknown option: <flag>. Lippu --version pole olemas.

Lipp on keskkonnamuutujast tähtsam, ühe erandiga: praegu kirjutab TERMBRIDGE_TUNNEL üle väärtused --tunnel ja --no-tunnel (#5).

Märkus Sisseehitatud väljund termbridge --help loetleb endiselt lipud --daytona-* ja väärtused --backend tmux | daytona. Need nimed lükatakse tagasi; kasutage ülaltoodud tabeli lippe --sandbox-* ja väärtusi --backend sandbox-daytona (#1).

Näited

Olemasoleva tmux-seansiga liitumine

Kui teil juba töötab tmux-seanss:

Shell
termbridge --session my-session

Kindel port ja kohandatud seanss

Shell
termbridge --port 8080 --session codex

Puhas sulgemine (mahajäänud seanssideta)

Shell
termbridge --kill-on-exit

Skriptimine (väljundita QR)

Shell
termbridge --no-qr

Vite arendusserveri suunamine puhverserveri kaudu

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

# Then start Termbridge with proxy
termbridge --proxy 5173

Terminali ja eelvaate vahel vahetamiseks kasutage nuppu Views. Eelvaade laadib teie rakenduse puhverserveri kaudu ning toetab HMR-i.

Nimega Cloudflare tunnel (tokenipõhine)

Kui teil on konto Cloudflare ja soovite vältida trycloudflare'i kiiruspiiranguid:

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

Tunneli keelamine (kasutage enda avalikku URL-i)

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

Keskkonnamuutujad

Termbridge loeb keskkonnamuutujaid käsureast ja käivituskataloogi failist .env. Käsureas juba määratud muutujad on faili .env väärtustest ülimuslikud.

Põhiseaded

Muutuja Funktsioon
TERMBRIDGE_SESSIONS=2 Loob käivitamisel mitu tmux-seanssi
TERMBRIDGE_TMUX_CWD=/path Uute tmux-seansside töökataloog
TERMBRIDGE_PUBLIC_URL=https://example.com Avalik URL, kui tunnel on keelatud
TERMBRIDGE_TUNNEL=none Keelab tunneli
TERMBRIDGE_TUNNEL_TOKEN=<token> Nimega tunneli token (nõuab väärtust TERMBRIDGE_TUNNEL_URL)
TERMBRIDGE_TUNNEL_URL=https://term.example.com Nimega tunneli avalik URL

Täpsemad seaded

Daytona otseržiim määrab need serveri jaoks, mida see liivakastis käitab. Saate need ka ise määrata.

Muutuja Mida see teeb
TERMBRIDGE_HOST=0.0.0.0 Aadress, millega server seondub (vaikimisi 127.0.0.1). Prinditud kohalik URL näitab alati 127.0.0.1.
TERMBRIDGE_COOKIE_SAMESITE=lax Seansiküpsise SameSite väärtus: lax, strict või none (vaikimisi Lax või otseühenduse režiimis None)
TERMBRIDGE_SHARE_FILE=/path/share-url.txt Kirjuta jagamis-URL ka sellesse faili
TERMBRIDGE_HIDE_TERMINAL_SWITCHER=1 Peida terminalivahetaja UI-s
TERMBRIDGE_TMUX_PATH_PREFIX=/path/bin Lisa see iga tmux-seansi Termbridge ette, millega PATH käivitub või ühendub (sisestatakse seanssi export-käsuna)

Arendus

Muutuja Mida see teeb
TERMBRIDGE_INSECURE_COOKIE=1 Luba HTTP-küpsised (ainult kohalikus arenduskeskkonnas)
TERMBRIDGE_PROXY_PORT=5173 dev:beam:proxy-skripti puhverserveri port
TERMBRIDGE_DEV_UI=http://127.0.0.1:5000 Tühista arenduskeskkonna Vite UI URL
TERMBRIDGE_DEV_PORT=3000 Tühista arenduskeskkonna Termbridge serveri port (vaikimisi 8787)
TERMBRIDGE_DEV_SESSION=codex dev:beam jaoks mõeldud tmux seansi nimi (vaikimisi codex)
TERMBRIDGE_SKIP_BUILD=1 Jäta dev:beam-s CLIi järk vahele

Liivakast (Daytona)

Muutuja Mida see teeb
TERMBRIDGE_BACKEND=sandbox-daytona Kasuta Daytonai liivakastitaustaprogrammi
TERMBRIDGE_SANDBOX_DIRECT=true Käivita Termbridge liivakastis
TERMBRIDGE_SANDBOX_SERVER_PORT=8080 Liivakastis töötava serveri port
TERMBRIDGE_SANDBOX_AGENTS=claude-code,codex Paigalda automaatselt ja sünkrooni agentide autentimine
TERMBRIDGE_SANDBOX_AGENT_ENV=... Edastatavad täiendavad keskkonnamuutujad
TERMBRIDGE_SANDBOX_AGENT_AUTH_PATHS=... Sünkroonitavad kohalikud autentimisfailid

Täieliku Daytona konfiguratsiooni kohta vaadake Daytona juhend.

Termbridge peatamine

Vajutage Ctrl+C terminalis, kus Termbridge töötab. See:

  • Sulgeb tunneli (kui see on lubatud)
  • Peatab kohaliku serveri
  • Jätab tmux seansid aktiivseks (kui te ei kasutanud --kill-on-exit)

Teie tmux seansid jäävad vaikimisi alles, nii et saate hiljem uuesti ühenduda.