coderemote 0.1.2 → 0.2.0

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="https://raw.githubusercontent.com/Tranthanh98/coderemote/main/apps/ios/Design/AppIcon/Icon-Default-1024x1024@1x.png" width="96" height="96" alt="Code Remote icon">
+  <img src="https://raw.githubusercontent.com/CodeRemoteApp/coderemote/main/docs/images/icon.png" width="96" height="96" alt="Code Remote icon">
 </p>
 
 <h1 align="center">coderemote</h1>
@@ -12,10 +12,15 @@
 
 <p align="center">
   <a href="https://www.npmjs.com/package/coderemote"><img src="https://img.shields.io/npm/v/coderemote" alt="npm version"></a>
-  <a href="https://github.com/Tranthanh98/coderemote/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/coderemote" alt="license: AGPL-3.0-or-later"></a>
+  <a href="https://github.com/CodeRemoteApp/coderemote/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/coderemote" alt="license: AGPL-3.0-or-later"></a>
   <img src="https://img.shields.io/node/v/coderemote" alt="node version">
 </p>
 
+<p align="center">
+  <a href="https://coderemoteapp.github.io/web/"><b>Website</b></a> ·
+  <a href="https://coderemoteapp.github.io/web/docs/"><b>Docs</b></a>
+</p>
+
 ---
 
 `coderemote` is the computer side of **Code Remote**, an iOS app for remote development.
@@ -28,6 +33,8 @@ in your pocket:
 - **Terminal:** a real shell (PTY) with a key bar for Ctrl, Tab, Esc and arrows; sessions
   keep running when your phone sleeps and pick up where you left off, so `claude`, `vim`,
   `htop` or a long build survive switching apps
+- **VS Code in the browser (optional):** `coderemote up --web` also starts VS Code's own
+  tunnel and prints a vscode.dev link that opens the folder in the full editor
 
 ## Quick start
 
@@ -45,7 +52,7 @@ opens your browser to sign in with GitHub. Prefer a Microsoft account? Run
 ## How it works
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/Tranthanh98/coderemote/main/docs/images/how-it-works.png" width="760" alt="How it works: the Code Remote app on the iPhone connects over HTTPS/WSS to the Microsoft Dev Tunnels relay; coderemote on your computer (127.0.0.1:31580) connects outbound to the same relay and serves files, git and terminals from the shared folder. Security at each hop: token in the iPhone Keychain, only your account through the relay, token check and one folder on the computer.">
+  <img src="https://raw.githubusercontent.com/CodeRemoteApp/coderemote/main/docs/images/how-it-works.png" width="760" alt="How it works: the Code Remote app on the iPhone connects over HTTPS/WSS to the Microsoft Dev Tunnels relay; coderemote on your computer (127.0.0.1:31580) connects outbound to the same relay and serves files, git and terminals from the shared folder. Security at each hop: token in the iPhone Keychain, only your account through the relay, token check and one folder on the computer.">
 </p>
 
 `coderemote` starts a small agent that listens on `127.0.0.1` only, and publishes it through
@@ -68,14 +75,21 @@ Remote shell access is serious, so access is locked down by default:
 - **Encrypted.** All traffic is HTTPS / WSS (TLS 1.2+) to the relay.
 
 `coderemote up --allow-anonymous` skips the account sign-in when you want the pairing token
-alone. Found a vulnerability? See the
-[security policy](https://github.com/Tranthanh98/coderemote/blob/main/SECURITY.md).
+alone.
+
+`--web` runs `code tunnel`, which is VS Code's tunnel, not ours: it signs in with its own
+GitHub account and gives the browser the whole machine, not just the shared folder. It stops
+with `coderemote`, unless a `code tunnel` was already running.
+
+Found a vulnerability? See the
+[security policy](https://github.com/CodeRemoteApp/coderemote/blob/main/SECURITY.md).
 
 ## Commands
 
 ```sh
 coderemote up                    # share this folder through a dev tunnel, print the pairing QR
 coderemote up --allow-anonymous  # same, without the account sign-in (alias --no-auth)
+coderemote up --web              # also run `code tunnel`: open this folder in VS Code on vscode.dev
 coderemote status                # running agents and their terminal sessions
 coderemote kill <id>...          # end terminal sessions (an id prefix from `status` is enough)
 coderemote kill --all            # end every session
@@ -96,10 +110,13 @@ Options: `--root DIR` shares another folder; `--port N` picks the local port (de
 - The **Dev Tunnels CLI** is downloaded on first run into `~/.coderemote/bin` (the macOS build
   must carry Microsoft's code signature). A `devtunnel` already on your `PATH` is used instead,
   or point `CODEREMOTE_DEVTUNNEL` at one.
+- For `--web` only: **VS Code** with its `code` command on your `PATH` (in VS Code, run
+  *Shell Command: Install 'code' command in PATH*), or point `CODEREMOTE_CODE` at one. The first
+  run signs `code tunnel` in with GitHub.
 - On Linux, `node-pty` compiles on install (`python3`, `make`, a C++ compiler:
   `build-essential` on Debian/Ubuntu), and signing in needs `libsecret` (`libsecret-1-0`)
-- The **Code Remote** iOS app on your iPhone (App Store release coming; meanwhile build it
-  from [source](https://github.com/Tranthanh98/coderemote#build-the-ios-app))
+- The **Code Remote** iOS app on your iPhone (App Store release coming; see the
+  [website](https://coderemoteapp.github.io/web/))
 
 ## FAQ
 
@@ -120,6 +137,6 @@ repository inside it.
 
 ## License
 
-[AGPL-3.0-or-later](https://github.com/Tranthanh98/coderemote/blob/main/LICENSE).
+[AGPL-3.0-or-later](https://github.com/CodeRemoteApp/coderemote/blob/main/LICENSE).
 "Code Remote" and its icon are trademarks of the project; see
-[TRADEMARKS.md](https://github.com/Tranthanh98/coderemote/blob/main/TRADEMARKS.md).
+[TRADEMARKS.md](https://github.com/CodeRemoteApp/coderemote/blob/main/TRADEMARKS.md).