Αναφορά CLI

Προβολή ως Markdown Επεξεργασία στο GitHub Τεκμηρίωση στο 1675df8

Βασική χρήση

Απλώς εκτελέστε την εντολή — δεν χρειάζονται ορίσματα:

Κέλυφος

npx termbridge

Αυτό εκκινεί τα πάντα: τον τοπικό διακομιστή, μια συνεδρία tmux και την προεπιλεγμένη σήραγγα Cloudflare.

Η εκτέλεση του termbridge χωρίς υποεντολή ισοδυναμεί με το termbridge start.

Μπορείτε επίσης να εκτελέσετε ρητά το termbridge start με όλες τις σημαίες:

Κέλυφος

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

Σημαίες

Σημαία	Τι κάνει	Προεπιλογή
`--port <port>`	Χρήση συγκεκριμένης θύρας αντί για τυχαία	Τυχαία
`--proxy <port>`	Προώθηση τοπικού διακομιστή ανάπτυξης (ενεργοποιεί τις προβολές Terminal/Preview)	-
`--session <name>`	Ονομασία της συνεδρίας tmux	Αυτόματη δημιουργία
`--kill-on-exit`	Εκκαθάριση συνεδριών tmux όταν τερματιστεί το Termbridge	Ανενεργό
`--no-qr`	Να μην εμφανίζεται ο κώδικας QR (χρήσιμο για σκριπτ)	Ανενεργό
`--no-tunnel`	Απενεργοποίηση της σήραγγας (απαιτεί `--public-url`)	Ανενεργό
`--public-url <url>`	Δημόσιο URL όταν η σήραγγα είναι απενεργοποιημένη	-
`--tunnel <provider>`	Πάροχος σήραγγας (`cloudflare` ή `none`)	cloudflare
`--tunnel-token <token>`	Χρήση διακριτικού ονομασμένης σήραγγας Cloudflare (απαιτεί `--port`)	-
`--tunnel-url <url>`	Δημόσιο URL για την ονομασμένη σήραγγα (απαιτείται με `--tunnel-token`)	-
`--backend <backend>`	Backend τερματικού (`tmux` ή `sandbox-daytona`)	tmux
`--sandbox-repo <url>`	Αποθετήριο URL για κλωνοποίηση στο sandbox Daytona	-
`--sandbox-branch <branch>`	Κλάδος για ανάκτηση στο sandbox	-
`--sandbox-path <path>`	Διαδρομή αποθετηρίου στο sandbox	Προκύπτει από το όνομα του αποθετηρίου
`--sandbox-name <name>`	Όνομα sandbox	Τυχαίο `termbridge-<hex>`
`--sandbox-preview-port <port>`	Θύρα προεπισκόπησης στο sandbox	-
`--sandbox-public`	Δημιουργία δημόσιου sandbox	Ανενεργό (ενεργό στην άμεση λειτουργία)
`--sandbox-direct`	Εκτέλεση του διακομιστή μέσα στο sandbox Daytona (χωρίς σήραγγα)	Ανενεργό
`--dev-proxy-url <url>`	Προώθηση κίνησης προεπισκόπησης σε αυτό το URL αντί για το `localhost:<proxy port>` (χρησιμοποιείται από τα σκριπτ ανάπτυξης)	-
`-h`, `--help`	Εκτύπωση κειμένου βοήθειας	-

Οποιαδήποτε άλλη επιλογή προκαλεί σφάλμα unknown option: <flag>. Δεν υπάρχει σημαία --version.

Μια σημαία υπερισχύει της αντίστοιχης μεταβλητής περιβάλλοντος, με μία εξαίρεση: το TERMBRIDGE_TUNNEL προς το παρόν υπερισχύει των --tunnel και --no-tunnel (#5).

Σημείωση Η ενσωματωμένη έξοδος termbridge --help εξακολουθεί να εμφανίζει τις σημαίες --daytona-* και --backend tmux | daytona. Αυτά τα ονόματα απορρίπτονται· χρησιμοποιήστε τις σημαίες --sandbox-* και --backend sandbox-daytona από τον παραπάνω πίνακα (#1).

Παραδείγματα

Σύνδεση σε υπάρχουσα συνεδρία tmux

Αν έχετε ήδη μια ενεργή συνεδρία tmux:

Κέλυφος

termbridge --session my-session

Σταθερή θύρα και προσαρμοσμένη συνεδρία

Κέλυφος

termbridge --port 8080 --session codex

Καθαρός τερματισμός (χωρίς συνεδρίες που απομένουν)

Κέλυφος

termbridge --kill-on-exit

Σκριπτ (χωρίς έξοδο QR)

Κέλυφος

termbridge --no-qr

Προώθηση διακομιστή ανάπτυξης Vite

Κέλυφος

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

# Then start Termbridge with proxy
termbridge --proxy 5173

Χρησιμοποιήστε το κουμπί Views για εναλλαγή μεταξύ Terminal και Preview. Η Preview φορτώνει την εφαρμογή σας μέσω του διακομιστή μεσολάβησης και υποστηρίζει HMR.

Ονομασμένη σήραγγα Cloudflare (με διακριτικό)

Αν έχετε λογαριασμό Cloudflare και θέλετε να αποφύγετε τα όρια ρυθμού του trycloudflare:

Κέλυφος

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

Απενεργοποίηση της σήραγγας (χρησιμοποιήστε το δικό σας δημόσιο URL)

Κέλυφος

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

Μεταβλητές περιβάλλοντος

Το Termbridge διαβάζει μεταβλητές περιβάλλοντος από το κέλυφος και από ένα αρχείο .env στον κατάλογο από τον οποίο το εκτελείτε. Οι μεταβλητές που έχουν ήδη οριστεί στο κέλυφος υπερισχύουν εκείνων του αρχείου .env.

Βασικές ρυθμίσεις

Μεταβλητή	Τι κάνει
`TERMBRIDGE_SESSIONS=2`	Δημιουργία πολλαπλών συνεδριών tmux κατά την εκκίνηση
`TERMBRIDGE_TMUX_CWD=/path`	Κατάλογος εργασίας για νέες συνεδρίες tmux
`TERMBRIDGE_PUBLIC_URL=https://example.com`	Δημόσιο URL όταν η σήραγγα είναι απενεργοποιημένη
`TERMBRIDGE_TUNNEL=none`	Απενεργοποίηση της σήραγγας
`TERMBRIDGE_TUNNEL_TOKEN=<token>`	Διακριτικό ονομασμένης σήραγγας (απαιτεί `TERMBRIDGE_TUNNEL_URL`)
`TERMBRIDGE_TUNNEL_URL=https://term.example.com`	Δημόσιο URL για την ονομασμένη σήραγγα

Για προχωρημένους

Η άμεση λειτουργία Daytona ορίζει αυτές τις μεταβλητές για τον διακομιστή που εκτελείται μέσα στο sandbox. Μπορείτε επίσης να τις ορίσετε μόνοι σας.

Μεταβλητή	Τι κάνει
`TERMBRIDGE_HOST=0.0.0.0`	Διεύθυνση στην οποία συνδέεται ο διακομιστής (προεπιλογή `127.0.0.1`). Η τοπική URL που εμφανίζεται είναι πάντα `127.0.0.1`.
`TERMBRIDGE_COOKIE_SAMESITE=lax`	Τιμή `SameSite` του cookie συνεδρίας: `lax`, `strict` ή `none` (προεπιλογή `Lax` ή `None` σε άμεση λειτουργία)
`TERMBRIDGE_SHARE_FILE=/path/share-url.txt`	Εγγραφή του συνδέσμου κοινής χρήσης URL και σε αυτό το αρχείο
`TERMBRIDGE_HIDE_TERMINAL_SWITCHER=1`	Απόκρυψη του επιλογέα τερματικών στο UI
`TERMBRIDGE_TMUX_PATH_PREFIX=/path/bin`	Προσθήκη αυτού πριν από το `PATH` σε κάθε συνεδρία tmux στην οποία ξεκινά ή συνδέεται το Termbridge (εισάγεται στη συνεδρία ως εντολή `export`)

Ανάπτυξη

Μεταβλητή	Τι κάνει
`TERMBRIDGE_INSECURE_COOKIE=1`	Να επιτρέπονται τα cookie HTTP (μόνο για τοπική ανάπτυξη)
`TERMBRIDGE_PROXY_PORT=5173`	Θύρα διακομιστή μεσολάβησης για το σενάριο dev:beam:proxy
`TERMBRIDGE_DEV_UI=http://127.0.0.1:5000`	Παράκαμψη της θύρας Vite ανάπτυξης UI URL
`TERMBRIDGE_DEV_PORT=3000`	Παράκαμψη της θύρας διακομιστή Termbridge κατά την ανάπτυξη (προεπιλογή `8787`)
`TERMBRIDGE_DEV_SESSION=codex`	Όνομα συνεδρίας tmux για το `dev:beam` (προεπιλογή `codex`)
`TERMBRIDGE_SKIP_BUILD=1`	Παράλειψη της δημιουργίας CLI στο `dev:beam`

Περιβάλλον απομόνωσης (Daytona)

Μεταβλητή	Τι κάνει
`TERMBRIDGE_BACKEND=sandbox-daytona`	Χρήση του backend sandbox Daytona
`TERMBRIDGE_SANDBOX_DIRECT=true`	Εκτέλεση του Termbridge μέσα στο sandbox
`TERMBRIDGE_SANDBOX_SERVER_PORT=8080`	Θύρα για τον διακομιστή στο sandbox
`TERMBRIDGE_SANDBOX_AGENTS=claude-code,codex`	Αυτόματη εγκατάσταση και συγχρονισμός ελέγχου ταυτότητας για agents
`TERMBRIDGE_SANDBOX_AGENT_ENV=...`	Πρόσθετες μεταβλητές περιβάλλοντος προς προώθηση
`TERMBRIDGE_SANDBOX_AGENT_AUTH_PATHS=...`	Τοπικά αρχεία ελέγχου ταυτότητας για συγχρονισμό

Για πλήρη διαμόρφωση του Daytona, δείτε τον οδηγό Daytona.

Διακοπή του Termbridge

Πατήστε Ctrl+C στο τερματικό όπου εκτελείται το Termbridge. Αυτό:

Κλείνει τη σήραγγα (αν είναι ενεργοποιημένη)
Διακόπτει τον τοπικό διακομιστή
Διατηρεί ενεργές τις συνεδρίες tmux (εκτός αν χρησιμοποιήσατε το --kill-on-exit)

Οι συνεδρίες tmux διατηρούνται από προεπιλογή, ώστε να μπορείτε να συνδεθείτε ξανά αργότερα.