peer-term 1.4.5 → 1.4.6
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 +28 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -37,10 +37,38 @@ peer-term --path . # starts in current directory
|
|
|
37
37
|
peer-term --readonly # view-only session
|
|
38
38
|
peer-term --secure # require fingerprint verification
|
|
39
39
|
peer-term --expiry 10m # custom expiry time
|
|
40
|
+
peer-term --rejoin 5m # custom reconnection window
|
|
40
41
|
peer-term --relay wss://custom # use a custom relay server
|
|
41
42
|
peer-term --verbose # enable debug logging
|
|
42
43
|
```
|
|
43
44
|
|
|
45
|
+
### CLI Highlights
|
|
46
|
+
|
|
47
|
+
| Flag | Description | Default |
|
|
48
|
+
| :--- | :--- | :--- |
|
|
49
|
+
| `--expiry <time>` | Session expiry duration (e.g. `5m`, `30s`, `1h`) | `5m` |
|
|
50
|
+
| `--rejoin <time>` | Reconnection window if connection drops (e.g. `2m`, `10m`) | `2m` |
|
|
51
|
+
| `--readonly` | Disable client keystrokes (view-only terminal mode) | Off |
|
|
52
|
+
| `--secure` | Enable fingerprint verification for MITM protection | Off |
|
|
53
|
+
| `--path <dir>` | Starting directory for the terminal session | `~` (Home) |
|
|
54
|
+
| `--relay <url>` | Custom relay server WebSocket URL(s) | `wss://relay.dhananjaybalekar.in` |
|
|
55
|
+
| `-V, --verbose` | Enable verbose debug logging | Off |
|
|
56
|
+
| `-h, --help` | Display usage information and exit | — |
|
|
57
|
+
| `-v, --version` | Output version number and exit | — |
|
|
58
|
+
|
|
59
|
+
### Interactive Controls
|
|
60
|
+
|
|
61
|
+
While running, you can manage sessions directly from the host CLI:
|
|
62
|
+
|
|
63
|
+
| Command | Description |
|
|
64
|
+
| :--- | :--- |
|
|
65
|
+
| `n` | Create a new session |
|
|
66
|
+
| `l` | List all active sessions |
|
|
67
|
+
| `a <code>` | Authorize verified fingerprint (in `--secure` mode) |
|
|
68
|
+
| `k <code>` | Kill a specific session |
|
|
69
|
+
| `q` | Quit all sessions and exit |
|
|
70
|
+
|
|
71
|
+
|
|
44
72
|
## Features
|
|
45
73
|
|
|
46
74
|
- **No Config**: Works instantly. No port forwarding or firewall configuration needed.
|