coderemote 0.1.3 → 0.2.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 +21 -3
- package/dist/coderemote.js +1025 -88
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -16,6 +16,11 @@
|
|
|
16
16
|
<img src="https://img.shields.io/node/v/coderemote" alt="node version">
|
|
17
17
|
</p>
|
|
18
18
|
|
|
19
|
+
<p align="center">
|
|
20
|
+
<a href="https://coderemoteapp.github.io/web/"><b>Website</b></a> ·
|
|
21
|
+
<a href="https://coderemoteapp.github.io/web/docs/"><b>Docs</b></a>
|
|
22
|
+
</p>
|
|
23
|
+
|
|
19
24
|
---
|
|
20
25
|
|
|
21
26
|
`coderemote` is the computer side of **Code Remote**, an iOS app for remote development.
|
|
@@ -28,6 +33,8 @@ in your pocket:
|
|
|
28
33
|
- **Terminal:** a real shell (PTY) with a key bar for Ctrl, Tab, Esc and arrows; sessions
|
|
29
34
|
keep running when your phone sleeps and pick up where you left off, so `claude`, `vim`,
|
|
30
35
|
`htop` or a long build survive switching apps
|
|
36
|
+
- **VS Code in the browser (optional):** `coderemote up --web` also starts VS Code's own
|
|
37
|
+
tunnel and prints a vscode.dev link that opens the folder in the full editor
|
|
31
38
|
|
|
32
39
|
## Quick start
|
|
33
40
|
|
|
@@ -68,7 +75,13 @@ Remote shell access is serious, so access is locked down by default:
|
|
|
68
75
|
- **Encrypted.** All traffic is HTTPS / WSS (TLS 1.2+) to the relay.
|
|
69
76
|
|
|
70
77
|
`coderemote up --allow-anonymous` skips the account sign-in when you want the pairing token
|
|
71
|
-
alone.
|
|
78
|
+
alone.
|
|
79
|
+
|
|
80
|
+
`--web` runs `code tunnel`, which is VS Code's tunnel, not ours: it signs in with its own
|
|
81
|
+
GitHub account and gives the browser the whole machine, not just the shared folder. It stops
|
|
82
|
+
with `coderemote`, unless a `code tunnel` was already running.
|
|
83
|
+
|
|
84
|
+
Found a vulnerability? See the
|
|
72
85
|
[security policy](https://github.com/CodeRemoteApp/coderemote/blob/main/SECURITY.md).
|
|
73
86
|
|
|
74
87
|
## Commands
|
|
@@ -76,6 +89,7 @@ alone. Found a vulnerability? See the
|
|
|
76
89
|
```sh
|
|
77
90
|
coderemote up # share this folder through a dev tunnel, print the pairing QR
|
|
78
91
|
coderemote up --allow-anonymous # same, without the account sign-in (alias --no-auth)
|
|
92
|
+
coderemote up --web # also run `code tunnel`: open this folder in VS Code on vscode.dev
|
|
79
93
|
coderemote status # running agents and their terminal sessions
|
|
80
94
|
coderemote kill <id>... # end terminal sessions (an id prefix from `status` is enough)
|
|
81
95
|
coderemote kill --all # end every session
|
|
@@ -83,6 +97,7 @@ coderemote stop # stop the agent for this folder (--all: every
|
|
|
83
97
|
coderemote serve # share on 127.0.0.1 only, no tunnel (local testing)
|
|
84
98
|
coderemote rotate-token # revoke every paired device
|
|
85
99
|
coderemote login # sign in again (--microsoft, or --device-code without a browser)
|
|
100
|
+
coderemote update # install the latest version (`up` says when there's one)
|
|
86
101
|
coderemote help # all options
|
|
87
102
|
```
|
|
88
103
|
|
|
@@ -96,10 +111,13 @@ Options: `--root DIR` shares another folder; `--port N` picks the local port (de
|
|
|
96
111
|
- The **Dev Tunnels CLI** is downloaded on first run into `~/.coderemote/bin` (the macOS build
|
|
97
112
|
must carry Microsoft's code signature). A `devtunnel` already on your `PATH` is used instead,
|
|
98
113
|
or point `CODEREMOTE_DEVTUNNEL` at one.
|
|
114
|
+
- For `--web` only: **VS Code** with its `code` command on your `PATH` (in VS Code, run
|
|
115
|
+
*Shell Command: Install 'code' command in PATH*), or point `CODEREMOTE_CODE` at one. The first
|
|
116
|
+
run signs `code tunnel` in with GitHub.
|
|
99
117
|
- On Linux, `node-pty` compiles on install (`python3`, `make`, a C++ compiler:
|
|
100
118
|
`build-essential` on Debian/Ubuntu), and signing in needs `libsecret` (`libsecret-1-0`)
|
|
101
|
-
- The **Code Remote** iOS app on your iPhone (App Store release coming;
|
|
102
|
-
|
|
119
|
+
- The **Code Remote** iOS app on your iPhone (App Store release coming; see the
|
|
120
|
+
[website](https://coderemoteapp.github.io/web/))
|
|
103
121
|
|
|
104
122
|
## FAQ
|
|
105
123
|
|