termbridge 0.3.5 → 0.3.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -39
- package/dist/bin.js +1444 -76
- package/dist/bin.js.map +1 -1
- package/package.json +3 -1
- package/ui/dist/assets/{index-DxHbJ65v.js → index-C9mBDOoL.js} +22 -22
- package/ui/dist/assets/index-D_YqfdN5.css +1 -0
- package/ui/dist/index.html +2 -2
- package/ui/dist/assets/index-BjtQGpfN.css +0 -1
package/README.md
CHANGED
|
@@ -1,60 +1,46 @@
|
|
|
1
1
|
# Termbridge
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Access your terminal from anywhere — beam it to your phone with one command.
|
|
4
4
|
|
|
5
|
-
## Quick
|
|
5
|
+
## Quick Start
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
- Node.js 18+
|
|
9
|
-
- tmux in PATH
|
|
10
|
-
- cloudflared in PATH
|
|
11
|
-
|
|
12
|
-
Run:
|
|
7
|
+
**Prerequisites:** Node.js 18+, [tmux](https://github.com/tmux/tmux), [cloudflared](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/downloads/)
|
|
13
8
|
|
|
14
9
|
```bash
|
|
15
10
|
npx termbridge
|
|
16
11
|
```
|
|
17
12
|
|
|
18
|
-
Scan the QR code and
|
|
19
|
-
Use the action tray in the UI for quick navigation, including line + page scroll jumps.
|
|
20
|
-
|
|
21
|
-
## Documentation
|
|
22
|
-
|
|
23
|
-
Visit `https://termbridge.dev` for the full docs, architecture notes, and troubleshooting.
|
|
24
|
-
|
|
25
|
-
## CLI usage
|
|
13
|
+
Scan the QR code and you're connected!
|
|
26
14
|
|
|
27
|
-
|
|
28
|
-
termbridge --port 8080 --session dev --kill-on-exit --no-qr --tunnel cloudflare
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Flags:
|
|
32
|
-
- `--port <port>`: fixed local port (default: random free port)
|
|
33
|
-
- `--session <name>`: tmux session name override
|
|
34
|
-
- `--kill-on-exit`: kill tmux sessions on exit
|
|
35
|
-
- `--no-qr`: disable QR output
|
|
36
|
-
- `--tunnel cloudflare`: tunnel provider (default)
|
|
15
|
+
## What It Does
|
|
37
16
|
|
|
38
|
-
|
|
17
|
+
Termbridge runs a local server that connects to your terminal (via tmux), then creates a secure Cloudflare tunnel. Access your terminal from your phone or any browser.
|
|
39
18
|
|
|
40
|
-
|
|
41
|
-
-
|
|
42
|
-
-
|
|
19
|
+
**Features:**
|
|
20
|
+
- Mobile-first UI with quick actions
|
|
21
|
+
- Multi-terminal support (switch between tmux sessions)
|
|
22
|
+
- Proxy mode to preview your dev server alongside the terminal
|
|
23
|
+
- Optional Daytona sandbox support for cloud terminals
|
|
24
|
+
- Coding agent integration (Claude Code, Codex, OpenCode)
|
|
43
25
|
|
|
44
|
-
##
|
|
26
|
+
## CLI Options
|
|
45
27
|
|
|
46
28
|
```bash
|
|
47
|
-
|
|
48
|
-
bun run dev:beam
|
|
49
|
-
bun run dev:beam:multi
|
|
50
|
-
bun run test
|
|
29
|
+
termbridge [options]
|
|
51
30
|
```
|
|
52
31
|
|
|
53
|
-
|
|
32
|
+
| Option | Description |
|
|
33
|
+
|--------|-------------|
|
|
34
|
+
| `--port <port>` | Use a specific local port |
|
|
35
|
+
| `--proxy <port>` | Proxy a local dev server |
|
|
36
|
+
| `--session <name>` | Name for the tmux session |
|
|
37
|
+
| `--kill-on-exit` | Kill tmux sessions on exit |
|
|
38
|
+
| `--no-qr` | Don't show the QR code |
|
|
39
|
+
| `--backend <mode>` | `tmux` (default) or `sandbox-daytona` |
|
|
40
|
+
|
|
41
|
+
## Documentation
|
|
54
42
|
|
|
55
|
-
|
|
56
|
-
- `cloudflared` not found: install Cloudflare's tunnel client and ensure it is on your PATH.
|
|
57
|
-
- `node-pty` issues: ensure the spawn-helper binary is executable (Termbridge attempts to fix this automatically).
|
|
43
|
+
Full documentation, environment variables, and Daytona sandbox setup at [termbridge.dev](https://termbridge.dev) or see the [GitHub README](https://github.com/inline0/termbridge).
|
|
58
44
|
|
|
59
45
|
## License
|
|
60
46
|
|