termbridge 0.3.6 → 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 +24 -78
- package/dist/bin.js +774 -159
- package/dist/bin.js.map +1 -1
- package/package.json +1 -1
- package/ui/dist/assets/{index-Xxwcc0Iu.js → index-C9mBDOoL.js} +18 -18
- package/ui/dist/index.html +1 -1
package/README.md
CHANGED
|
@@ -1,100 +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.
|
|
13
|
+
Scan the QR code and you're connected!
|
|
24
14
|
|
|
25
|
-
##
|
|
15
|
+
## What It Does
|
|
26
16
|
|
|
27
|
-
|
|
28
|
-
termbridge --port 8080 --session dev --kill-on-exit --no-qr --tunnel cloudflare
|
|
29
|
-
```
|
|
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.
|
|
30
18
|
|
|
31
|
-
|
|
32
|
-
-
|
|
33
|
-
-
|
|
34
|
-
-
|
|
35
|
-
-
|
|
36
|
-
-
|
|
37
|
-
- `--public-url <url>`: public URL when no tunnel is used
|
|
38
|
-
- `--tunnel cloudflare`: tunnel provider (default)
|
|
39
|
-
- `--backend <tmux|daytona>`: terminal backend (defaults to tmux)
|
|
40
|
-
- `--daytona-direct`: run the server inside the Daytona sandbox (no tunnel)
|
|
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)
|
|
41
25
|
|
|
42
|
-
##
|
|
43
|
-
|
|
44
|
-
- `TERMBRIDGE_SESSIONS=2`: create multiple tmux sessions on start
|
|
45
|
-
- `TERMBRIDGE_INSECURE_COOKIE=1`: allow HTTP cookies for local dev
|
|
46
|
-
- `TERMBRIDGE_DEV_UI=http://127.0.0.1:5173`: override Vite dev UI URL
|
|
47
|
-
- `TERMBRIDGE_PUBLIC_URL=https://example.com`: public URL when tunnel disabled
|
|
48
|
-
- `TERMBRIDGE_TUNNEL=none`: disable the tunnel
|
|
49
|
-
|
|
50
|
-
### Daytona sandbox mode
|
|
26
|
+
## CLI Options
|
|
51
27
|
|
|
52
28
|
```bash
|
|
53
|
-
|
|
54
|
-
DAYTONA_API_KEY=your_key
|
|
55
|
-
DAYTONA_API_URL=https://app.daytona.io/api
|
|
56
|
-
TERMBRIDGE_DAYTONA_REPO=https://github.com/inline0/termbridge-test-app.git
|
|
57
|
-
TERMBRIDGE_DAYTONA_BRANCH=main
|
|
58
|
-
TERMBRIDGE_DAYTONA_PATH=termbridge-test-app
|
|
59
|
-
TERMBRIDGE_DAYTONA_NAME=termbridge-sandbox
|
|
60
|
-
TERMBRIDGE_DAYTONA_GIT_USERNAME=your_github_username
|
|
61
|
-
TERMBRIDGE_DAYTONA_GIT_TOKEN=your_github_token
|
|
62
|
-
TERMBRIDGE_DAYTONA_PUBLIC=true
|
|
63
|
-
TERMBRIDGE_DAYTONA_PREVIEW_PORT=5173
|
|
64
|
-
TERMBRIDGE_DAYTONA_DELETE_ON_EXIT=true
|
|
29
|
+
termbridge [options]
|
|
65
30
|
```
|
|
66
31
|
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
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` |
|
|
74
40
|
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
For short-lived sandboxes (tests, CI), use a dedicated prefix and enable cleanup:
|
|
78
|
-
|
|
79
|
-
```bash
|
|
80
|
-
TERMBRIDGE_DAYTONA_NAME=termbridge-test-$(date +%s)
|
|
81
|
-
TERMBRIDGE_DAYTONA_DELETE_ON_EXIT=true
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
## Development
|
|
85
|
-
|
|
86
|
-
```bash
|
|
87
|
-
bun install
|
|
88
|
-
bun run dev:beam
|
|
89
|
-
bun run dev:beam:multi
|
|
90
|
-
bun run test
|
|
91
|
-
```
|
|
92
|
-
|
|
93
|
-
## Troubleshooting
|
|
41
|
+
## Documentation
|
|
94
42
|
|
|
95
|
-
|
|
96
|
-
- `cloudflared` not found: install Cloudflare's tunnel client and ensure it is on your PATH.
|
|
97
|
-
- `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).
|
|
98
44
|
|
|
99
45
|
## License
|
|
100
46
|
|