README.md

   1 # @webinstall/packages
   2
   3 > WebInstall is how developers install their tools
   4
   5 ```bash
   6 curl https://webinstall.dev/webi | bash
   7 ```
   8
   9 This repository contains the primary and community-submitted packages for
  10 [webinstall.dev](https://webinstall.dev).
  11
  12 # Installer Guidelines
  13
  14 - Should install to `$HOME/.local/opt/<package>-<version>` or `$HOME/.local/bin`
  15 - Should not need `sudo` (except perhaps for a one-time `setcap`, etc)
  16 - Examples:
  17     - Full Packages:
  18         - Node.js: <https://github.com/webinstall/packages/tree/master/node>
  19         - Golang: <https://github.com/webinstall/packages/tree/master/golang>
  20         - PostgreSQL: <https://github.com/webinstall/packages/tree/master/postgres>
  21     - Single-Binary Installers:
  22         - Caddy: <https://github.com/webinstall/packages/tree/master/caddy>
  23         - Ripgrep: <https://github.com/webinstall/packages/tree/master/ripgrep>
  24         - Gitea: <https://github.com/webinstall/packages/tree/master/gitea>
  25     - Convenience Scripts:
  26         - Prettier: <https://github.com/webinstall/packages/tree/master/prettier>
  27         - Rust-lang: <https://github.com/webinstall/packages/tree/master/rustlang>
  28         - Rust-lang: <https://github.com/webinstall/packages/tree/master/vim-sensible>
  29
  30 # How it works
  31
  32 - Contacts official release APIs for download URLs
  33 - Selects the appropriate package version and archive format
  34 - Installs to `$HOME/.local/`
  35 - Updates `PATH` via `$HOME/.config/envman/PATH.env`
  36 - Symlinks or copies current selected version
  37
  38 More technically:
  39
  40 1. `<package>/releases.js` transforms the package's release API into a common formatt
  41     - (i.e. HTML, CSV, TAB, or JSON into a specific JSON format)
  42     - common release APIs are in `_common/` (i.e. `_common/github.js`)
  43 2. `_webi/bootstrap.sh` is a template that exchanges system information for a correct installer
  44     - contructs a user agent with os, cpu, and utility info (i.e. `macos`, `amd64`, can unpack `tar,zip,xz`)
  45 3. `_webi/template.sh` is the base installer template with common functions for
  46     - checking versions
  47     - downloading & unpacking
  48     - updating PATH
  49     - (re-)linking directories
  50 4. `<package>/install.sh` may provide functions to override `_webi/template.sh`
  51 5. Recap:
  52     - `curl https://webinstall.dev/<pkg>` => `bootstrap-<pkg>.sh`
  53     - `bash bootstrap-<pkg>.sh` => `https://webinstall.dev/api/installers/<pkg>@<ver>.sh?formats=zip,tar`
  54     - `bash install-<pkg>.sh` => download, unpack, move, link, update PATH
  55
  56 ## Creating an Installer
  57
  58 An install consists of 5 parts in 4 files:
  59
  60 ```
  61 my-new-package/
  62   - package.yash
  63   - releases.js
  64   - install.sh
  65   - install.bat
  66 ```
  67
  68 1. Create Description
  69 2. Fetch Releases
  70 3. Version Check (semi-optional)
  71 4. Update PATH
  72
  73 See these **examples**:
  74
  75 - https://github.com/webinstall/packages/blob/master/rg/
  76 - https://github.com/webinstall/packages/blob/master/golang/
  77
  78 The `webinstall.dev` server uses the list of releases returned by
  79 `<your-package>/releases.js` to generate a bash script with most necessary
  80 variables and functions pre-defined.
  81
  82 You just fill in the blanks.
  83
  84 ### TL;DR
  85
  86 Just create an empty directory and run the tests until you get a good result.
  87
  88 ```bash
  89 git clone git@github.com:webinstall/packages.git
  90 pushd packages
  91 ```
  92
  93 ```bash
  94 mkdir -p new-package
  95 npm install
  96 node _webi/test.js ./new-package/
  97 ```
  98
  99 ### 1. Create Description
 100
 101 Just copy the format from any of the existing packages. It's like this:
 102
 103 `package.yash`:
 104
 105 ````
 106 # title: Node.js
 107 # homepage: https://nodejs.org
 108 # tagline: JavaScript V8 runtime
 109 # description: |
 110 #   Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine
 111 # examples: |
 112 #   ```bash
 113 #   node -e 'console.log("Hello, World!")'
 114 #   > Hello, World!
 115 #   ```
 116
 117 END
 118 ````
 119
 120 This is a dumb format. We know. Historical accident (originally these were in
 121 bash comments).
 122
 123 It's in the TODOs to replace this with either YAML or Markdown.
 124
 125 ### 1. Fetch Releases
 126
 127 All you're doing in this step is just translating from one form of JSON or CSV
 128 or TAB or whatever, to a format understood by `webi`.
 129
 130 - Using Github releases? See `ripgrep/releases.js` (which uses
 131   `_common/github.js`)
 132 - Have a special format? See `golang/releases.js` or `node/releases.js`.
 133
 134 It looks like this:
 135
 136 `releases.js`:
 137
 138 ```js
 139 module.exports = function (request) {
 140   return github(request, owner, repo).then(function (all) {
 141     // if you need to do something special, you can do it here
 142     // ...
 143     return all;
 144   });
 145 };
 146 ```
 147
 148 ### 2. Bash Installer
 149
 150 1. Variables _you_ can set
 151 2. Functions _you_ must define
 152 3. Convenience / Helper Functions
 153
 154 (optional, if needed) Bash variables that you _may_ define:
 155
 156 ```bash
 157 # Define this if the package name is different from the command name (i.e. golang => go)
 158 pkg_cmd_name="foobar"
 159
 160 # These are used for symlinks, PATH, and test commands
 161 pkg_dst="$HOME/.local/opt/foobar"
 162 pkg_dst_bin="$HOME/.local/opt/foobar/bin"
 163 pkg_dst_cmd="$HOME/.local/opt/foobar/bin/foobar"
 164
 165 # These are the _real_ locations for the above
 166 pkg_src="$HOME/.local/opt/foobar-v$WEBI_VERSION"
 167 pkg_src_bin="$HOME/.local/opt/foobar-v$WEBI_VERSION/bin"
 168 pkg_src_cmd="$HOME/.local/opt/foobar-v$WEBI_VERSION/bin/foobar"
 169 ```
 170
 171 (required) A version check function that strips all non-version junk
 172
 173 ```bash
 174 pkg_get_current_version() {
 175     # foobar-v1.1.7 => 1.1.7
 176     echo "$(foobar --version | head -n 1 | sed 's:foobar-v::')"
 177 }
 178 ```
 179
 180 For the rest of the functions you can like copy/paste from the examples:
 181
 182 ```bash
 183 pkg_format_cmd_version() {}         # Override, pretty prints version
 184
 185 pkg_link                            # Override, replaces webi_link()
 186
 187 pkg_pre_install() {                 # Override, runs any webi_* commands
 188     webi_check                          # for $HOME/.local/opt tools
 189     webi_download                       # for things that have a releases.js
 190     webi_extract                        # for .xz, .tar.*, and .zip files
 191 }
 192
 193 pkg_install() {}                    # Override, usually just needs to rename extracted folder to
 194                                     # "$HOME/.local/opt/$pkg_cmd_name-v$WEBI_VERSION"
 195
 196 pkg_post_install() {                # Override
 197     webi_path_add "$pkg_dst_bin"        # should probably update PATH
 198 }
 199
 200 pkg_done_message() {}               # Override, pretty print a success message
 201 ```
 202
 203 ## Script API
 204
 205 See `webi/template.sh`
 206
 207 These variables will be set by the server:
 208
 209 ```
 210 WEBI_PKG=example@v1
 211 WEBI_NAME=example
 212 WEBI_TAG=v1
 213 WEBI_HOST=https://webinstall.dev
 214 WEBI_RELEASES=https://webinstall.dev/api/releases/example@v1?os=macos&arch=amd64&pretty=true
 215 WEBI_CSV=v1.0.2,
 216 WEBI_VERSION=1.0.2
 217 WEBI_MAJOR=1
 218 WEBI_MINOR=0
 219 WEBI_PATCH=2
 220 WEBI_LTS=
 221 WEBI_CHANNEL=stable
 222 WEBI_EXT=tar
 223 WEBI_PKG_URL=https://cdn.example.com/example-macos-amd64.tar.gz
 224 WEBI_PKG_FILE=example-macos-amd64.tar.gz
 225 ```
 226
 227 ```bash
 228 WEBI_TMP=${WEBI_TMP:-"$(mktemp -d -t webinstall-foobar.XXXXXXXX)"}
 229 WEBI_SINGLE=""
 230 ```
 231
 232 ```bash
 233 webi_check              # Checks to see if the selected version is already installed (and re-links if so)
 234 webi_download           # Downloads the selected release to $HOME/Downloads/<package-name>.tar.gz
 235 webi_extract            # Extracts the download to /tmp/<package-name>-<random>/
 236 webi_path_add /new/path # Adds /new/path to PATH for bash, zsh, and fish
 237 webi_pre_install        # Runs webi_check, webi_download, and webi_extract
 238 webi_install            # Moves extracted files from $WEBI_TMP to $pkg_src
 239 webi_link               # replaces any existing symlink with the currently selected version
 240 webi_post_install       # Runs `webi_add_path $pkg_dst_bin`
 241 ```
 242
 243 # Roadmap
 244
 245 - Wrap release APIs to unify and expose
 246 - [ ] Support arbitrary git urls (i.e. `@github.com/node/node`)
 247   - (maybe `ghi node/node` for github specifically)
 248 - [ ] Support git as an archive format