Skip to content

Commit 7b3b988

Browse files
committed
install.sh: Update --help docs to reflect remote installation
1 parent 13ce1a6 commit 7b3b988

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

install.sh

+16-1
Original file line numberDiff line numberDiff line change
@@ -17,27 +17,40 @@ usage() {
1717
Installs code-server for Linux, macOS and FreeBSD.
1818
It tries to use the system package manager if possible.
1919
After successful installation it explains how to start using code-server.
20+
21+
Pass in user@host to install code-server on user@host over ssh and forward
22+
the code-server port in the foreground so that you can immediately access it!
23+
If you rerun the script, code-server will be updated only when required.
2024
${not_curl_usage-}
2125
Usage:
2226
23-
$arg0 [--dry-run] [--version X.X.X] [--method detect] [--prefix ~/.local] [user@host]
27+
$arg0 [--dry-run] [--version X.X.X] [--method detect] [--prefix ~/.local] [--start] [user@host]
2428
2529
--dry-run
2630
Echo the commands for the install process without running them.
31+
2732
--version X.X.X
2833
Install a specific version instead of the latest.
34+
2935
--method [detect | standalone]
3036
Choose the installation method. Defaults to detect.
3137
- detect detects the system package manager and tries to use it.
3238
Full reference on the process is further below.
3339
- standalone installs a standalone release archive into ~/.local
3440
Add ~/.local/bin to your \$PATH to use it.
41+
3542
--prefix <dir>
3643
Sets the prefix used by standalone release archives. Defaults to ~/.local
3744
The release is unarchived into ~/.local/lib/code-server-X.X.X
3845
and the binary symlinked into ~/.local/bin/code-server
3946
To install system wide pass ---prefix=/usr/local
4047
48+
--start
49+
Ensures code-server is running and prints the URL at which it can be accessed.
50+
Also will print code-server's password and when installing over ssh, will forward
51+
the code-server port so that it can be easily accessed locally.
52+
Will block on tailing code-server's logs.
53+
4154
- For Debian, Ubuntu and Raspbian it will install the latest deb package.
4255
- For Fedora, CentOS, RHEL and openSUSE it will install the latest rpm package.
4356
- For Arch Linux it will install the AUR package.
@@ -56,6 +69,8 @@ Usage:
5669
- The npm package builds the native modules on postinstall.
5770
5871
It will cache all downloaded assets into ~/.cache/code-server
72+
With ssh installation, assets will be transferred over via scp
73+
as needed instead of being downloaded directly on the ssh host.
5974
6075
More installation docs are at https://github.com/cdr/code-server/blob/master/doc/install.md
6176
EOF

0 commit comments

Comments
 (0)