Referens för CLI

Visa som Markdown Redigera på GitHub Dokumentation på 1675df8

Grundläggande användning

Kör bara kommandot – inga argument behövs:

Shell

npx termbridge

Det här startar allt: lokal server, tmux-session och standardtunneln Cloudflare.

Att köra termbridge utan ett underkommando motsvarar termbridge start.

Du kan också köra termbridge start uttryckligen med alla flaggor:

Shell

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

Flaggor

Flagga	Funktion	Standardvärde
`--port <port>`	Använd en specifik port i stället för en slumpmässig	Slumpmässig
`--proxy <port>`	Proxy till en lokal utvecklingsserver (aktiverar vyerna Terminal/Preview)	-
`--session <name>`	Ge din tmux-session ett namn	Skapas automatiskt
`--kill-on-exit`	Rensa tmux-sessioner när Termbridge avslutas	Av
`--no-qr`	Skriv inte ut QR-koden (användbart i skript)	Av
`--no-tunnel`	Inaktivera tunneln (kräver `--public-url`)	Av
`--public-url <url>`	Offentlig URL när tunneln är inaktiverad	-
`--tunnel <provider>`	Tunnelleverantör (`cloudflare` eller `none`)	cloudflare
`--tunnel-token <token>`	Använd en namngiven Cloudflare Tunnel-token (kräver `--port`)	-
`--tunnel-url <url>`	Offentlig URL för den namngivna tunneln (krävs med `--tunnel-token`)	-
`--backend <backend>`	Terminalbackend (`tmux` eller `sandbox-daytona`)	tmux
`--sandbox-repo <url>`	Repo-URL som ska klonas till Daytona-sandlådan	-
`--sandbox-branch <branch>`	Gren att checka ut i sandlådan	-
`--sandbox-path <path>`	Reposökväg i sandlådan	Härledd från reponamnet
`--sandbox-name <name>`	Sandlådenamn	Slumpmässig `termbridge-<hex>`
`--sandbox-preview-port <port>`	Preview-port i sandlådan	-
`--sandbox-public`	Skapa en offentlig sandlåda	Av (på i direktläge)
`--sandbox-direct`	Kör servern i Daytona-sandlådan (ingen tunnel)	Av
`--dev-proxy-url <url>`	Proxytrafik för förhandsvisning till den här URL i stället för `localhost:<proxy port>` (används av utvecklingsskripten)	-
`-h`, `--help`	Skriv ut hjälptexten	-

Alla andra alternativ misslyckas med unknown option: <flag>. Det finns ingen --version-flagga.

En flagga har företräde framför sin miljövariabel, med ett undantag: TERMBRIDGE_TUNNEL åsidosätter för närvarande --tunnel och --no-tunnel (#5).

Obs! Den inbyggda utdata från termbridge --help listar fortfarande --daytona-*-flaggor och --backend tmux | daytona. De namnen avvisas; använd flaggorna --sandbox-* och --backend sandbox-daytona i tabellen ovan (#1).

Exempel

Anslut till en befintlig tmux-session

Om du redan har en tmux-session igång:

Shell

termbridge --session my-session

Fast port och anpassad session

Shell

termbridge --port 8080 --session codex

Avsluta utan kvarvarande sessioner

Shell

termbridge --kill-on-exit

Skript (utan utdata från QR)

Shell

termbridge --no-qr

Proxy för en Vite-utvecklingsserver

Shell

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

# Then start Termbridge with proxy
termbridge --proxy 5173

Använd knappen Views för att växla mellan Terminal och Preview. Preview läser in din app via proxyn med HMR-stöd.

Namngiven Cloudflare-tunnel (tokenbaserad)

Om du har ett Cloudflare-konto och vill undvika hastighetsbegränsningarna för trycloudflare:

Shell

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

Inaktivera tunneln (använd din egen offentliga URL)

Shell

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

Miljövariabler

Termbridge läser miljövariabler från skalet och från en .env-fil i katalogen där du kör det. Variabler som redan är inställda i skalet har företräde framför filen .env.

Kärninställningar

Variabel	Funktion
`TERMBRIDGE_SESSIONS=2`	Skapa flera tmux-sessioner vid start
`TERMBRIDGE_TMUX_CWD=/path`	Arbetskatalog för nya tmux-sessioner
`TERMBRIDGE_PUBLIC_URL=https://example.com`	Offentlig URL när tunneln är inaktiverad
`TERMBRIDGE_TUNNEL=none`	Inaktivera tunneln
`TERMBRIDGE_TUNNEL_TOKEN=<token>`	Token för namngiven tunnel (kräver `TERMBRIDGE_TUNNEL_URL`)
`TERMBRIDGE_TUNNEL_URL=https://term.example.com`	Offentlig URL för den namngivna tunneln

Avancerat

Daytona direktläge ställer in dessa för servern som körs i sandlådan. Du kan också ange dem själv.

Variabel	Funktion
`TERMBRIDGE_HOST=0.0.0.0`	Adressen som servern binder till (standard `127.0.0.1`). Den utskrivna lokala URL visar alltid `127.0.0.1`.
`TERMBRIDGE_COOKIE_SAMESITE=lax`	`SameSite`-värdet för sessionscookien: `lax`, `strict` eller `none` (standard `Lax`, eller `None` i direktläge)
`TERMBRIDGE_SHARE_FILE=/path/share-url.txt`	Skriv även delnings-URL till den här filen
`TERMBRIDGE_HIDE_TERMINAL_SWITCHER=1`	Dölj terminalväljaren i UI
`TERMBRIDGE_TMUX_PATH_PREFIX=/path/bin`	Lägg till detta före `PATH` i varje tmux-session som Termbridge startar eller ansluter till (skrivs in i sessionen som ett `export`-kommando)

Utveckling

Variabel	Funktion
`TERMBRIDGE_INSECURE_COOKIE=1`	Tillåt HTTP-cookies (endast lokal utveckling)
`TERMBRIDGE_PROXY_PORT=5173`	Proxyport för skriptet dev:beam:proxy
`TERMBRIDGE_DEV_UI=http://127.0.0.1:5000`	Åsidosätt Vite utvecklings-UI URL
`TERMBRIDGE_DEV_PORT=3000`	Åsidosätt Termbridge-serverport vid utveckling (standard `8787`)
`TERMBRIDGE_DEV_SESSION=codex`	tmux-sessionsnamn för `dev:beam` (standard `codex`)
`TERMBRIDGE_SKIP_BUILD=1`	Hoppa över bygget av CLI i `dev:beam`

Sandlåda (Daytona)

Variabel	Funktion
`TERMBRIDGE_BACKEND=sandbox-daytona`	Använd backend för sandlådan Daytona
`TERMBRIDGE_SANDBOX_DIRECT=true`	Kör Termbridge i sandlådan
`TERMBRIDGE_SANDBOX_SERVER_PORT=8080`	Port för servern i sandlådan
`TERMBRIDGE_SANDBOX_AGENTS=claude-code,codex`	Installera automatiskt och synkronisera autentisering för agenter
`TERMBRIDGE_SANDBOX_AGENT_ENV=...`	Extra miljövariabler att vidarebefordra
`TERMBRIDGE_SANDBOX_AGENT_AUTH_PATHS=...`	Lokala autentiseringsfiler att synkronisera

För fullständig konfiguration av Daytona, se guiden Daytona.

Stoppa Termbridge

Tryck på Ctrl+C i terminalen där Termbridge körs. Då:

Stängs tunneln (om den är aktiverad)
Stoppas den lokala servern
Förblir tmux-sessionerna aktiva (om du inte använde --kill-on-exit)

Dina tmux-sessioner finns kvar som standard, så att du kan återansluta senare.