Commit 6fb46b0
authored
feat(cli): add Remote Control for the web UI (#222)
## Related Issue
None — direct feature request.
## Problem
The web UI only reaches devices that can already talk to this machine:
localhost, or the LAN with `--host`. Off-network there is no way to pick
up a running session from a phone, and setting up a tunnel by hand is
not something most users will do.
## What changed
Remote Control: the CLI opens an outbound tunnel to a relay, and the
relay serves the local web UI to a remote device. Sessions keep running
on this machine — only the screen moves. This also gives a mobile client
a stable endpoint to talk to.
Entry points:
- `pythinker rc` (alias `remote`) — starts the server with Remote
Control on
- `pythinker web --rc` / `--remote-control` — same, on the existing
command
- `/remote-control` or `/rc` in the terminal UI — hands the current
session over
The terminal prints a QR code, the link, and the path of a PNG copy of
the QR for terminals that cannot render it inline.
**Transport.** Two WebSockets to the relay — a management channel and an
HTTP tunnel — plus one stream socket per browser WebSocket. HTTP
requests arrive base64-framed and capped at 10 MiB, are replayed against
the local server with hop-by-hop and credential headers stripped, and
HTML/JS/CSS responses get asset paths rewritten under the device prefix.
A liveness watchdog pings every 30s and reconnects after 300s of
silence, so a relay that dies without a close frame does not strand the
client.
**Auth.** No accounts. The device authenticates to the relay with the
existing persistent `server.token`. The link itself carries no
credential: the CLI adds the bearer to every request it replays against
the local server, so the token never leaves this machine — not into the
QR image on disk, not into the remote browser's URL bar.
**Guards.** Loopback bind only, `--dangerous-bypass-auth` refused, and
one instance per machine via a pid+nonce lock at
`<data-dir>/server/rc.json` — a second start reports the link the first
one is using.
Experimental and hidden from `--help` unless
`PYTHINKER_CODE_EXPERIMENTAL_REMOTE_CONTROL=1` (or
`PYTHINKER_CODE_EXPERIMENTAL_FLAG=1`).
**Relay.** No relay server is included in this change. Point Remote
Control at your own with `--relay-origin <url>` or
`PYTHINKER_CODE_REMOTE_CONTROL_RELAY`; the default is
`https://code-rc.pythinker.com`.
Supporting changes: `StartForegroundHooks` gained an `onShutdown` hook
and `onReady` became awaitable, so the tunnel closes with the server;
`supportsHyperlinks` was added next to `toTerminalHyperlink`.
## Checklist
- [x] I have read the
[CONTRIBUTING](https://github.com/PyModel/pythinker-code/blob/main/CONTRIBUTING.md)
document.
- [ ] I have linked a related issue (external PRs: the issue must have a
maintainer's `/approve`).
- [x] I have added tests that prove my feature works.
- [x] Ran `gen-changesets` skill, or this PR needs no changeset.
- [x] Ran `gen-docs` skill, or this PR needs no doc update.
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Added experimental Remote Control for accessing the local web
interface from phones or other computers.
* Start it with `pythinker rc` or `/remote-control` (also `/rc`);
connection links and QR codes appear in the terminal.
* Added configurable relay support, secure single-session handling,
token-free URLs, and improved connection reliability.
* Remote Control requires explicit experimental feature activation.
* **Documentation**
* Added a guide covering setup, authentication, relay configuration, and
shutdown.
* **Tests**
* Added comprehensive coverage for startup, connections, QR codes,
relays, authentication, and error handling.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->1 parent 882835e commit 6fb46b0
26 files changed
Lines changed: 3175 additions & 27 deletions
File tree
- .changeset
- apps/pythinker-code
- dist-web
- src
- cli/sub/web
- tui/commands
- utils
- test
- cli
- web
- tui/commands
- utils
- docs
- .vitepress
- guides
- packages/agent-core-v2/src
- app/remoteControl
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
| 2 | + | |
3 | 3 | | |
4 | 4 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
94 | 94 | | |
95 | 95 | | |
96 | 96 | | |
| 97 | + | |
97 | 98 | | |
| 99 | + | |
98 | 100 | | |
99 | 101 | | |
100 | 102 | | |
101 | 103 | | |
102 | 104 | | |
103 | 105 | | |
104 | 106 | | |
| 107 | + | |
105 | 108 | | |
106 | 109 | | |
107 | 110 | | |
| 111 | + | |
108 | 112 | | |
109 | 113 | | |
110 | 114 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
| 18 | + | |
18 | 19 | | |
19 | 20 | | |
20 | 21 | | |
| |||
23 | 24 | | |
24 | 25 | | |
25 | 26 | | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
26 | 36 | | |
27 | 37 | | |
Lines changed: 194 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
0 commit comments