termbridge 0.1.0
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/LICENSE +21 -0
- package/README.md +56 -0
- package/dist/bin.js +2819 -0
- package/dist/bin.js.map +1 -0
- package/package.json +79 -0
- package/ui/dist/assets/index-B5s06ZPI.css +1 -0
- package/ui/dist/assets/index-BH9gzDdw.js +103 -0
- package/ui/dist/index.html +13 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 inline0
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Termbridge
|
|
2
|
+
|
|
3
|
+
Local-first terminal beaming with tmux + Cloudflare tunnel and a mobile-friendly UI.
|
|
4
|
+
|
|
5
|
+
## Quick start
|
|
6
|
+
|
|
7
|
+
Prereqs:
|
|
8
|
+
- Node.js 18+
|
|
9
|
+
- tmux in PATH
|
|
10
|
+
- cloudflared in PATH
|
|
11
|
+
|
|
12
|
+
Run:
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npx termbridge
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Scan the QR code and open the URL on your phone. The CLI stays running while the tunnel is active.
|
|
19
|
+
|
|
20
|
+
## CLI usage
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
termbridge --port 7000 --session dev --kill-on-exit --no-qr --tunnel cloudflare
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Flags:
|
|
27
|
+
- `--port <port>`: fixed local port (default: random free port)
|
|
28
|
+
- `--session <name>`: tmux session name override
|
|
29
|
+
- `--kill-on-exit`: kill tmux sessions on exit
|
|
30
|
+
- `--no-qr`: disable QR output
|
|
31
|
+
- `--tunnel cloudflare`: tunnel provider (default)
|
|
32
|
+
|
|
33
|
+
## Environment variables
|
|
34
|
+
|
|
35
|
+
- `TERMBRIDGE_SESSIONS=2`: create multiple tmux sessions on start
|
|
36
|
+
- `TERMBRIDGE_INSECURE_COOKIE=1`: allow HTTP cookies for local dev
|
|
37
|
+
- `TERMBRIDGE_DEV_UI=http://127.0.0.1:5173`: override Vite dev UI URL
|
|
38
|
+
|
|
39
|
+
## Development
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
bun install
|
|
43
|
+
bun run dev:beam
|
|
44
|
+
bun run dev:beam:multi
|
|
45
|
+
bun run test
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Troubleshooting
|
|
49
|
+
|
|
50
|
+
- `tmux` not found: install `tmux` and ensure it is on your PATH.
|
|
51
|
+
- `cloudflared` not found: install Cloudflare's tunnel client and ensure it is on your PATH.
|
|
52
|
+
- `node-pty` issues: ensure the spawn-helper binary is executable (Termbridge attempts to fix this automatically).
|
|
53
|
+
|
|
54
|
+
## License
|
|
55
|
+
|
|
56
|
+
MIT
|