ghostterm 1.0.0 → 1.0.1
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 +64 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# GhostTerm
|
|
2
|
+
|
|
3
|
+
A mobile terminal for Claude Code fans. Control your PC terminal from your phone — no VPN, no Tailscale, just works.
|
|
4
|
+
|
|
5
|
+
## Quick Start
|
|
6
|
+
|
|
7
|
+
### 1. On your PC
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx ghostterm
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
First time: a browser will open for Google sign-in. After that, it auto-connects.
|
|
14
|
+
|
|
15
|
+
### 2. On your phone
|
|
16
|
+
|
|
17
|
+
Open **[ghostterm.pages.dev](https://ghostterm.pages.dev)** and sign in with the same Google account. Your terminal connects automatically.
|
|
18
|
+
|
|
19
|
+
No Google account? Use the 6-digit pairing code shown in your terminal instead.
|
|
20
|
+
|
|
21
|
+
## Features
|
|
22
|
+
|
|
23
|
+
- Real CLI terminal (not a GUI wrapper)
|
|
24
|
+
- Up to 4 terminal sessions simultaneously
|
|
25
|
+
- Works on any phone browser — iOS & Android
|
|
26
|
+
- Auto-reconnect on disconnect
|
|
27
|
+
- Screenshot & file upload to PC
|
|
28
|
+
- Google account auto-pairing (no codes needed)
|
|
29
|
+
|
|
30
|
+
## Requirements
|
|
31
|
+
|
|
32
|
+
- **PC**: Node.js 18+ with build tools for native modules
|
|
33
|
+
- Windows: `npm install --global windows-build-tools`
|
|
34
|
+
- macOS: `xcode-select --install`
|
|
35
|
+
- Linux: `apt install build-essential`
|
|
36
|
+
- **Phone**: Any modern browser
|
|
37
|
+
|
|
38
|
+
## Environment Variables
|
|
39
|
+
|
|
40
|
+
| Variable | Default | Description |
|
|
41
|
+
|---|---|---|
|
|
42
|
+
| `GHOSTTERM_RELAY` | `wss://ghostterm-relay.fly.dev` | Custom relay server URL |
|
|
43
|
+
|
|
44
|
+
## How It Works
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
Phone (browser) ──WSS──▶ Relay (Fly.io) ◀──WSS── PC (ghostterm)
|
|
48
|
+
auto-pairs by
|
|
49
|
+
Google account
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Your phone and PC connect to a relay server. Terminal I/O is forwarded in real-time over encrypted WebSocket. No data is stored on the relay.
|
|
53
|
+
|
|
54
|
+
## Pro
|
|
55
|
+
|
|
56
|
+
Free: 1 hour/day. Upgrade for unlimited access.
|
|
57
|
+
|
|
58
|
+
## Disclaimer
|
|
59
|
+
|
|
60
|
+
GhostTerm is not affiliated with Anthropic. This is an independent fan project.
|
|
61
|
+
|
|
62
|
+
## License
|
|
63
|
+
|
|
64
|
+
MIT
|