# CLI žinynas

## Pagrindinis naudojimas

Tiesiog paleiskite komandą – argumentų nereikia:

```bash
npx termbridge
```

Taip paleidžiama viskas: vietinis serveris, tmux sesija ir numatytasis Cloudflare tunelis.

Paleisti `termbridge` be subkomandos reiškia tą patį, kaip paleisti `termbridge start`.

Taip pat galite aiškiai paleisti `termbridge start` su visomis vėliavėlėmis:

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

## Vėliavėlės

| Vėliavėlė | Paskirtis | Numatytoji reikšmė |
|------|--------------|---------|
| `--port <port>` | Naudoti konkretų prievadą, o ne atsitiktinį | Atsitiktinis |
| `--proxy <port>` | Tarpinio serverio režimu naudoti vietinį kūrimo serverį (įjungiami Terminalo ir Peržiūros rodiniai) | - |
| `--session <name>` | Pavadinti savo tmux sesiją | Sukuriamas automatiškai |
| `--kill-on-exit` | Išjungus Termbridge išvalyti tmux sesijas | Išjungta |
| `--no-qr` | Nespausdinti QR kodo (naudinga scenarijams) | Išjungta |
| `--no-tunnel` | Išjungti tunelį (reikalinga `--public-url`) | Išjungta |
| `--public-url <url>` | Viešasis URL, kai tunelis išjungtas | - |
| `--tunnel <provider>` | Tunelio teikėjas (`cloudflare` arba `none`) | cloudflare |
| `--tunnel-token <token>` | Naudoti pavadinto Cloudflare tunelio žetoną (reikalinga `--port`) | - |
| `--tunnel-url <url>` | Pavadinto tunelio viešasis URL (reikalinga kartu su `--tunnel-token`) | - |
| `--backend <backend>` | Terminalo posistemė (`tmux` arba `sandbox-daytona`) | tmux |
| `--sandbox-repo <url>` | Saugyklos URL klonavimui į Daytona smėliadėžę | - |
| `--sandbox-branch <branch>` | Šaka, kurią reikia patikrinti smėliadėžėje | - |
| `--sandbox-path <path>` | Saugyklos kelias smėliadėžėje | Išvedamas iš saugyklos pavadinimo |
| `--sandbox-name <name>` | Smėliadėžės pavadinimas | Atsitiktinis `termbridge-<hex>` |
| `--sandbox-preview-port <port>` | Peržiūros prievadas smėliadėžėje | - |
| `--sandbox-public` | Sukurti viešą smėliadėžę | Išjungta (įjungta tiesioginiu režimu) |
| `--sandbox-direct` | Paleisti serverį Daytona smėliadėžėje (be tunelio) | Išjungta |
| `--dev-proxy-url <url>` | Peržiūros srautą persiųsti į šį URL, o ne į `localhost:<proxy port>` (naudoja kūrimo scenarijai) | - |
| `-h`, `--help` | Išspausdinti žinyno tekstą | - |

Bet kuri kita parinktis sukelia `unknown option: <flag>` klaidą. Vėliavėlės `--version` nėra.

Vėliavėlė turi pirmenybę prieš jos aplinkos kintamąjį, išskyrus vieną atvejį: `TERMBRIDGE_TUNNEL` šiuo metu turi pirmenybę prieš `--tunnel` ir `--no-tunnel` ([#5](https://github.com/inline0/termbridge/issues/5)).

> **Pastaba**
> Integruotame `termbridge --help` išvestyje vis dar pateikiamos `--daytona-*` vėliavėlės ir `--backend tmux | daytona`. Šie pavadinimai atmetami; naudokite pirmiau esančioje lentelėje nurodytas `--sandbox-*` vėliavėles ir `--backend sandbox-daytona` ([#1](https://github.com/inline0/termbridge/issues/1)).

## Pavyzdžiai

### Prisijungimas prie esamos tmux sesijos

Jei jau veikia tmux sesija:

```bash
termbridge --session my-session
```

### Fiksuotas prievadas ir tinkinta sesija

```bash
termbridge --port 8080 --session codex
```

### Tvarkingas išjungimas (nelieka sesijų)

```bash
termbridge --kill-on-exit
```

### Scenarijai (be QR išvesties)

```bash
termbridge --no-qr
```

### Tarpinis Vite kūrimo serveris

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

# Then start Termbridge with proxy
termbridge --proxy 5173
```

Mygtuku **Rodiniai** perjunkite terminalo ir peržiūros rodinius. Peržiūra įkelia jūsų programą per tarpinį serverį, palaikantį HMR.

### Pavadintas Cloudflare tunelis (pagal žetoną)

Jei turite Cloudflare paskyrą ir norite išvengti trycloudflare dažnio apribojimų:

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

### Išjungti tunelį (naudoti savo viešąjį URL)

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

## Aplinkos kintamieji

Termbridge nuskaito aplinkos kintamuosius iš apvalkalo ir `.env` failo kataloge, iš kurio jį paleidžiate. Apvalkale jau nustatyti kintamieji turi pirmenybę prieš kintamuosius iš `.env` failo.

### Pagrindiniai nustatymai

| Kintamasis | Paskirtis |
|----------|--------------|
| `TERMBRIDGE_SESSIONS=2` | Paleidžiant sukurti kelias tmux sesijas |
| `TERMBRIDGE_TMUX_CWD=/path` | Darbinis naujų tmux sesijų katalogas |
| `TERMBRIDGE_PUBLIC_URL=https://example.com` | Viešasis URL, kai tunelis išjungtas |
| `TERMBRIDGE_TUNNEL=none` | Išjungti tunelį |
| `TERMBRIDGE_TUNNEL_TOKEN=<token>` | Pavadinto tunelio žetonas (reikalinga `TERMBRIDGE_TUNNEL_URL`) |
| `TERMBRIDGE_TUNNEL_URL=https://term.example.com` | Pavadinto tunelio viešasis URL |

### Išplėstiniai nustatymai

Daytona tiesioginiu režimu nustato šias reikšmes smėliadėžėje paleidžiamam serveriui. Jas taip pat galite nustatyti patys.

| Kintamasis | Paskirtis |
|----------|--------------|
| `TERMBRIDGE_HOST=0.0.0.0` | Adresas, prie kurio prisijungia serveris (numatytasis `127.0.0.1`). Spausdinamame vietiniame URL visada rodoma `127.0.0.1`. |
| `TERMBRIDGE_COOKIE_SAMESITE=lax` | `SameSite` sesijos slapuko reikšmė: `lax`, `strict` arba `none` (numatytoji `Lax`, o tiesioginiu režimu – `None`) |
| `TERMBRIDGE_SHARE_FILE=/path/share-url.txt` | Taip pat įrašyti bendrinimo URL į šį failą |
| `TERMBRIDGE_HIDE_TERMINAL_SWITCHER=1` | Slėpti terminalų parinkiklį UI |
| `TERMBRIDGE_TMUX_PATH_PREFIX=/path/bin` | Kiekvienoje tmux sesijoje, kurią Termbridge paleidžia arba prie kurios prisijungia, pridėti šį tekstą `PATH` pradžioje (įvedama į sesiją kaip `export` komanda) |

### Kūrimas

| Kintamasis | Paskirtis |
|----------|--------------|
| `TERMBRIDGE_INSECURE_COOKIE=1` | Leisti HTTP slapukus (tik vietinėje kūrimo aplinkoje) |
| `TERMBRIDGE_PROXY_PORT=5173` | Tarpinio serverio prievadas dev:beam:proxy scenarijui |
| `TERMBRIDGE_DEV_UI=http://127.0.0.1:5000` | Pakeisti Vite kūrimo UI URL |
| `TERMBRIDGE_DEV_PORT=3000` | Pakeisti Termbridge serverio prievadą kūrimo aplinkoje (numatytasis `8787`) |
| `TERMBRIDGE_DEV_SESSION=codex` | tmux sesijos pavadinimas, skirtas `dev:beam` (numatytasis `codex`) |
| `TERMBRIDGE_SKIP_BUILD=1` | Praleisti CLI kūrimą `dev:beam` aplinkoje |

### Smėliadėžė (Daytona)

| Kintamasis | Paskirtis |
|----------|--------------|
| `TERMBRIDGE_BACKEND=sandbox-daytona` | Naudoti Daytona smėliadėžės posistemę |
| `TERMBRIDGE_SANDBOX_DIRECT=true` | Paleisti Termbridge smėliadėžėje |
| `TERMBRIDGE_SANDBOX_SERVER_PORT=8080` | Smėliadėžėje veikiančio serverio prievadas |
| `TERMBRIDGE_SANDBOX_AGENTS=claude-code,codex` | Automatiškai įdiegti ir sinchronizuoti agentų autentifikavimo duomenis |
| `TERMBRIDGE_SANDBOX_AGENT_ENV=...` | Papildomi persiunčiami aplinkos kintamieji |
| `TERMBRIDGE_SANDBOX_AGENT_AUTH_PATHS=...` | Sinchronizuojami vietiniai autentifikavimo failai |

Išsamią Daytona konfigūraciją rasite [Daytona vadove](https://termbridge.inline0.dev/lt/docs/sandboxes/daytona).

## Termbridge sustabdymas

Paspauskite `Ctrl+C` terminale, kuriame veikia Termbridge. Taip:

- Uždaro tunelį, jei jis įjungtas
- Sustabdo vietinį serverį
- Palieka tmux sesijas veikti (nebent naudojote `--kill-on-exit`)

Pagal numatytuosius nustatymus jūsų tmux sesijos išlieka, todėl vėliau galite prisijungti iš naujo.