install.sh: Add our own flag parser

Fully supports long opts!

Author: nhooyr

.github/ISSUE_TEMPLATE/bug-report.md

@@ -1,10 +1,9 @@
 ---
 name: Bug report
 about: Report a bug and help us improve
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 <!--

.github/ISSUE_TEMPLATE/extension-request.md

@@ -1,10 +1,9 @@
 ---
 name: Extension request
 about: Request an extension missing from the code-server marketplace
-title: ''
+title: ""
 labels: extension-request
 assignees: cmoog
-
 ---
 
 <!--

.github/ISSUE_TEMPLATE/feature-request.md

@@ -1,10 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea
-title: ''
+title: ""
 labels: feature
-assignees: ''
-
+assignees: ""
 ---
 
 <!--

README.md

@@ -17,28 +17,54 @@ For a full setup and walkthrough, please see [./doc/guide.md](./doc/guide.md).
 
 ## Install
 
-You can easily and securely install code-server with our install script.
+You can easily and securely install code-server with our install script on any Linux or macOS machine.
 
 ```bash
 # First run to print out the install process.
-curl -sSL https://get.docker.com/ | sh  -s -- --dry-run
+curl -fsSL https://code-server.dev/install.sh | sh  -s -- --dry-run
 # Now it will actually install.
-curl -sSL https://get.docker.com/ | sh  -s --
+curl -fsSL https://code-server.dev/install.sh | sh
 ```
 
+```
+$ curl -fsSL https://code-server.dev/install.sh | sh  -s -- --dry-run --help
+
+Installs latest code-server on any macOS or Linux system preferring to use the OS package manager.
+
+  curl -fsSL https://code-server.dev/install.sh | sh -s --
+
 - For Debian, Ubuntu, Raspbian it will install the latest deb package.
 - For Fedora, CentOS, RHEL, openSUSE it will install the latest rpm package.
 - For Arch Linux it will install the AUR package.
-- For any unrecognized Linux operating system it will install the latest static release into `/usr/local/lib/code-server-X.X.X`.
+- For any unrecognized Linux operating system it will install the latest static release into ~/.local
+  - Add ~/.local/bin to your $PATH to run code-server.
+
 - For macOS it will install the Homebrew package.
-  - If Homebrew is not installed it will install the latest static release into `/usr/local/lib/code-server-X.X.X`.
+  - If Homebrew is not installed it will install the latest static release into ~/.local
+  - Add ~/.local/bin to your $PATH to run code-server.
+
+- If ran on an architecture with no binary releases or outdated libc/libcxx, it will install the
+  npm package with yarn or npm.
+  - We only have binary releases for amd64 and arm64 presently.
 
-If ran on an architecture with no binary releases, it will install the npm package with `yarn` or `npm`.
-We only have binary releases for `amd64` and `arm64` presently.
+    --dry-run Enables a dry run where where the steps that would have taken place
+              are printed but do not actually execute.
+
+    --static  Forces the installation of a static release into ~/.local
+
+              This flag takes an optional argument for the installation prefix which defaults to "~/.local".
+              code-server will be unarchived into ~/.local/lib/code-server.X.X.X and the binary will be symlinked
+              into "~/.local/bin/code-server". You will need to add ~/.local/bin to your $PATH to use it without
+              the full path.
+
+              To install system wide set the prefix to /usr/local.
+
+    --version Pass to install a specific version instead of the latest release.
+```
 
 If you still don't trust our install script, even with the above explaination and the dry run, we have
-docs in [./doc/install.md](./doc/install.md) that explain how to install `code-server` each of the above
-operating systems. The script runs the exact same commands.
+docs in [./doc/install.md](./doc/install.md) that explain how to install `code-server` on a variety of
+platforms. The script runs the exact same commands.
 
 ### Docker
 
@@ -53,6 +79,8 @@ docker run -it -p 127.0.0.1:8080:8080 \
   codercom/code-server:latest
 ```
 
+You should also check out
+
 ## FAQ
 
 See [./doc/FAQ.md](./doc/FAQ.md).

ci/dev/fmt.sh

@@ -23,6 +23,7 @@ main() {
 
   doctoc --title '# FAQ' doc/FAQ.md > /dev/null
   doctoc --title '# Setup Guide' doc/guide.md > /dev/null
+  doctoc --title '# Install' doc/install.md > /dev/null
 
   if [[ ${CI-} && $(git ls-files --other --modified --exclude-standard) ]]; then
     echo "Files need generation or are formatted incorrectly:"

doc/install.md

@@ -1,5 +1,17 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 # Install
 
+- [Debian, Ubuntu](#debian-ubuntu)
+- [Fedora, CentOS, RHEL, SUSE](#fedora-centos-rhel-suse)
+- [Arch Linux](#arch-linux)
+- [yarn, npm](#yarn-npm)
+- [macOS](#macos)
+- [Static Releases](#static-releases)
+- [Docker](#docker)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 This document demonstrates how to install `code-server` on
 various distros and operating systems.
 
@@ -20,7 +32,7 @@ systemctl --user enable --now code-server
 # Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
 ```
 
-## Fedora, CentOS, Red Hat, SUSE
+## Fedora, CentOS, RHEL, SUSE
 
 ```bash
 curl -fOL https://github.com/cdr/code-server/releases/download/v3.3.1/code-server-3.3.1-amd64.rpm
@@ -49,8 +61,11 @@ systemctl --user enable --now code-server
 
 ## yarn, npm
 
-We recommend installing with `yarn` or `npm` if we don't have a precompiled release for your machine's
-platform or architecture or your glibc < v2.19.
+We recommend installing with `yarn` or `npm` if:
+
+1. We don't have a precompiled release for your machine's platform or architecture.
+2. libc < v2.19
+3. libcxx < 3.4.20
 
 **note:** Installing via `yarn` or `npm` builds native modules on install and so requires C dependencies.
 See [./doc/npm.md](./doc/npm.md) for installing these dependencies.
@@ -81,15 +96,22 @@ They bundle the node binary and node_modules.
 2. Unpack the release.
 3. You can run code-server by executing `./bin/code-server`.
 
-Add the code-server `bin` directory to your `$PATH` to easily execute `code-server` without the full path every time.
+You can add the code-server `bin` directory to your `$PATH` or link to it from a
+directory in your `$PATH` to easily execute `code-server` without the full path every time.
 
 Here is an example script for installing and using a static `code-server` release on Linux:
 
 ```bash
+mkdir -p ~/.local/lib ~/.local/bin
 curl -fL https://github.com/cdr/code-server/releases/download/v3.3.1/code-server-3.3.1-linux-amd64.tar.gz \
-  | sudo tar -C /usr/local/lib -xz
-sudo mv /usr/local/lib/code-server-3.3.1-linux-amd64 /usr/local/lib/code-server-3.3.1
-PATH="/usr/local/lib/code-server-3.3.1/bin:$PATH"
+  | tar -C ~/.local/lib -xz
+mv ~/.local/lib/code-server-3.3.1-linux-amd64 ~/.local/lib/code-server-3.3.1
+ln -s ~/.local/lib/code-server-3.3.1/bin/code-server ~/.local/bin/code-server
+PATH="~/.local/bin:$PATH"
 code-server
 # Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
 ```
+
+## Docker
+
+Documented in [README.md](../README.md#docker).